spring-boot项目优雅的http客户端工具，真香！

大家都知道okhttp是一款由square公司开源的java版本http客户端工具。实际上，square公司还开源了基于okhttp进一步封装的retrofit工具，用来支持通过接口的方式发起http请求。如果你的项目中还在直接使用RestTemplate或者okhttp，或者基于它们封装的HttpUtils，那么你可以尝试使用Retrofit。

retrofit-spring-boot-starter实现了Retrofit与spring-boot框架快速整合，并且支持了部分功能增强，从而极大的简化spring-boot项目下http接口调用开发。接下来我们直接通过retrofit-spring-boot-starter，来看看spring-boot项目发送http请求有多简单。

retrofit官方并没有提供与spring-boot快速整合的starter。retrofit-spring-boot-starter是笔者封装的，已在生产环境使用，非常稳定。

项目源码：retrofit-spring-boot-starter

引入依赖

com.github.lianjiatech

retrofit-spring-boot-starter

2.0.2

配置@RetrofitScan注解

你可以给带有@Configuration的类配置@RetrofitScan，或者直接配置到spring-boot的启动类上，如下：

@SpringBootApplication

@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")

publicclassRetrofitTestApplication{

publicstaticvoidmain(String[] args){

SpringApplication.run(RetrofitTestApplication.class, args);

}

}

定义http接口

接口必须使用@RetrofitClient注解标记！http相关注解可参考官方文档：retrofit官方文档。

@RetrofitClient(baseUrl ="${test.baseUrl}")

publicinterfaceHttpApi{

@GET("person")

ResultgetPerson(@Query("id")Long id);

}

注入使用

将接口注入到其它Service中即可使用。

@Service

publicclassTestService{

@Autowired

privateHttpApi httpApi;

publicvoidtest(){

// 通过httpApi发起http请求

}

}

只要通过上述几个步骤，就能实现通过接口发送http请求了，真的很简单。如果你在spring-boot项目里面使用过mybatis，相信你对这种使用方式会更加熟悉。接下来我们继续介绍一下retrofit-spring-boot-starter更高级一点的功能。

注解式拦截器

很多时候，我们希望某个接口下的某些http请求执行统一的拦截处理逻辑。这个时候可以使用注解式拦截器。使用的步骤主要分为2步：

继承BasePathMatchInterceptor编写拦截处理器；

接口上使用@Intercept进行标注。

下面以给指定请求的url后面拼接timestamp时间戳为例，介绍下如何使用注解式拦截器。

继承BasePathMatchInterceptor编写拦截处理器

@Component

publicclassTimeStampInterceptorextendsBasePathMatchInterceptor{

@Override

publicResponsedoIntercept(Chain chain)throwsIOException{

Request request = chain.request();

HttpUrl url = request.url();

longtimestamp = System.currentTimeMillis();

HttpUrl newUrl = url.newBuilder()

.addQueryParameter("timestamp", String.valueOf(timestamp))

.build();

Request newRequest = request.newBuilder()

.url(newUrl)

.build();

returnchain.proceed(newRequest);

}

}

接口上使用@Intercept进行标注

@RetrofitClient(baseUrl ="${test.baseUrl}")

@Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude ="/api/test/savePerson")

publicinterfaceHttpApi{

@GET("person")

ResultgetPerson(@Query("id")Long id);

@POST("savePerson")

ResultsavePerson(@Body Person person);

}

上面的@Intercept配置表示：拦截HttpApi接口下/api/**路径下（排除/api/test/savePerson）的请求，拦截处理器使用TimeStampInterceptor。

扩展注解式拦截器

有的时候，我们需要在拦截注解动态传入一些参数，然后再执行拦截的时候需要使用这个参数。这种时候，我们可以扩展实现自定义拦截注解。自定义拦截注解必须使用@InterceptMark标记，并且注解中必须包括include()、exclude()、handler()属性信息。使用的步骤主要分为3步：

自定义拦截注解

继承BasePathMatchInterceptor编写拦截处理器

接口上使用自定义拦截注解；

例如我们需要在请求头里面动态加入accessKeyId、accessKeySecret签名信息才能正常发起http请求，这个时候可以自定义一个加签拦截器注解@Sign来实现。下面以自定义@Sign拦截注解为例进行说明。

自定义@Sign注解

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.TYPE)

@Documented

@InterceptMark

public@interfaceSign {

/**

* 密钥key

* 支持占位符形式配置。

*

*@return

*/

StringaccessKeyId();

/**

* 密钥

* 支持占位符形式配置。

*

*@return

*/

