如何为AWS X-Ray配置RestTemplate（适配Spring Boot 3.1.0）

1. 添加兼容依赖 #

确保项目引入支持Spring Boot 3（基于Spring 6）的AWS X-Ray SDK版本，以Maven为例：

<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-sdk-spring</artifactId>
    <version>2.16.0</version> <!-- 选择支持Spring 6的最新稳定版 -->
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-xray-sdk-apache-httpclient</artifactId>
    <version>2.16.0</version>
</dependency>

2. 创建RestTemplate配置类 #

Spring Boot 3中需调整RestTemplate的构建逻辑，通过X-Ray提供的HttpClientBuilder创建带追踪能力的HTTP客户端，再注入到RestTemplate中：

基础写法 #

import com.amazonaws.xray.proxies.apache.http.HttpClientBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

@Configuration
public class XRayRestTemplateConfig {

    @Bean
    public RestTemplate xrayEnabledRestTemplate() {
        // 构建带X-Ray追踪的Apache HttpClient
        var xrayHttpClient = HttpClientBuilder.create().build();
        // 创建适配的请求工厂
        var requestFactory = new HttpComponentsClientHttpRequestFactory(xrayHttpClient);
        // 初始化绑定追踪能力的RestTemplate
        return new RestTemplate(requestFactory);
    }
}

基于RestTemplateBuilder的最佳实践写法 #

import com.amazonaws.xray.proxies.apache.http.HttpClientBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

@Configuration
public class XRayRestTemplateConfig {

    @Bean
    public RestTemplate xrayEnabledRestTemplate(RestTemplateBuilder builder) {
        var xrayHttpClient = HttpClientBuilder.create().build();
        var requestFactory = new HttpComponentsClientHttpRequestFactory(xrayHttpClient);
        return builder.requestFactory(() -> requestFactory).build();
    }
}

3. 关键注意事项 #

• 版本兼容问题：旧示例无法编译的核心原因是早期X-Ray SDK版本不支持Spring 6 API，必须升级到2.16.0及以上版本。
• 自定义客户端配置：如果需要调整连接超时、连接池大小等参数，可在HttpClientBuilder上添加对应配置：

  var xrayHttpClient = HttpClientBuilder.create()
          .setConnectionTimeout(5000)
          .setMaxConnTotal(20)
          .build();
  

• X-Ray Daemon运行：确保AWS X-Ray Daemon在本地或服务器正常运行，应用需配置正确的AWS区域（可通过环境变量AWS_REGION或AWS配置文件设置）。

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