如何在Java中使用com.linecorp.armeria.client.Endpoint.withIpAddr()方法

本文旨在为Java开发者提供关于com.linecorp.armeria.client.Endpoint.withIpAddr()方法的深入理解与实践指导。此方法允许用户通过指定的IP地址创建新的主机终结点，对于网络编程和微服务架构的应用尤为重要。以下内容将详细介绍该方法的功能、参数以及通过多个代码示例展示其具体应用。

方法概述

功能描述： 返回一个带有指定IP地址的新主机终结点。
包路径： com.linecorp.armeria.client.Endpoint
类名称： Endpoint
方法名： withIpAddr

方法签名

public Endpoint withIpAddr(@Nullable String ipAddr)

此方法接受一个可选的字符串参数ipAddr，表示要设置的IP地址。如果当前终结点已经具有相同的IP地址，则返回当前实例；如果终结点不是一个主机而是一个组，则会抛出IllegalStateException异常。

代码示例

示例1： 基本用法

Endpoint endpoint = Endpoint.of("example.com", 8080);
Endpoint newEndpoint = endpoint.withIpAddr("192.168.1.1");

说明： 本示例演示了如何通过指定的IP地址创建一个新的终结点实例。

示例2： 在构建器模式中使用

EndpointBuilder builder = new EndpointBuilder();
builder.add(endpoint.withIpAddr("192.168.1.1"));

说明： 本示例展示了如何在构建器模式中使用withIpAddr()方法来添加带有特定IP地址的终结点。

示例3： 解析InetSocketAddress并设置IP地址

private static Endpoint toResolvedHostEndpoint(InetSocketAddress addr) {
    return Endpoint.of(addr.getHostString(), addr.getPort())
            .withIpAddr(addr.getAddress().getHostAddress());
}

说明： 本示例展示了如何从InetSocketAddress对象解析主机信息，并使用withIpAddr()方法设置终结点的IP地址。

示例4： 单个未解析主机的构建测试

@Test
public void buildingWithSingleUnresolvedHost() throws Exception {
  final long id = AbstractArmeriaCentralDogmaBuilder.nextAnonymousGroupId.get();
  final String expectedGroupName = "centraldogma-anonymous-" + id;
  final ArmeriaCentralDogmaBuilder b = new ArmeriaCentralDogmaBuilder();
  b.healthCheckIntervalMillis(0);
  b.host("1.2.3.4.xip.io");
  assertThat(b.endpoint()).isEqualTo(Endpoint.ofGroup(expectedGroupName));
  // 验证是否注册了新的组
  assertThat(AbstractArmeriaCentralDogmaBuilder.nextAnonymousGroupId).hasValue(id + 1);
  final EndpointGroup group = EndpointGroupRegistry.get(expectedGroupName);
  assertThat(group).isNotNull();
  assertThat(group).isInstanceOf(DnsAddressEndpointGroup.class);
  assertThat(group.endpoints()).containsExactly(
      Endpoint.of("1.2.3.4.xip.io", 36462).withIpAddr("1.2.3.4"));
}

说明： 本示例通过单元测试验证了使用withIpAddr()方法构建单个未解析主机终结点的过程。

示例5： 使用配置文件构建终结点

@Test
public void buildingWithProfile() throws Exception {
  final String groupName = "centraldogma-profile-xip";
  try {
    final ArmeriaCentralDogmaBuilder b = new ArmeriaCentralDogmaBuilder();
    b.healthCheckIntervalMillis(0);
    b.profile("xip");
    final Endpoint endpoint = b.endpoint();
    assertThat(endpoint.isGroup()).isTrue();
    assertThat(endpoint.groupName()).isEqualTo(groupName);
    final EndpointGroup group = EndpointGroupRegistry.get(groupName);
    assertThat(group).isNotNull();
    assertThat(group).isInstanceOf(CompositeEndpointGroup.class);
    final CompositeEndpointGroup compositeGroup = (CompositeEndpointGroup) group;
    final List childGroups = compositeGroup.groups();
    assertThat(childGroups).hasSize(2);
    assertThat(childGroups.get(0)).isInstanceOf(DnsAddressEndpointGroup.class);
    assertThat(childGroups.get(1)).isInstanceOf(DnsAddressEndpointGroup.class);
    await().untilAsserted(() -> {
      final List endpoints = group.endpoints();
      assertThat(endpoints).isNotNull();
      assertThat(endpoints).containsExactlyInAnyOrder(
          Endpoint.of("1.2.3.4.xip.io", 36462).withIpAddr("1.2.3.4"),
          Endpoint.of("5.6.7.8.xip.io", 8080).withIpAddr("5.6.7.8"));
    });
  } finally {
    EndpointGroupRegistry.unregister(groupName);
  }
}

说明： 本示例展示了如何根据配置文件中的设置使用withIpAddr()方法构建复合终结点组。