StringaccessKeySecret();

/**

* 拦截器匹配路径

*

*@return

*/

String[] include()default{"/**"};

/**

* 拦截器排除匹配，排除指定路径拦截

*

*@return

*/

String[] exclude()default{};

/**

* 处理该注解的拦截器类

* 优先从spring容器获取对应的Bean，如果获取不到，则使用反射创建一个！

*

*@return

*/

Class handler()defaultSignInterceptor.class;

}

扩展自定义拦截注解有以下2点需要注意：

自定义拦截注解必须使用@InterceptMark标记。

注解中必须包括include()、exclude()、handler()属性信息。

实现SignInterceptor

@Component

publicclassSignInterceptorextendsBasePathMatchInterceptor{

privateString accessKeyId;

privateString accessKeySecret;

publicvoidsetAccessKeyId(String accessKeyId){

this.accessKeyId = accessKeyId;

}

publicvoidsetAccessKeySecret(String accessKeySecret){

this.accessKeySecret = accessKeySecret;

}

@Override

publicResponsedoIntercept(Chain chain)throwsIOException{

Request request = chain.request();

Request newReq = request.newBuilder()

.addHeader("accessKeyId", accessKeyId)

.addHeader("accessKeySecret", accessKeySecret)

.build();

returnchain.proceed(newReq);

}

}

上述accessKeyId和accessKeySecret字段值会依据@Sign注解的accessKeyId()和accessKeySecret()值自动注入，如果@Sign指定的是占位符形式的字符串，则会取配置属性值进行注入。另外accessKeyId和accessKeySecret字段必须提供setter方法。

接口上使用@Sign

@RetrofitClient(baseUrl ="${test.baseUrl}")

@Sign(accessKeyId ="${test.accessKeyId}", accessKeySecret ="${test.accessKeySecret}", exclude = {"/api/test/person"})

publicinterfaceHttpApi{

@GET("person")

ResultgetPerson(@Query("id")Long id);

@POST("savePerson")

ResultsavePerson(@Body Person person);

}

这样就能在指定url的请求上，自动加上签名信息了。

连接池管理

默认情况下，所有通过Retrofit发送的http请求都会使用max-idle-connections=5 keep-alive-second=300的默认连接池。当然，我们也可以在配置文件中配置多个自定义的连接池，然后通过@RetrofitClient的poolName属性来指定使用。比如我们要让某个接口下的请求全部使用poolName=test1的连接池，代码实现如下：

配置连接池。

retrofit:

# 连接池配置

   pool:

       test1:

       max-idle-connections:3

       keep-alive-second:100

       test2:

       max-idle-connections:5

       keep-alive-second:50

通过@RetrofitClient的poolName属性来指定使用的连接池。

@RetrofitClient(baseUrl ="${test.baseUrl}", poolName="test1")

publicinterfaceHttpApi{

@GET("person")

ResultgetPerson(@Query("id")Long id);

}

日志打印

很多情况下，我们希望将http请求日志记录下来。通过@RetrofitClient的logLevel和logStrategy属性，您可以指定每个接口的日志打印级别以及日志打印策略。retrofit-spring-boot-starter支持了5种日志打印级别(ERROR,WARN,INFO,DEBUG,TRACE)，默认INFO；支持了4种日志打印策略（NONE,BASIC,HEADERS,BODY），默认BASIC。4种日志打印策略含义如下：

NONE：No logs.

BASIC：Logs request and response lines.

HEADERS：Logs request and response lines and their respective headers.

BODY：Logs request and response lines and their respective headers and bodies (if present).

retrofit-spring-boot-starter默认使用了DefaultLoggingInterceptor执行真正的日志打印功能，其底层就是okhttp原生的HttpLoggingInterceptor。当然，你也可以自定义实现自己的日志打印拦截器，只需要继承BaseLoggingInterceptor（具体可以参考DefaultLoggingInterceptor的实现），然后在配置文件中进行相关配置即可。

retrofit:

# 日志打印拦截器

  logging-interceptor:com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor

Http异常信息格式化器

当出现http请求异常时，原始的异常信息可能阅读起来并不友好，因此retrofit-spring-boot-starter提供了Http异常信息格式化器，用来美化输出http请求参数，默认使用DefaultHttpExceptionMessageFormatter进行请求数据格式化。你也可以进行自定义，只需要继承BaseHttpExceptionMessageFormatter，再进行相关配置即可。

retrofit:

# Http异常信息格式化器

  http-exception-message-formatter:com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter

调用适配器 CallAdapter

