spring-boot项目整合Retrofit最佳实践,最优雅的HTTP客户端工具!

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

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

retrofit 官方并没有提供与 spring-boot 快速整合的 starterretrofit-spring-boot-starter 是笔者封装的,已在生产环境使用,非常稳定。 造轮子不易,跪求各位大佬star

项目源码: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 注解标记 !http相关注解可参考官方文档: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步:

  1. 继承 BasePathMatchInterceptor 编写拦截处理器;
  2. 接口上使用 @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

扩展注解式拦截器

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

  1. 自定义拦截注解
  2. 继承 BasePathMatchInterceptor 编写拦截处理器
  3. 接口上使用自定义拦截注解;

例如我们需要 在请求头里面动态加入 accessKeyIdaccessKeySecret 签名信息才能正常发起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点需要注意:

  1. 自定义拦截注解 必须使用 @InterceptMark 标记。
  2. 注解中必须包括 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);
    }
}

上述 accessKeyIdaccessKeySecret 字段值会依据 @Sign 注解的 accessKeyId()accessKeySecret() 值自动注入,如果 @Sign 指定的是占位符形式的字符串,则会取配置属性值进行注入 。另外, accessKeyIdaccessKeySecret 字段必须提供 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 的默认连接池。当然,我们也可以在配置文件中配置多个自定义的连接池,然后通过 @RetrofitClientpoolName 属性来指定使用。比如我们要让某个接口下的请求全部使用 poolName=test1 的连接池,代码实现如下:

  1. 配置连接池。
retrofit:
    # 连接池配置
    pool:
        test1:
        max-idle-connections: 3
        keep-alive-second: 100
        test2:
        max-idle-connections: 5
        keep-alive-second: 50
  1. 通过 @RetrofitClientpoolName 属性来指定使用的连接池。
@RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);
}

日志打印

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

  1. NONE :No logs.
  2. BASIC :Logs request and response lines.
  3. HEADERS :Logs request and response lines and their respective headers.
  4. 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 可以通过调用适配器 CallAdapterFactoryCall<T> 对象适配成接口方法的返回值类型。 retrofit-spring-boot-starter 扩展2种 CallAdapterFactory 实现:

  1. BodyCallAdapterFactory
  • 默认启用,可通过配置 retrofit.enable-body-call-adapter=false 关闭
  • 同步执行http请求,将响应体内容适配成接口方法的返回值类型实例。
  • 除了 Retrofit.Call<T>Retrofit.Response<T>java.util.concurrent.CompletableFuture<T> 之外,其它返回类型都可以使用该适配器。
  1. 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 配置成 springbean

自定义配置的 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 配置成 springbean

自定义配置的 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。实现原理解读可查看基于Retrofit实现自己的轻量级http调用工具


作者:六点半起床
原文:https://juejin.im/post/6854573211426750472