Spring Boot 中的Http接口调用只知道 RestTemplate？来试下 Retrofit ！

矫情吗；* 2022-08-29 10:14 143阅读 0赞

![9c084f7f7d72bf5e343e51da89e9d4ae.png][]

大家都知道okhttp是一款由square公司开源的java版本http客户端工具。实际上，square公司还开源了基于okhttp进一步封装的retrofit工具，用来支持通过接口的方式发起http请求。

如果你的项目中还在直接使用RestTemplate或者okhttp，或者基于它们封装的HttpUtils，那么你可以尝试使用Retrofit。

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

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

> https://github.com/LianjiaTech/retrofit-spring-boot-starter

### 引入依赖 ###

<dependency>
        <groupId>com.github.lianjiatech</groupId>
        <artifactId>retrofit-spring-boot-starter</artifactId>
        <version>2.0.2</version>
    </dependency>

### 配置@RetrofitScan注解 ###

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

@SpringBootApplication
    @RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
    public class RetrofitTestApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(RetrofitTestApplication.class, args);
        }
    }

### 定义http接口 ###

接口必须使用@RetrofitClient注解标记！推荐：[一百期面试题汇总][Link 1]

http相关注解可参考官方文档：

> https://square.github.io/retrofit/

@RetrofitClient(baseUrl = "${test.baseUrl}")
    public interface HttpApi {
    
        @GET("person")
        Result<Person> getPerson(@Query("id") Long id);
    }

### 注入使用 ###

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

@Service
    public class TestService {
    
        @Autowired
        private HttpApi httpApi;
    
        public void test() {
            // 通过httpApi发起http请求
        }
    }

只要通过上述几个步骤，就能实现通过接口发送http请求了，真的很简单。如果你在spring-boot项目里面使用过mybatis，相信你对这种使用方式会更加熟悉。

接下来我们继续介绍一下`retrofit-spring-boot-starter`更高级一点的功能。

### 注解式拦截器 ###

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

*  继承BasePathMatchInterceptor编写拦截处理器；
 *  接口上使用@Intercept进行标注。

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

#### 继承BasePathMatchInterceptor编写拦截处理器 ####

@Component
    public class TimeStampInterceptor extends BasePathMatchInterceptor {
    
        @Override
        public Response doIntercept(Chain chain) throws IOException {
            Request request = chain.request();
            HttpUrl url = request.url();
            long timestamp = System.currentTimeMillis();
            HttpUrl newUrl = url.newBuilder()
                    .addQueryParameter("timestamp", String.valueOf(timestamp))
                    .build();
            Request newRequest = request.newBuilder()
                    .url(newUrl)
                    .build();
            return chain.proceed(newRequest);
        }
    }

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

@RetrofitClient(baseUrl = "${test.baseUrl}")
    @Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude = "/api/test/savePerson")
    public interface HttpApi {
    
        @GET("person")
        Result<Person> getPerson(@Query("id") Long id);
    
        @POST("savePerson")
        Result<Person> savePerson(@Body Person person);
    }

上面的@Intercept配置表示：拦截HttpApi接口下`/api/**`路径下（排除/api/test/savePerson）的请求，拦截处理器使用TimeStampInterceptor。推荐：[一百期面试题汇总][Link 1]

### 扩展注解式拦截器 ###

有的时候，我们需要在拦截注解动态传入一些参数，然后再执行拦截的时候需要使用这个参数。这种时候，我们可以扩展实现自定义拦截注解。

自定义拦截注解必须使用@InterceptMark标记，并且注解中必须包括include()、exclude()、handler()属性信息。使用的步骤主要分为3步：

*  自定义拦截注解
 *  继承BasePathMatchInterceptor编写拦截处理器
 *  接口上使用自定义拦截注解；

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

搜索公众号顶级架构师后台回复“手册”，获取一份惊喜礼包。

#### 自定义@Sign注解 ####

@Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    @InterceptMark
    public @interface Sign {
        /**
         * 密钥key
         * 支持占位符形式配置。
         *
         * @return
         */
        String accessKeyId();
    
        /**
         * 密钥
         * 支持占位符形式配置。
         *
         * @return
         */
        String accessKeySecret();
    
        /**
         * 拦截器匹配路径
         *
         * @return
         */
        String[] include() default {"/**"};
    
        /**
         * 拦截器排除匹配，排除指定路径拦截
         *
         * @return
         */
        String[] exclude() default {};
    
        /**
         * 处理该注解的拦截器类
         * 优先从spring容器获取对应的Bean，如果获取不到，则使用反射创建一个！
         *
         * @return
         */
        Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
    }

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