Retrofit可以通过调用适配器CallAdapterFactory将Call<T>对象适配成接口方法的返回值类型。retrofit-spring-boot-starter扩展2种CallAdapterFactory实现：

BodyCallAdapterFactory

默认启用，可通过配置retrofit.enable-body-call-adapter=false关闭

同步执行http请求，将响应体内容适配成接口方法的返回值类型实例。

除了Retrofit.Call<T>、Retrofit.Response<T>、java.util.concurrent.CompletableFuture<T>之外，其它返回类型都可以使用该适配器。

ResponseCallAdapterFactory

默认启用，可通过配置retrofit.enable-response-call-adapter=false关闭

同步执行http请求，将响应体内容适配成Retrofit.Response<T>返回。

如果方法的返回值类型为Retrofit.Response<T>，则可以使用该适配器。

Retrofit自动根据方法返回值类型选用对应的CallAdapterFactory执行适配处理！加上Retrofit默认的CallAdapterFactory，可支持多种形式的方法返回值类型：

Call<T>: 不执行适配处理，直接返回Call<T>对象

CompletableFuture<T>: 将响应体内容适配成CompletableFuture<T>对象返回

Void: 不关注返回类型可以使用Void。如果http状态码不是2xx，直接抛错！

Response<T>: 将响应内容适配成Response<T>对象返回

其他任意Java类型：将响应体内容适配成一个对应的Java类型对象返回，如果http状态码不是2xx，直接抛错！

/**

* Call

* 不执行适配处理，直接返回Call对象

*@paramid

*@return

*/

@GET("person")

Call> getPersonCall(@Query("id") Long id);

/**

*  CompletableFuture

*  将响应体内容适配成CompletableFuture对象返回

*@paramid

*@return

*/

@GET("person")

CompletableFuture> getPersonCompletableFuture(@Query("id") Long id);

/**

* Void

* 不关注返回类型可以使用Void。如果http状态码不是2xx，直接抛错！

*@paramid

*@return

*/

@GET("person")

VoidgetPersonVoid(@Query("id")Long id);

/**

*  Response

*  将响应内容适配成Response对象返回

*@paramid

*@return

*/

@GET("person")

Response> getPersonResponse(@Query("id") Long id);

/**

* 其他任意Java类型

* 将响应体内容适配成一个对应的Java类型对象返回，如果http状态码不是2xx，直接抛错！

*@paramid

*@return

*/

@GET("person")

ResultgetPerson(@Query("id")Long id);

我们也可以通过继承CallAdapter.Factory扩展实现自己的CallAdapter；然后将自定义的CallAdapterFactory配置成spring的bean！

自定义配置的CallAdapter.Factory优先级更高！

数据转码器 Converter

Retrofi使用Converter将@Body注解标注的对象转换成请求体，将响应体数据转换成一个Java对象，可以选用以下几种Converter：

Gson: com.squareup.Retrofit:converter-gson

Jackson: com.squareup.Retrofit:converter-jackson

Moshi: com.squareup.Retrofit:converter-moshi

Protobuf: com.squareup.Retrofit:converter-protobuf

Wire: com.squareup.Retrofit:converter-wire

Simple XML: com.squareup.Retrofit:converter-simplexml

retrofit-spring-boot-starter默认使用的是jackson进行序列化转换！如果需要使用其它序列化方式，在项目中引入对应的依赖，再把对应的ConverterFactory配置成spring的bean即可。

我们也可以通过继承Converter.Factory扩展实现自己的Converter；然后将自定义的Converter.Factory配置成spring的bean！

自定义配置的Converter.Factory优先级更高！

全局拦截器 BaseGlobalInterceptor

如果我们需要对整个系统的的http请求执行统一的拦截处理，可以自定义实现全局拦截器BaseGlobalInterceptor, 并配置成spring中的bean！例如我们需要在整个系统发起的http请求，都带上来源信息。

@Component

publicclassSourceInterceptorextendsBaseGlobalInterceptor{

@Override

publicResponsedoIntercept(Chain chain)throwsIOException{

Request request = chain.request();

Request newReq = request.newBuilder()

.addHeader("source","test")

.build();

returnchain.proceed(newReq);

}

}

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,839评论 6赞 482
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,543评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 153,116评论 0赞 344
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,371评论 1赞 279
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,384评论 5赞 374
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,111评论 1赞 285
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,416评论 3赞 400
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,053评论 0赞 259
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,558评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2赞 325
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1赞 334
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,756评论 4赞 324
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,324评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1赞 262
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2赞 355
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2赞 345