image
自从RESTFul API兴起后，Spring就给开发者提供了一个访问Rest的客服端，RestTemplate不仅可以很方便的调用http接口，还可以调用同一注册中心下的微服务，同时还有负载均衡和熔断机制。当然我也听说OKhttp，HTTPClient之类的网络框架，但是我们这里重点讲的是RestTemplate(其中一种实现就是基于HTTPClient实现的)，因为这是SpringBoot自带，而且基本使用场景都覆盖了。
什么是RestTemplate?
RestTemplate是Spring提供的用于访问Rest服务的客户端，
RestTemplate提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。
调用RestTemplate的默认构造函数，RestTemplate对象在底层通过使用java.net包下的实现创建HTTP 请求，
可以通过使用ClientHttpRequestFactory指定不同的HTTP请求方式。
ClientHttpRequestFactory接口主要提供了两种实现方式
1、一种是SimpleClientHttpRequestFactory，使用J2SE提供的方式（既java.net包提供的方式）创建底层的Http请求连接。
2、一种方式是使用HttpComponentsClientHttpRequestFactory方式，底层使用HttpClient访问远程的Http服务，使用HttpClient可以配置连接池和证书等信息。
简单配置RestTemplate
@Configuration
class RestTemplateConfig {
/**
* 构建一个使用默认配置RestTemplate Bean
*/
@Bean
fun restTemplate():RestTemplate {
return RestTemplateBuilder().build()
}
}
发送POST请求，通过Form表单提交参数
@Component
class RestTemplateClient {
@Autowired lateinit var restTemplate: RestTemplate
val logger:Logger = LoggerFactory.getLogger(this.javaClass)
/**
* 发送POST请求，通过Form表单提交参数
*/
fun <T> postForm(params: Map<String, String>, url: String, t:T) : ResultDTO<T>? {
logger.info("请求URL===========:{}", url)
logger.info("请求参数===========:{}", params)
val httpHeaders = HttpHeaders()
httpHeaders.contentType = MediaType.APPLICATION_FORM_URLENCODED
val requestParams = LinkedMultiValueMap<String, String>()
params.forEach(requestParams::add)
val httpEntity = HttpEntity<MultiValueMap<String, String>>(requestParams, httpHeaders)
return restTemplate.postForObject(url, httpEntity, ResultDTO<T>().javaClass)
}
}
编写Controller及测试
@RestController
@RequestMapping("/api")
class LotteryController {
@Autowired lateinit var restTemplateClient: RestTemplateClient
/**
* 彩票类型查询
*/
@PostMapping("/lottery/types")
fun lotteryTypes(@RequestBody params:Map<String, String>) : ResultDTO<LotteryDTO>? {
return restTemplateClient.postForm(params, UrlEnums.DEMO1.url, LotteryDTO())
}
}
image
发送POST请求，通JSON传参
/**
* 发送POST请求，通过Form表单提交参数
*/
fun <T> postBody(params: Map<String, String>, url: String, t:T) : ResultDTO<T>? {
logger.info("请求URL===========:{}", url)
logger.info("请求参数===========:{}", params)
val httpHeaders = HttpHeaders()
httpHeaders.contentType = MediaType.APPLICATION_JSON_UTF8
val httpEntity = HttpEntity(params, httpHeaders)
return restTemplate.postForObject(url, httpEntity, ResultDTO<T>().javaClass)
}
发送GET请求
/**
* 发送POST请求，通过Form表单提交参数
*/
fun <T> get(params: Map<String, String>, url: String, t:T) : ResultDTO<T>? {
logger.info("请求URL===========:{}", url)
logger.info("请求参数===========:{}", params)
val builder = StringBuilder()
params.forEach{k, v -> builder.append(k).append("=").append(v).append("&") }
val param : String = builder.toString().substring(0, builder.length - 1)
return restTemplate.getForObject(url.plus(param), ResultDTO<T>().javaClass)
}
GET下载资源
/**
* 下载资源
*/
fun downGet(url: String, headerParams: Map<String, String>) : ByteArray? {
logger.info("资源URL==========>:{}", url)
val httpHeaders = HttpHeaders()
if (!CollectionUtils.isEmpty(headerParams)) {
headerParams.forEach(httpHeaders::add)
}
val httpEntity = HttpEntity(LinkedMultiValueMap<String, String>().putAll(httpHeaders))
return restTemplate.exchange(url, HttpMethod.GET, httpEntity, ByteArray::class.java).body
}
调用微服务接口
我们在开发微服务应用的时候，有时候一个应用可能会部署很多台，而且还是不在不通的机器上，这个时候我们可以用Nginx做一个负载均衡，但是我们这里推荐使用的是SpringCloud提供的负载均衡，只要在Bean上面加一个注解即可@LoadBalanced,如下所示:
@Bean
@LoadBalanced
fun restTemplate():RestTemplate {
return RestTemplateBuilder().build()
}
和调用普通的http请求有点不同的地方是，调用微服务是http://application.name/xxx,我们访问的路径是微服务应用名称+业务路由，因为服务会注册到注册中心，注册中心会维护这个应用名称，当我们通过应用去访问时，就可以知道这个应用在那台机器上了。
基础使用讲完了，但是这里还存在一个问题，因为我们使用的是最简单的配置，在这里我们没有设置默认超时时间，官方默认的是60S,但是我们业务中通常对响应速度是有要求，一分钟的等待时间对于用户来说太长了，这个时候我们就需要有一个超时机制，具体的设置如下:
package io.intodream.kotlin05.config
import org.apache.http.impl.client.HttpClientBuilder
import org.springframework.beans.factory.annotation.Value
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.web.client.RestTemplateBuilder
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.http.client.ClientHttpRequestFactory
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory
import org.springframework.http.client.SimpleClientHttpRequestFactory
import org.springframework.http.converter.HttpMessageConverter
import org.springframework.http.converter.StringHttpMessageConverter
import org.springframework.stereotype.Component
import org.springframework.web.client.RestTemplate
import java.nio.charset.StandardCharsets
/**
* @description
* RestTemplate 配置
* @author Jwenk
* @copyright intoDream.io 筑梦科技
* @email xmsjgzs@163.com
* @date 2019-04-05,22:42
*/
@Configuration
class RestTemplateConfig {
@Value("\${remote.maxTotalConnect}")
val maxTotalConnect: Int = 0
@Value("\${remote.maxConnectPerRoute}")
val maxConnectPerRoute: Int = 200
@Value("\${remote.connectTimeout}")
val connectTimeout: Int = 2000
@Value("\${remote.readTimeout}")
val readTimeout: Int = 3000
/**
* 创建HTTP客户端工厂
*/
private fun createFactory() : ClientHttpRequestFactory {
if (this.maxTotalConnect <= 0) {
val factory = SimpleClientHttpRequestFactory()
factory.setReadTimeout(this.readTimeout)
factory.setConnectTimeout(this.connectTimeout)
return factory
}
val httpClient = HttpClientBuilder.create()
.setMaxConnTotal(this.maxTotalConnect)
.setMaxConnPerRoute(this.maxConnectPerRoute).build()
val factory = HttpComponentsClientHttpRequestFactory(httpClient)
factory.setConnectTimeout(this.connectTimeout)
factory.setReadTimeout(this.readTimeout)
return factory
}
/**
* 构建一个使用默认配置RestTemplate Bean
*/
@Bean
fun restTemplate():RestTemplate {
val restTemplate = RestTemplate(this.createFactory())
val converterList : MutableList<HttpMessageConverter<*>> = restTemplate.messageConverters
var converterTarget : HttpMessageConverter<*>? = null
/**
* 重新设置StringHttpMessageConverter字符集为UTF-8，解决中文乱码问题
*/
for (item: HttpMessageConverter<*> in converterList) {
if (StringHttpMessageConverter::class.java == item.javaClass) {
converterTarget = item
break
}
}
if (null != converterTarget) {
converterList.remove(converterTarget)
}
converterList.add(1, StringHttpMessageConverter(StandardCharsets.UTF_8))
return restTemplate
}
}
记得在pom.xml里面引入HttpClient的jar，不然启动会报错的
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.6</version>
</dependency>
关于RestTemplate的一些使用及配置优化到此就结束了，喜欢的朋友可以关注本人的博客https://www.tisnz.com，如果有不对的地方欢迎指正。