*  自定义拦截注解必须使用@InterceptMark标记。
 *  注解中必须包括include()、exclude()、handler()属性信息。

#### 实现SignInterceptor ####

@Component
    public class SignInterceptor extends BasePathMatchInterceptor {
    
        private String accessKeyId;
    
        private String accessKeySecret;
    
        public void setAccessKeyId(String accessKeyId) {
            this.accessKeyId = accessKeyId;
        }
    
        public void setAccessKeySecret(String accessKeySecret) {
            this.accessKeySecret = accessKeySecret;
        }
    
        @Override
        public Response doIntercept(Chain chain) throws IOException {
            Request request = chain.request();
            Request newReq = request.newBuilder()
                    .addHeader("accessKeyId", accessKeyId)
                    .addHeader("accessKeySecret", accessKeySecret)
                    .build();
            return chain.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"})
    public interface HttpApi {
    
        @GET("person")
        Result<Person> getPerson(@Query("id") Long id);
    
        @POST("savePerson")
        Result<Person> savePerson(@Body Person person);
    }

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

### 连接池管理 ###

默认情况下，所有通过Retrofit发送的http请求都会使用`max-idle-connections=5 keep-alive-second=300`的默认连接池。

当然，我们也可以在配置文件中配置多个自定义的连接池，然后通过@RetrofitClient的poolName属性来指定使用。比如我们要让某个接口下的请求全部使用poolName=test1的连接池，代码实现如下：

#### 1.配置连接池。 ####

retrofit:
        # 连接池配置
        pool:
            test1:
            max-idle-connections: 3
            keep-alive-second: 100
            test2:
            max-idle-connections: 5
            keep-alive-second: 50

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

@RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")
    public interface HttpApi {
    
        @GET("person")
        Result<Person> getPerson(@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<T>
         * 不执行适配处理，直接返回Call<T>对象
         * @param id
         * @return
         */
        @GET("person")
        Call<Result<Person>> getPersonCall(@Query("id") Long id);
    
        /**
         *  CompletableFuture<T>
         *  将响应体内容适配成CompletableFuture<T>对象返回
         * @param id
         * @return
         */
        @GET("person")
        CompletableFuture<Result<Person>> getPersonCompletableFuture(@Query("id") Long id);
    
        /**
         * Void
         * 不关注返回类型可以使用Void。如果http状态码不是2xx，直接抛错！
         * @param id
         * @return
         */
        @GET("person")
        Void getPersonVoid(@Query("id") Long id);
    
        /**
         *  Response<T>
         *  将响应内容适配成Response<T>对象返回
         * @param id
         * @return
         */
        @GET("person")
        Response<Result<Person>> getPersonResponse(@Query("id") Long id);
    
        /**
         * 其他任意Java类型
         * 将响应体内容适配成一个对应的Java类型对象返回，如果http状态码不是2xx，直接抛错！
         * @param id
         * @return
         */
        @GET("person")
        Result<Person> getPerson(@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
    public class SourceInterceptor extends BaseGlobalInterceptor {
        @Override
        public Response doIntercept(Chain chain) throws IOException {
            Request request = chain.request();
            Request newReq = request.newBuilder()
                    .addHeader("source", "test")
                    .build();
            return chain.proceed(newReq);
        }
    }

### 结语 ###

至此，spring-boot项目下最优雅的http客户端工具介绍就结束了，更多详细信息可以参考官方文档：retrofit以及retrofit-spring-boot-starter。

> https://github.com/LianjiaTech/retrofit-spring-boot-starter

往期推荐

[数据库消耗 CPU 最高的 sql 语句如何定位？][CPU _ sql]

[怎么样通过Nginx实现限流？][Nginx]

[5个好用的开源网络监控工具][5]

[SpringBoot实现登录拦截的原理][SpringBoot]

[keepalived实现Nginx双机热备][keepalived_Nginx]

[一行代码让你摆脱U盘完成局域网文件传输][U]

[Docker简易搭建 ElasticSearch 集群][Docker_ ElasticSearch]

[我把跨境当副业，一个星期赚了7000块”：想给有梦想的人提个醒！！！][7000]

[这个基于jedis的Redis工具类可以收藏一下][jedis_Redis]

[ZooKeeper实现分布式队列、分布式锁和选举，很详细][ZooKeeper]

[从原则、方案、策略及难点阐述分库分表][Link 2]

[Spring SchedulingConfigurer 实现动态定时任务][Spring SchedulingConfigurer]

[(建议收藏)服务器宕机了不要慌，这样排查效率高][Link 3]

![8cfae156cc3336dc47c6b47cab0943a8.png][]

[9c084f7f7d72bf5e343e51da89e9d4ae.png]: /images/20220829/a7c8febdb96549e8bb1560818fe752e8.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzIyNDU2ODA4OQ%3D%3D&chksm=e80db202df7a3b14fe7077b0fe5ec4de4088ce96a2cde16cbac21214956bd6f2e8f51193ee2b&idx=1&mid=2247484532&scene=21&sn=1c243934507d79db4f76de8ed0e5727f#wechat_redirect
[CPU _ sql]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44efaecb3366b81ed2f753608b1a1d36191643e727b5662228139dc1da831261e182b7d1b7&idx=2&mid=2247490199&scene=21&sn=ffd2237ecc6ea306cf8fa0d6d21b1ed0#wechat_redirect
[Nginx]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44efb6cb3366a0196d6a8a15935598596fe1429286e9ebe402a76cfdfd8e9ee7c7afd0479b&idx=1&mid=2247490191&scene=21&sn=cf9e2c7e787ff649fabc73a099ba867d#wechat_redirect
[5]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44efb6cb3366a03f989ee57eaca66fe09eba65954926469554efcadb264e3b5a36f49d49a8&idx=2&mid=2247490191&scene=21&sn=d93b68eef5d14609210368f05fe35da9#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44efb8cb3366ae130246b08e6bc6cccb847f641fed9afd7dfc9907240161c628865a7b0f42&idx=1&mid=2247490177&scene=21&sn=3ee25fb0bd5964d7fec8384c4426f11c#wechat_redirect
[keepalived_Nginx]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4ecb336658cadbc79d1a7d08db1c523e4badc04fd6c04cb4e8a0d33206a436581f01bc&idx=1&mid=2247490167&scene=21&sn=6e45804ba5db31a876ad0477dba33ab3#wechat_redirect
[U]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4ecb336658f827b4e492f2d4d3db4cc2ea6d936ac2e93e0e61dfc7362c576f37a17af4&idx=2&mid=2247490167&scene=21&sn=ce298a0d23b75c736d8780d50afc926d#wechat_redirect
[Docker_ ElasticSearch]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4fcb3366596390e361b10db1b6616d405df719cb3b259805629d75601ba03475212cd6&idx=1&mid=2247490166&scene=21&sn=5eb8eed5d0a6cd5c59d00aae41ad0039#wechat_redirect
[7000]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4fcb336659b1c864d0c9255b16e0c2eb4aaf7a30854462a7dd238892aa93b11040e767&idx=2&mid=2247490166&scene=21&sn=519f78fa7501840cdf6de96a0dec4564#wechat_redirect
[jedis_Redis]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef54cb336642fc5ffb45160a552fd6deaf7cef8039251c3962abfc74dccfc721fc97f799&idx=1&mid=2247490157&scene=21&sn=bcb84fb6107ce1a05912da335122700b#wechat_redirect
[ZooKeeper]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef55cb3366433da40ddcd71fa7f61a60df9902c152a77dc661d9166957a20393d9fdbcc5&idx=1&mid=2247490156&scene=21&sn=fe02fa5db8eafe9468cf5ad63f0d9b3e#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef67cb336671c174f6fb2d258f0dc3df395e9ba991bb60740b99ab9aa2af4e03a4eb55d1&idx=1&mid=2247490142&scene=21&sn=424a472c4642ee01a3302fab53f1972a#wechat_redirect
[Spring SchedulingConfigurer]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef66cb33667087272c87b07ccb700b48782af0b82ab9df8c93be1a08bb8b0fa5444c1c2f&idx=1&mid=2247490143&scene=21&sn=3608b976ef47aaa572f7872fc76c6954#wechat_redirect
[Link 3]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef65cb336673784019227c2c2a5ffaef2f35c40f5ea6e5e0a58b22a891cdeffbfa4cc713&idx=1&mid=2247490140&scene=21&sn=a781c5208f37ddaa4999755f98143f72#wechat_redirect
[8cfae156cc3336dc47c6b47cab0943a8.png]: /images/20220829/c5e77bd1a4934435a2538a4f1e019fd5.png