Apache HttpClient5：如何为每个请求设置LocalAddress？

问题背景 #

我正在将Apache HttpClient从4.5版本迁移到5.3版本，原应用会动态从一组本地IP中选一个绑定到请求上，4.5的实现代码如下：

HttpGet request = new HttpGet(url);
request.setRequestConfig(RequestConfig.custom()
    .setLocalAddress(someLocalInetAddress)
    .build());

但在HttpClient 5.x中setLocalAddress()方法已被移除，需要找到新的方式为单个请求指定本地IP。

我试过在ConnectionManager层面配置ConnectionSocketFactory，但这种方式需要提前明确每个IP的使用场景，不符合我的需求——我有独立逻辑确定要使用的IP，只需要在请求级别动态设置。

临时方案的问题：
我尝试过通过自定义HttpContext传递修改后的HttpRoute：

// 创建新的HttpRoute并设置本地地址
final HttpContext context = HttpClientContext.create();
context.setAttribute(HTTP_ROUTE, httpRoute);

client.execute(request, context, handler);

但这种方式会覆盖整个HttpRoute，而不是仅修改本地地址，不够灵活。

正确解决方案 #

方法1：自定义RoutePlanner动态修改本地地址 #

实现自定义的RoutePlanner，在规划路由时注入动态选择的本地IP，基于原路由仅修改本地地址部分，无需覆盖整个路由：

class DynamicLocalAddressRoutePlanner extends DefaultRoutePlanner {
    private final Supplier<InetAddress> localAddressSupplier;

    public DynamicLocalAddressRoutePlanner(SchemePortResolver schemePortResolver,
                                           Supplier<InetAddress> localAddressSupplier) {
        super(schemePortResolver);
        this.localAddressSupplier = localAddressSupplier;
    }

    @Override
    public HttpRoute determineRoute(HttpHost target, HttpRequest request, HttpContext context) throws HttpException {
        HttpRoute route = super.determineRoute(target, request, context);
        InetAddress localAddress = localAddressSupplier.get();
        if (localAddress != null) {
            // 基于原路由创建新路由，仅替换本地地址
            return new HttpRoute(route.getTargetHost(),
                    localAddress,
                    route.getProxyHost(),
                    route.isSecure(),
                    route.getTunnelType(),
                    route.getLayerType());
        }
        return route;
    }
}

构建HttpClient时使用该RoutePlanner：

Supplier<InetAddress> localAddressSupplier = () -> {
    // 此处放入你的动态IP选择逻辑
    return someLocalInetAddress;
};

CloseableHttpClient client = HttpClients.custom()
        .setRoutePlanner(new DynamicLocalAddressRoutePlanner(DefaultSchemePortResolver.INSTANCE, localAddressSupplier))
        .build();

方法2：为单个请求单独指定本地IP #

如果需要为每个请求设置不同的IP，可以先在请求的配置属性中传递目标IP，再在自定义RoutePlanner中读取并应用：

// 发送请求时设置本地IP属性
HttpGet request = new HttpGet(url);
request.setConfig(RequestConfig.custom()
        .setAttribute("LOCAL_ADDRESS", someLocalInetAddress)
        .build());

// 自定义RoutePlanner
class PerRequestLocalAddressRoutePlanner extends DefaultRoutePlanner {
    public PerRequestLocalAddressRoutePlanner(SchemePortResolver schemePortResolver) {
        super(schemePortResolver);
    }

    @Override
    public HttpRoute determineRoute(HttpHost target, HttpRequest request, HttpContext context) throws HttpException {
        HttpRoute route = super.determineRoute(target, request, context);
        RequestConfig config = RequestConfig.get(request);
        InetAddress localAddress = (InetAddress) config.getAttribute("LOCAL_ADDRESS");
        if (localAddress != null) {
            return new HttpRoute(route.getTargetHost(),
                    localAddress,
                    route.getProxyHost(),
                    route.isSecure(),
                    route.getTunnelType(),
                    route.getLayerType());
        }
        return route;
    }
}

这种方式完全适配每个请求独立动态选择IP的需求，且不会破坏原有路由的其他配置。

内容的提问来源于stack exchange，提问作者Petar Petrov