如何在MicroProfile REST Client中动态添加HTTP请求头？

当然有办法实现动态添加HTTP请求头的需求！MicroProfile REST Client提供了几种灵活的方式，不用局限于硬编码的注解。下面给你两种常用的方案：

方法一：使用ClientHeadersFactory（推荐，客户端全局级别） #

这个方案适合需要给整个REST Client实例的所有请求统一添加动态头的场景，比如全局认证头、请求追踪头等。

1. 实现ClientHeadersFactory接口，用于动态生成请求头：

import org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory;
import javax.ws.rs.core.MultivaluedHashMap;
import javax.ws.rs.core.MultivaluedMap;
import java.util.Map;

public class DynamicHeadersFactory implements ClientHeadersFactory {
    private final Map<String, String> customHeaders;

    // 通过构造函数传入需要动态添加的请求头
    public DynamicHeadersFactory(Map<String, String> customHeaders) {
        this.customHeaders = customHeaders;
    }

    @Override
    public MultivaluedMap<String, String> update(
            MultivaluedMap<String, String> incomingHeaders,
            MultivaluedMap<String, String> clientOutgoingHeaders) {
        
        // 基于原有请求头（如果有的话）构建新的头集合
        MultivaluedMap<String, String> newHeaders = new MultivaluedHashMap<>(clientOutgoingHeaders);
        // 批量添加动态请求头
        customHeaders.forEach(newHeaders::add);
        return newHeaders;
    }
}

2. 在构建REST Client时注册这个工厂：
   修改你的客户端初始化代码，传入动态头并绑定工厂：

GenericRestClient genericRestClient = null;
Map<String, Object> appConfig = context.appConfigs();
String baseUrl = (String) appConfig.get("restClient.baseUrl");
path = (String) appConfig.get("restClient.path");

// 这里模拟从配置或上下文获取的动态请求头
Map<String, String> dynamicHeaders = new HashMap<>();
dynamicHeaders.put("X-Custom-Trace-Id", UUID.randomUUID().toString());
dynamicHeaders.put("X-App-Version", "v1.0.0");

try {
    genericRestClient = RestClientBuilder.newBuilder()
            .baseUri(new URI(baseUrl))
            // 注册自定义的请求头工厂
            .register(new DynamicHeadersFactory(dynamicHeaders))
            .build(GenericRestClient.class);
} catch(URISyntaxException e){
    logger.error("",e);
    throw e;
}

3. 简化你的GenericRestClient接口，不需要额外的头参数：

@RegisterRestClient
public interface GenericRestClient {
    @POST
    @Path("{path}")
    @Produces("application/json")
    @Consumes("application/json")
    Response sendMessage(@PathParam("path") String pathParam, String jsonBody);
}

方法二：方法参数级别的动态头（单次请求专属） #

如果每个请求需要的动态头都不一样，可以直接在接口方法中传入请求头集合，实现单次请求的灵活配置。

修改GenericRestClient接口：

@RegisterRestClient
public interface GenericRestClient {
    @POST
    @Path("{path}")
    @Produces("application/json")
    @Consumes("application/json")
    Response sendMessage(
            // 空字符串的@HeaderParam会把Map中所有键值对作为请求头添加
            @HeaderParam("") MultivaluedMap<String, String> customHeaders,
            @PathParam("path") String pathParam,
            String jsonBody);
}

调用时传入专属的动态头：

MultivaluedMap<String, String> requestSpecificHeaders = new MultivaluedHashMap<>();
requestSpecificHeaders.add("X-Request-Id", "REQ-2024-001");
requestSpecificHeaders.add("X-User-Permission", "write");

Response response = genericRestClient.sendMessage(requestSpecificHeaders, path, value);

补充说明 #

• ClientHeadersFactory的优势是可以统一管控所有请求的头，还能在update方法中根据上下文（比如当前登录用户、请求参数）动态生成头，扩展性更强。
• 方法参数方式更适合单次请求的特殊头需求，灵活性拉满。
• 两种方式可以结合使用：ClientHeadersFactory的update方法能拿到来自方法参数的incomingHeaders，可以做合并、覆盖等逻辑处理。

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