Spring Boot(13)——使用RestTemplate

简介: 使用RestTemplateRestTemplate是Spring Web模块提供的作为客户端按照Rest规范进行Http请求的工具。Spring Boot也提供了对它的自动配置,Spring Boot不是直接的配置好RestTemplate对象,而是由org.

使用RestTemplate

RestTemplate是Spring Web模块提供的作为客户端按照Rest规范进行Http请求的工具。Spring Boot也提供了对它的自动配置,Spring Boot不是直接的配置好RestTemplate对象,而是由org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration配置类自动配置一个org.springframework.boot.web.client.RestTemplateBuilder对象,需要使用RestTemplate时可以注入RestTemplateBuilder对象,通过其build方法可以构建一个RestTemplate对象。比如下面的代码中SomeService会被扫描为一个Spring bean,其构造函数需要一个RestTemplateBuilder对象,Spring将自动为其注入该对象,在构造函数中通过注入的RestTemplateBuilder对象创建了一个RestTemplate对象,并把它保存起来,之后就可以在其它地方使用了,比如getSomething()

@Component
public class SomeService {

    private final RestTemplate restTemplate;
    
    public SomeService(RestTemplateBuilder restTemplateBuilder) {
        this.restTemplate = restTemplateBuilder.build();
    }
    
    public String getSomething() {
        String content = this.restTemplate.getForObject("https://www.baidu.com", String.class);
        return content;
    }
    
}

关于RestTemplate的用法可以参考http://elim.iteye.com/blog/2427553

自定义配置

RestTemplateBuilder对象还提供了一系列的配置方法,可以方便的进行一些自定义,每个方法的调用都会返回一个全新的RestTemplateBuilder对象。所以在使用的时候可以放心的进行使用,而不必担心会影响到其它使用的地方。

配置HttpMessageConverter

可以通过messageConverters()指定需要应用的HttpMessageConverter。

restTemplateBuilder.messageConverters(new StringHttpMessageConverter(Charset.forName("UTF-8")));
this.restTemplate = restTemplateBuilder.build();

上面的方式会是覆盖式的,可以应用additionalMessageConverters方法进行追加。

restTemplateBuilder.additionalMessageConverters(new StringHttpMessageConverter(Charset.forName("UTF-8")));
this.restTemplate = restTemplateBuilder.build();

另外,如果没有定义自己的org.springframework.boot.autoconfigure.http.HttpMessageConverters bean,Spring Boot默认会在创建RestTemplateBuilder时应用bean容器中能发现的所有HttpMessageConverter类型的bean。所以如果我们有一个自定义的HttpMessageConverter需要应用到RestTemplate,只需要把它定义为Spring bean即可。

配置拦截器

RestTemplate其实还可以了一个ClientHttpRequestInterceptor接口,可以在发起请求前后对请求内容或响应内容进行拦截处理。可以实现自己的ClientHttpRequestInterceptor,然后通过interceptors()进行应用。

restTemplateBuilder.interceptors(new TestInterceptor());
this.restTemplate = restTemplateBuilder.build();

上面的方式也是覆盖式的,可以通过additionalInterceptors()进行追加。

restTemplateBuilder.additionalInterceptors(new TestInterceptor());
this.restTemplate = restTemplateBuilder.build();

Spring已经提供了一个用来进行Http Basic认证的拦截器,叫BasicAuthorizationInterceptor,它可以在每次请求的时候附加上需要用来认证的用户名和密码。

restTemplateBuilder.interceptors(new BasicAuthorizationInterceptor("username", "password"));
this.restTemplate = restTemplateBuilder.build();

RestTemplateBuilder中提供了配置BasicAuthorizationInterceptor的简化方式,它开放了一个basicAuthorization()

restTemplateBuilder.basicAuthorization("username", "password");
this.restTemplate = restTemplateBuilder.build();

配置超时时间

可以通过setConnectTimeout()指定建立连接超时时间,通过setReadTimeout()指定获取响应结果的超时时间,单位都是毫秒。

restTemplateBuilder.setConnectTimeout(10 * 1000).setReadTimeout(20 * 1000);
this.restTemplate = restTemplateBuilder.build();

更多配置信息可以参考RestTemplateBuilder的API文档。

ClientHttpRequestFactory

在非Spring Boot环境下使用RestTemplate时,默认的ClientHttpRequestFactory是基于JDK实现的SimpleClientHttpRequestFactory。Spring Boot中RestTemplateBuilder默认会检测Classpath路径下的ClientHttpRequestFactory实现,如果拥有Apache HttpComponents的org.apache.http.client.HttpClient类则会使用org.springframework.http.client.HttpComponentsClientHttpRequestFactory,拥有okhttp3.OkHttpClient则会使用org.springframework.http.client.OkHttp3ClientHttpRequestFactory。如果都没有则会使用基于JDK实现的SimpleClientHttpRequestFactory。可以通过detectRequestFactory(false)关闭这种默认检测的机制。

