我们平时开发项目时，就算是单体应用，也免不了要调用一下其他服务提供的接口。此时就会用到HTTP客户端工具，之前一直使用的是Hutool中的HttpUtil，虽然容易上手，但用起来颇为麻烦！最近发现一款更好用的HTTP客户端工具Retrofit，你只需声明接口就可发起HTTP请求，无需进行连接、结果解析之类的重复操作，用起来够优雅，推荐给大家！

简介

Retrofit是适用于Android和Java且类型安全的HTTP客户端工具，在Github上已经有39k+Star。其最大的特性的是支持通过接口的方式发起HTTP请求，类似于我们用Feign调用微服务接口的那种方式。

SpringBoot是使用最广泛的Java开发框架，但是Retrofit官方并没有提供专门的Starter。于是有位老哥就开发了retrofit-spring-boot-starter，它实现了Retrofit与SpringBoot框架的快速整合，并且支持了诸多功能增强，极大简化开发。今天我们将使用这个第三方Starter来操作Retrofit。

使用

在SpringBoot中使用Retrofit是非常简单的，下面我们就来体验下。

依赖集成

有了第三方Starter的支持，集成Retrofit仅需一步，添加如下依赖即可。

<!--Retrofit依赖-->
<dependency><groupId>com.github.lianjiatech</groupId><artifactId>retrofit-spring-boot-starter</artifactId><version>2.2.18</version>
</dependency>
复制代码

基本使用

下面以调用mall-tiny-swagger中的接口为例，我们来体验下Retrofit的基本使用。

首先我们准备一个服务来方便远程调用，使用的是之前的mall-tiny-swagger这个Demo，打开Swagger看下，里面有一个登录接口和需要登录认证的商品品牌CRUD接口，项目地址：github.com/macrozheng/…

我们先来调用下登录接口试试，在application.yml中配置好mall-tiny-swagger的服务地址；

remote:baseUrl: http://localhost:8088/
复制代码

再通过@RetrofitClient声明一个Retrofit客户端，由于登录接口是通过POST表单形式调用的，这里使用到了@POST和@FormUrlEncoded注解；

/*** 定义Http接口，用于调用远程的UmsAdmin服务* Created by macro on 2022/1/19.*/
@RetrofitClient(baseUrl = "${remote.baseUrl}")
public interface UmsAdminApi {@FormUrlEncoded@POST("admin/login")CommonResult<LoginInfo> login(@Field("username") String username, @Field("password") String password);
}
复制代码

如果你不太明白这些注解是干嘛的，看下下面的表基本就懂了，更具体的话可以参考Retrofit官方文档；

接下来在Controller中注入UmsAdminApi，然后进行调用即可；

/*** Retrofit测试接口* Created by macro on 2022/1/19.*/
@Api(tags = "RetrofitController", description = "Retrofit测试接口")
@RestController
@RequestMapping("/retrofit")
public class RetrofitController {@Autowiredprivate UmsAdminApi umsAdminApi;@Autowiredprivate TokenHolder tokenHolder;@ApiOperation(value = "调用远程登录接口获取token")@PostMapping(value = "/admin/login")public CommonResult<LoginInfo> login(@RequestParam String username, @RequestParam String password) {CommonResult<LoginInfo> result = umsAdminApi.login(username, password);LoginInfo loginInfo = result.getData();if (result.getData() != null) {tokenHolder.putToken(loginInfo.getTokenHead() + " " + loginInfo.getToken());}return result;}
}
复制代码

为方便后续调用需要登录认证的接口，我创建了TokenHolder这个类，把token存储到了Session中；

/*** 登录token存储（在Session中）* Created by macro on 2022/1/19.*/
@Component
public class TokenHolder {/*** 添加token*/public void putToken(String token) {RequestAttributes ra = RequestContextHolder.getRequestAttributes();HttpServletRequest request = ((ServletRequestAttributes) ra).getRequest();request.getSession().setAttribute("token", token);}/*** 获取token*/public String getToken() {RequestAttributes ra = RequestContextHolder.getRequestAttributes();HttpServletRequest request = ((ServletRequestAttributes) ra).getRequest();Object token = request.getSession().getAttribute("token");if(token!=null){return (String) token;}return null;}}
复制代码

接下来通过Swagger进行测试，调用接口就可以获取到远程服务返回的token了，访问地址：http://localhost:8086/swagger-ui/

