Spring Boot 中的 RestTemplate不好用？试试 Retrofit ！

2401_84010702

于 2024-04-18 04:38:25 发布

阅读量834

点赞数 25

本文链接：https://blog.csdn.net/2401_84010702/article/details/137898933

版权

程序员专栏收录该内容

237 篇文章 0 订阅

订阅专栏

}

接口上使用@Intercept进行标注

@RetrofitClient(baseUrl = “${test.baseUrl}”)

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

public interface HttpApi {

@GET(“person”)

Result getPerson(@Query(“id”) Long id);

@POST(“savePerson”)

Result savePerson(@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 @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方法。Java知音公众号内回复“后端面试”，送你一份Java面试题宝典

接口上使用@Sign

@RetrofitClient(baseUrl = “${test.baseUrl}”)

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

public interface HttpApi {

@GET(“person”)

Result getPerson(@Query(“id”) Long id);

@POST(“savePerson”)

Result 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 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进行请求数据格式化。Java知音公众号内回复“后端面试”，送你一份Java面试题宝典

你也可以进行自定义，只需要继承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对象

* @param id

* @return

@GET(“person”)

Call<Result> getPersonCall(@Query(“id”) Long id);

/**

* CompletableFuture

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

* @param id

* @return

@GET(“person”)

CompletableFuture<Result> getPersonCompletableFuture(@Query(“id”) Long id);

/**

* Void

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

* @param id

* @return

@GET(“person”)

Void getPersonVoid(@Query(“id”) Long id);

/**

* Response

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

* @param id

* @return

@GET(“person”)

Response<Result> getPersonResponse(@Query(“id”) Long id);

/**

* 其他任意Java类型

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

* @param id

* @return

@GET(“person”)

Result 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

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

总结

我个人认为，如果你想靠着背面试题来获得心仪的offer，用癞蛤蟆想吃天鹅肉形容完全不过分。想必大家能感受到面试越来越难，想找到心仪的工作也是越来越难，高薪工作羡慕不来，却又对自己目前的薪资不太满意，工作几年甚至连一个应届生的薪资都比不上，终究是错付了，错付了自己没有去提升技术。

这些面试题分享给大家的目的，其实是希望大家通过大厂面试题分析自己的技术栈，给自己梳理一个更加明确的学习方向，当你准备好去面试大厂，你心里有底，大概知道面试官会问多广，多深，避免面试的时候一问三不知。

大家可以把Java基础，JVM，并发编程，MySQL，Redis，Spring，Spring cloud等等做一个知识总结以及延伸，再去进行操作，不然光记是学不会的，这里我也提供一些脑图分享给大家：

希望你看完这篇文章后，不要犹豫，抓紧学习，复习知识，准备在明年的金三银四拿到心仪的offer，加油，打工人！
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
alt=“img” style=“zoom: 33%;” />

总结

[外链图片转存中…(img-CBZ9Nej3-1713386293217)]

[外链图片转存中…(img-UPJ6nsCq-1713386293218)]

[外链图片转存中…(img-VIqV1wtq-1713386293218)]

希望你看完这篇文章后，不要犹豫，抓紧学习，复习知识，准备在明年的金三银四拿到心仪的offer，加油，打工人！
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

2401_84010702

关注

25
点赞
踩
13

收藏

觉得还不错? 一键收藏
0
评论
Spring Boot 中的 RestTemplate不好用？试试 Retrofit ！

*** 密钥key* 支持占位符形式配置。* @return*//*** 密钥* 支持占位符形式配置。* @return*//*** 拦截器匹配路径* @return*//*** 拦截器排除匹配，排除指定路径拦截* @return*//*** 处理该注解的拦截器类* 优先从spring容器获取对应的Bean，如果获取不到，则使用反射创建一个！
复制链接

扫一扫