restTemplateBuilder.detectRequestFactory(false);

可以通过requestFactory()强制指定使用某个实现,下面的代码就配置了将强制使用一个进行了自定义的HttpComponentsClientHttpRequestFactory对象。它拥有一个重载的可以指定ClientHttpRequestFactory实现类的方法,使用该方法将采用指定实现类的默认配置。

RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(10*1000).setConnectionRequestTimeout(30*1000).build();
HttpClient httpClient = HttpClientBuilder.create().setMaxConnPerRoute(20).setMaxConnTotal(50).setDefaultRequestConfig(requestConfig).build();
HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
restTemplateBuilder.requestFactory(() -> requestFactory);

通用的自定义配置

上面介绍的自定义配置都是基于某个RestTemplateBuilder进行的,一个应用中如果有多个地方需要使用RestTemplateBuilder构建RestTemplate时,如果某些自定义配置是通用的,每个地方都写一遍会比较麻烦。Spring Boot提供了一个RestTemplateBuilder接口,通过它可以对创建好的RestTemplate进行一些自定义配置。

@FunctionalInterface
public interface RestTemplateCustomizer {

    /**
     * Callback to customize a {@link RestTemplate} instance.
     * @param restTemplate the template to customize
     */
    void customize(RestTemplate restTemplate);

}

Spring Boot在创建RestTemplateBuilder时,默认会把bean容器中定义的RestTemplateCustomizer都应用到RestTemplateBuilder中,也就是说如果需要对RestTemplate进行自定义,可以把自定义的RestTemplateCustomizer实现类定义为一个Spring bean。

(注:本文是基于Spring Boot 2.0.3所写)

目录
相关文章
|
5月前
|
Java 测试技术 API
在 Spring 中 Mock RestTemplate
本文介绍了两种在单元测试中 mock RestTemplate 调用的方法,避免真实 HTTP API 调用以提高测试可控性。一是使用 Mockito 模拟库,通过 @Mock 和 when/then 方法定义模拟行为;二是借助 Spring Test 提供的 MockRestServiceServer,创建模拟服务器定义请求响应交互。文中结合具体代码示例展示了两种方法的实现细节,并强调了 RestTemplate 实例的一致性配置。适用于需要模拟外部 HTTP 调用的集成测试场景。
|
8月前
|
XML Java 应用服务中间件
Spring Boot 两种部署到服务器的方式
本文介绍了Spring Boot项目的两种部署方式:jar包和war包。Jar包方式使用内置Tomcat,只需配置JDK 1.8及以上环境,通过`nohup java -jar`命令后台运行,并开放服务器端口即可访问。War包则需将项目打包后放入外部Tomcat的webapps目录,修改启动类继承`SpringBootServletInitializer`并调整pom.xml中的打包类型为war,最后启动Tomcat访问应用。两者各有优劣,jar包更简单便捷,而war包适合传统部署场景。需要注意的是,war包部署时,内置Tomcat的端口配置不会生效。
2160 17
Spring Boot 两种部署到服务器的方式
|
6月前
|
Java 数据库 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
231 0
|
11月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
341 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
10月前
|
存储 运维 安全
Spring运维之boot项目多环境(yaml 多文件 proerties)及分组管理与开发控制
通过以上措施,可以保证Spring Boot项目的配置管理在专业水准上,并且易于维护和管理,符合搜索引擎收录标准。
538 2
|
11月前
|
缓存 NoSQL Java
Springboot自定义注解+aop实现redis自动清除缓存功能
通过上述步骤,我们不仅实现了一个高度灵活的缓存管理机制,还保证了代码的整洁与可维护性。自定义注解与AOP的结合,让缓存清除逻辑与业务逻辑分离,便于未来的扩展和修改。这种设计模式非常适合需要频繁更新缓存的应用场景,大大提高了开发效率和系统的响应速度。
331 2
|
Java Spring
spring restTemplate 进行http请求的工具类封装
spring restTemplate 进行http请求的工具类封装
525 3
|
文字识别 Java Python
文本,文识10,springBoot提供RestTemplate以调用Flask OCR接口,调用flask实现ocr接口,用paddleocr进行图片识别云服务技术,单个paddleocr接口有影响
文本,文识10,springBoot提供RestTemplate以调用Flask OCR接口,调用flask实现ocr接口,用paddleocr进行图片识别云服务技术,单个paddleocr接口有影响
|
运维 Java 关系型数据库
Spring运维之boot项目bean属性的绑定读取与校验
Spring运维之boot项目bean属性的绑定读取与校验
155 2
|
存储 运维 Java
Spring运维之boot项目开发关键之日志操作以及用文件记录日志
Spring运维之boot项目开发关键之日志操作以及用文件记录日志
189 2