注解式拦截器

商品品牌管理接口，需要添加登录认证头才可以正常访问，我们可以使用Retrofit中的注解式拦截器来实现。

首先创建一个注解式拦截器TokenInterceptor继承BasePathMatchInterceptor，然后在doIntercept方法中给请求添加Authorization头；

/*** 给请求添加登录Token头的拦截器* Created by macro on 2022/1/19.*/
@Component
public class TokenInterceptor extends BasePathMatchInterceptor {@Autowiredprivate TokenHolder tokenHolder;@Overrideprotected Response doIntercept(Chain chain) throws IOException {Request request = chain.request();if (tokenHolder.getToken() != null) {request = request.newBuilder().header("Authorization", tokenHolder.getToken()).build();}return chain.proceed(request);}
}
复制代码

创建调用品牌管理接口的客户端PmsBrandApi，使用@Intercept注解配置拦截器和拦截路径；

/*** 定义Http接口，用于调用远程的PmsBrand服务* Created by macro on 2022/1/19.*/
@RetrofitClient(baseUrl = "${remote.baseUrl}")
@Intercept(handler = TokenInterceptor.class, include = "/brand/**")
public interface PmsBrandApi {@GET("brand/list")CommonResult<CommonPage<PmsBrand>> list(@Query("pageNum") Integer pageNum, @Query("pageSize") Integer pageSize);@GET("brand/{id}")CommonResult<PmsBrand> detail(@Path("id") Long id);@POST("brand/create")CommonResult create(@Body PmsBrand pmsBrand);@POST("brand/update/{id}")CommonResult update(@Path("id") Long id, @Body PmsBrand pmsBrand);@GET("brand/delete/{id}")CommonResult delete(@Path("id") Long id);
}
复制代码

再在Controller中注入PmsBrandApi实例，并添加方法调用远程服务即可；

/*** Retrofit测试接口* Created by macro on 2022/1/19.*/
@Api(tags = "RetrofitController", description = "Retrofit测试接口")
@RestController
@RequestMapping("/retrofit")
public class RetrofitController {@Autowiredprivate PmsBrandApi pmsBrandApi;@ApiOperation("调用远程接口分页查询品牌列表")@GetMapping(value = "/brand/list")public CommonResult<CommonPage<PmsBrand>> listBrand(@RequestParam(value = "pageNum", defaultValue = "1")@ApiParam("页码") Integer pageNum,@RequestParam(value = "pageSize", defaultValue = "3")@ApiParam("每页数量") Integer pageSize) {return pmsBrandApi.list(pageNum, pageSize);}@ApiOperation("调用远程接口获取指定id的品牌详情")@GetMapping(value = "/brand/{id}")public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) {return pmsBrandApi.detail(id);}@ApiOperation("调用远程接口添加品牌")@PostMapping(value = "/brand/create")public CommonResult createBrand(@RequestBody PmsBrand pmsBrand) {return pmsBrandApi.create(pmsBrand);}@ApiOperation("调用远程接口更新指定id品牌信息")@PostMapping(value = "/brand/update/{id}")public CommonResult updateBrand(@PathVariable("id") Long id, @RequestBody PmsBrand pmsBrand) {return pmsBrandApi.update(id,pmsBrand);}@ApiOperation("调用远程接口删除指定id的品牌")@GetMapping(value = "/delete/{id}")public CommonResult deleteBrand(@PathVariable("id") Long id) {return  pmsBrandApi.delete(id);}
}
复制代码

在Swagger中调用接口进行测试，发现已经可以成功调用。

全局拦截器

如果你想给所有请求都加个请求头的话，可以使用全局拦截器。

创建SourceInterceptor类继承BaseGlobalInterceptor接口，然后在Header中添加source请求头。

/*** 全局拦截器，给请求添加source头* Created by macro on 2022/1/19.*/
@Component
public class SourceInterceptor extends BaseGlobalInterceptor {@Overrideprotected Response doIntercept(Chain chain) throws IOException {Request request = chain.request();Request newReq = request.newBuilder().addHeader("source", "retrofit").build();return chain.proceed(newReq);}
}
复制代码

配置

Retrofit的配置很多，下面我们讲讲日志打印、全局超时时间和全局请求重试这三种最常用的配置。

日志打印

默认配置下Retrofit使用basic日志策略，打印的日志非常简单；

