RestTemplate用法-基本认证、JWT Token认证、自动重试、文件上传

RestTemplate用法-基本认证、JWT Token认证、自动重试、文件上传

一、基本认证

	/**
     * @param builder
     * @return
     * @see BasicAuthenticationInterceptor
     * @see {@code RestTemplateBuilder#addClientHttpRequestInitializer(org.springframework.web.client.RestTemplate) }
     */
    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder) {
        return builder.setConnectTimeout(Duration.ofSeconds(10))
                .setReadTimeout(Duration.ofSeconds(120))
                // 基本认证 密码保存在header里，"用户名:密码"拼接后，使用Base64加密
                // header value值示例"Basic YWtaW46YWRtaW4="
                .basicAuthentication("userName", "password")
                // 或者通过增加请求拦截器的方式实现（二选一）
                // .additionalInterceptors(new BasicAuthenticationInterceptor("userName", "password"))
                .build();
    }

二、JWT Token认证

	/**
     * @param builder
     * @return
     * @see BasicAuthenticationInterceptor
     */
    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder) {
        return builder.setConnectTimeout(Duration.ofSeconds(10))
                .setReadTimeout(Duration.ofSeconds(120))
                // JWT认证
                // header value值示例"Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImZ1bGxOYW1lIjoiU3VwZXIgQWRtaW4iLCJjcmVhdGVkQXQiOiIiLCJyb2xlIjpbImFkbWluIl0sImlhdCI6MTYzMDMwNzAzNywiZXhwIjoxNjMwMzQzMDM3fQ.AQA6RZN_zoFIMMdw0K0lF0Q7xpy6JlygbyMK3nOe5B4"
                .additionalInterceptors((request, body, execution) -> {
                    HttpHeaders headers = request.getHeaders();
                    if (!headers.containsKey(HttpHeaders.AUTHORIZATION)) {
                        // TODO 获取accessToken
                        final String accessToken = "accessToken";
                        headers.setBearerAuth(accessToken);
                    }
                    ClientHttpResponse clientHttpResponse = execution.execute(request, body);
                    return clientHttpResponse;
                })
                .build();
    }

三、请求自动重试

1.pom.xml

        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
            <version>1.3.1</version>
        </dependency>

2.重试代码实现

    /**
     * 结合RetryTemplate重试框架（编程式方式）
     * RetryTemplate重试框声明式注解方式：依赖{@code spring-boot-starter-aop }且重试类必须注入为spring bean
     * @param builder
     * @return
     */
    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder) {
        return builder.setConnectTimeout(Duration.ofSeconds(10))
                .setReadTimeout(Duration.ofSeconds(120))
                .additionalInterceptors((request, body, execution) -> {
                    // RetryTemplate 1.3之后支持链式写法
                    RetryTemplate retryTemplate = RetryTemplate.builder()
                            .maxAttempts(10)
                            .exponentialBackoff(100, 2, 10000)
                            .retryOn(RestClientException.class)
                            .build();
                    return retryTemplate.execute(context -> execution.execute(request, body));
                })
                .build();
    }

四、文件上传

1. 媒体类型 MediaType.APPLICATION_OCTET_STREAM

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
try (InputStream in = file.getInputStream()) {
    HttpEntity<?> requestEntity = new HttpEntity<>(new InputStreamResource(in), headers);
    final String result = restTemplate.postForObject(uri, requestEntity, String.class);
}

2. 媒体类型 MediaType.MULTIPART_FORM_DATA

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.MULTIPART_FORM_DATA);
try (InputStream in = file.getInputStream()) {
    MultiValueMap<String, Object> requestBody = new LinkedMultiValueMap<>();
    requestBody.add("file", new InputStreamResource(in));
    HttpEntity<?> requestEntity = new HttpEntity<>(requestBody, headers);
    final String result = restTemplate.postForObject(uri, requestEntity, String.class);
}

参考:
精讲RestTemplate第9篇-如何通过HTTP Basic Auth认证

Spring Retry重试框架