资讯专栏INFORMATION COLUMN

SpringBoot 2.X Kotlin系列之RestTemplate配置及使用

wdzgege / 1943人阅读

摘要:调用的默认构造函数,对象在底层通过使用包下的实现创建请求,可以通过使用指定不同的请求方式。接口主要提供了两种实现方式一种是,使用提供的方式既包提供的方式创建底层的请求连接。

自从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  postForm(params: Map, url: String, t:T) : ResultDTO? {
        logger.info("请求URL===========:{}", url)
        logger.info("请求参数===========:{}", params)
        val httpHeaders = HttpHeaders()
        httpHeaders.contentType = MediaType.APPLICATION_FORM_URLENCODED
        val requestParams = LinkedMultiValueMap()
        params.forEach(requestParams::add)
        val httpEntity = HttpEntity>(requestParams, httpHeaders)
        return restTemplate.postForObject(url, httpEntity, ResultDTO().javaClass)
    }
}
编写Controller及测试
@RestController
@RequestMapping("/api")
class LotteryController {

    @Autowired lateinit var restTemplateClient: RestTemplateClient

    /**
     * 彩票类型查询
     */
    @PostMapping("/lottery/types")
    fun lotteryTypes(@RequestBody params:Map) : ResultDTO? {
        return restTemplateClient.postForm(params, UrlEnums.DEMO1.url, LotteryDTO())
    }
}

发送POST请求,通JSON传参
/**
 * 发送POST请求,通过Form表单提交参数
 */
fun  postBody(params: Map, url: String, t:T) : ResultDTO? {
    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().javaClass)
}
发送GET请求
/**
 * 发送POST请求,通过Form表单提交参数
 */
fun  get(params: Map, url: String, t:T) : ResultDTO? {
    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().javaClass)
}
GET下载资源
/**
 * 下载资源
 */
fun downGet(url: String, headerParams: Map) : ByteArray? {
    logger.info("资源URL==========>:{}", url)
    val httpHeaders = HttpHeaders()
    if (!CollectionUtils.isEmpty(headerParams)) {
        headerParams.forEach(httpHeaders::add)
    }
    val httpEntity = HttpEntity(LinkedMultiValueMap().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> = 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,不然启动会报错的


    org.apache.httpcomponents
    httpclient
    4.5.6

关于RestTemplate的一些使用及配置优化到此就结束了,喜欢的朋友可以关注本人的博客https://www.tisnz.com,如果有不对的地方欢迎指正。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/74113.html

相关文章

  • SpringBoot 2.X Kotlin 系列Reactive Mongodb 与 JPA

    摘要:一本节目标前两章主要讲了的基本操作,这一章我们将学习使用访问,并通过完成简单操作。这里有一个问题什么不选用数据库呢答案是目前支持。突出点是,即非阻塞的。二构建项目及配置本章不在讲解如何构建项目了,大家可以参考第一章。 showImg(https://segmentfault.com/img/remote/1460000018819338?w=1024&h=500); 一、本节目标 前两...

    MSchumi 评论0 收藏0
  • SpringBoot 2.X Kotlin 系列Reactive Mongodb 与 JPA

    摘要:一本节目标前两章主要讲了的基本操作,这一章我们将学习使用访问,并通过完成简单操作。这里有一个问题什么不选用数据库呢答案是目前支持。突出点是,即非阻塞的。二构建项目及配置本章不在讲解如何构建项目了,大家可以参考第一章。 showImg(https://segmentfault.com/img/remote/1460000018819338?w=1024&h=500); 一、本节目标 前两...

    琛h。 评论0 收藏0
  • SpringBoot 2.X Kotlin系列JavaMailSender发送邮件

    摘要:在很多服务中我经常需要用到发送邮件功能,所幸的是可以快速使用的框架,只要引入改框架我们可以快速的完成发送邮件功能。引入获取邮件发送服务器配置在国内用的最多的就是邮件和网易邮件,这里会简单讲解获取两家服务商的发送邮件配置。 showImg(https://segmentfault.com/img/remote/1460000018819338?w=1024&h=500); 在很多服务中我...

    derek_334892 评论0 收藏0
  • SpringBoot 2.X Kotlin 系列Hello World

    摘要:二教程环境三创建项目创建项目有两种方式一种是在官网上创建二是在上创建如图所示勾选然后点,然后一直默认最后点击完成即可。我们这里看到和普通的接口没有异同,除了返回类型是用包装之外。与之对应的还有,这个后面我们会讲到。 showImg(https://segmentfault.com/img/remote/1460000018819338?w=1024&h=500); 从去年开始就开始学习...

    warkiz 评论0 收藏0
  • 微服务调用链追踪中心搭建

    摘要:一个客户端请求从发出到被响应经历了哪些组件哪些微服务请求总时长每个组件所花时长等信息我们有必要了解和收集,以帮助我们定位性能瓶颈进行性能调优,因此监控整个微服务架构的调用链十分有必要,本文将阐述如何使用搭建微服务调用链追踪中心。 showImg(https://segmentfault.com/img/remote/1460000014553707); 概述 一个完整的微服务系统包含...

    Pines_Cheng 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<