Spring Boot 3.2 RestClient 设置代理和认证：一份完整指南

用 Spring Boot 3.2 RestClient 设置代理和认证：一份全面的指南

导言

Spring Boot 3.2 引入了 RestClient，它为与 RESTful 服务交互提供了更简洁、更类型安全的方式。本文旨在帮助你轻松配置 RestClient 中的代理和认证，使你能够无缝访问受保护的 RESTful 端点。

设置代理

要使用 RestClient 设置代理，请使用 @RestClientBuilder 注解，如下所示：

@RestClientBuilder(baseUri = "http://example.com", configClass = MyRestClientConfig.class)
public interface MyRestClient {

    // REST 方法
}

在 MyRestClientConfig 类中，使用 @Bean 注解创建 ClientHttpRequestFactory，其中包含代理设置：

@Configuration
public class MyRestClientConfig {

    @Bean
    public ClientHttpRequestFactory requestFactory() {
        HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
        factory.setProxy(new HttpHost("proxy.example.com", 8080));
        return factory;
    }
}

设置认证

若要使用代理认证，请使用 ProxyAuthenticationInterceptor，如下所示：

public class MyProxyAuthenticationInterceptor implements ClientHttpRequestInterceptor {

    private final String username;
    private final String password;

    public MyProxyAuthenticationInterceptor(String username, String password) {
        this.username = username;
        this.password = password;
    }

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        request.getHeaders().add("Proxy-Authorization", "Basic " + Base64.getEncoder().encodeToString((username + ":" + password).getBytes()));
        return execution.execute(request, body);
    }
}

在 MyRestClientConfig 类中，使用 @Bean 注解注册该拦截器：

@Configuration
public class MyRestClientConfig {

    // 代理设置

    @Bean
    public ClientHttpRequestInterceptor proxyAuthenticationInterceptor() {
        return new MyProxyAuthenticationInterceptor("username", "password");
    }
}

完整示例

@RestClientBuilder(baseUri = "http://example.com", configClass = MyRestClientConfig.class)
public interface MyRestClient {

    // REST 方法

    @RequestMapping(method = RequestMethod.GET, value = "/api/v1/users")
    List<User> getUsers();
}

@Configuration
public class MyRestClientConfig {

    // 代理设置

    @Bean
    public ClientHttpRequestFactory requestFactory() {
        HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
        factory.setProxy(new HttpHost("proxy.example.com", 8080));
        return factory;
    }

    @Bean
    public ClientHttpRequestInterceptor proxyAuthenticationInterceptor() {
        return new MyProxyAuthenticationInterceptor("username", "password");
    }
}

代码演示

public class RestClientProxyDemo {

    public static void main(String[] args) {
        RestClientBuilder builder = RestClient.builder(MyRestClient.class);
        builder.configure(MyRestClientConfig.class);
        MyRestClient client = builder.build();

        List<User> users = client.getUsers();

        for (User user : users) {
            System.out.println(user);
        }
    }
}

结论

本文深入探讨了如何在 Spring Boot 3.2 RestClient 中设置代理和认证。通过提供详细的步骤和示例，你可以轻松配置你的 RestClient 以与受保护的 RESTful 服务安全交互。借助 RestClient 的灵活性，你还可以进行微调以满足你的特定需求。

常见问题解答

1. 代理和认证设置之间有什么区别？

   • 代理设置允许你将请求通过代理服务器路由，而认证设置允许你验证你的身份以访问受保护的资源。

2. 如何使用 SSL 连接设置代理？

   • 在 ClientHttpRequestFactory 的配置中，使用 setSslProtocol 和 setHostnameVerifier 方法。

3. 是否可以动态设置代理和认证？

   • 是的，可以通过实现 ClientHttpRequestFactory 或 ClientHttpRequestInterceptor 来自定义请求处理。

4. 如何处理代理或认证错误？

   • 使用 ClientHttpRequestInterceptor 捕获并处理请求错误。

5. 如何测试 RestClient 配置的代理和认证？

   • 使用测试框架（例如 JUnit）或使用 curl 工具进行端到端测试。