我们可以将application.yml中的retrofit.global-log-strategy属性修改为body来打印最全日志；

retrofit:# 日志打印配置log:# 启用日志打印enable: true# 日志打印拦截器logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor# 全局日志打印级别global-log-level: info# 全局日志打印策略global-log-strategy: body
复制代码

修改日志打印策略后，日志信息更全面了；

Retrofit支持四种日志打印策略；NONE：不打印日志；BASIC：只打印日志请求记录；HEADERS：打印日志请求记录、请求和响应头信息；BODY：打印日志请求记录、请求和响应头信息、请求和响应体信息。

全局超时时间

有时候我们需要修改一下Retrofit的请求超时时间，可以通过如下配置实现。

retrofit:# 全局连接超时时间global-connect-timeout-ms: 3000# 全局读取超时时间global-read-timeout-ms: 3000# 全局写入超时时间global-write-timeout-ms: 35000# 全局完整调用超时时间global-call-timeout-ms: 0
复制代码

全局请求重试

retrofit-spring-boot-starter支持请求重试，可以通过如下配置实现。

retrofit:# 重试配置retry:# 是否启用全局重试enable-global-retry: true# 全局重试间隔时间global-interval-ms: 100# 全局最大重试次数global-max-retries: 2# 全局重试规则global-retry-rules:- response_status_not_2xx- occur_exception# 重试拦截器retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor
复制代码

重试规则global-retry-rules支持如下三种配置。
RESPONSE_STATUS_NOT_2XX：响应状态码不是2xx时执行重试；
OCCUR_IO_EXCEPTION：发生IO异常时执行重试；
OCCUR_EXCEPTION：发生任意异常时执行重试。

更好用的HTTP客户端工具，跟SpringBoot绝配相关推荐

spring-boot项目优雅的http客户端工具，太香了!
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章来源:https://juejin.im/post/6854573 ...
终于有人把 SpringBoot 项目的Http客户端工具说清楚了！
大家都知道okhttp是一款由square公司开源的java版本http客户端工具.实际上,square公司还开源了基于okhttp进一步封装的retrofit工具,用来支持通过接口的方式发起http ...
开源Redis可视化客户端工具，用过的人都说好看又好用！
自从Redis面世以来,作为一个开源的高性能的key-value型数据库,很大程度的对关系型数据库起到很好的补充作用. Redis实现简单,功能齐全,已经成为了业界最常用的组件之一.为了更方便的使用, ...
redis 用中文做key_推荐一款Redis客户端工具
日常开发过程中,项目常常都会使用Redis来做缓存或者Session服务器,为了更直观方便,开发者常常会使用一些可视化工具,如 Redis Desktop Manager.Redis Clent等,但 ...
别再用 httpClient了，快试试这款优雅的 HTTP 客户端工具！
今日推荐最适合晚上睡不着看的 8 个网站,建议收藏哦 23 种设计模式的通俗解释,虽然有点污,但是秒懂请立即卸载这款 IDEA 插件!SQL自动检查神器,再也不用担心SQL出错了,自动补全.回滚等功 ...
Spring Boot项目整合Retrofit最佳实践，最优雅的HTTP客户端工具！
点击上方好好学java ,选择星标公众号重磅资讯.干货,第一时间送达今日推荐:2020年7月程序员工资统计,平均14357元,又跌了,扎心个人原创100W+访问量博客:点击前往,查看更多转自 ...
用Delphi开发OPC客户端工具的方法研究
用Delphi开发OPC客户端工具的方法研究[1]<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:o ...
Influxdb安装、启动influxdb控制台、常用命令、Influx命令使用、Influx-sql使用举例、Influxdb的数据格式、Influxdb客户端工具
目录: Influxdb安装 1 1.1. Influxdb下载 2 1.2. 解压tar包 2 1.3. 修改配置文件 2 1.4. 配置文件参数说明 3 1.5. 实际配置(主要是修改路径和端口) ...
idea命令行运行多个客户端_推荐一款神仙颜值的 Redis 客户端工具，开源啦
日常开发过程中,项目常常都会使用Redis来做缓存或者Session服务器,为了更直观方便,开发者常常会使用一些可视化工具,如 Redis Desktop Manager.Redis Clent等,但 ...

更好用的HTTP客户端工具，跟SpringBoot绝配

简介

使用