我终于决定要放弃 okhttp、httpClient，选择了这个牛逼的神仙工具！贼爽

程序员的成长之路

互联网/程序员/技术/资料共享 

前言

功能特性

• 自定义注入OkHttpClient
• 注解式拦截器
• 连接池管理
• 日志打印
• 请求重试
• 错误解码器
• 全局拦截器
• 熔断降级
• 微服务之间的HTTP调用
• 调用适配器
• 数据转换器

快速使用

引入依赖

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

注入使用

retrofit:  enable-response-call-adapter: true  # 启用日志打印  enable-log: true  # 连接池配置  pool:    test1:      max-idle-connections: 3      keep-alive-second: 100    test2:      max-idle-connections: 5      keep-alive-second: 50  # 禁用void返回值类型  disable-void-return-type: false  # 日志打印拦截器  logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor  # 请求重试拦截器  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor  # 全局转换器工厂  global-converter-factories:    - retrofit2.converter.jackson.JacksonConverterFactory  # 全局调用适配器工厂  global-call-adapter-factories:    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory  # 是否启用熔断降级  enable-degrade: true  # 熔断降级实现方式  degrade-type: sentinel  # 熔断资源名称解析器  resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser

高级功能

自定义注入OkHttpClient

@Componentpublic 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进行标注

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

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

实现SignInterceptor

@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);}

连接池管理

1. 配置连接池。

   @RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")   public interface HttpApi {          @GET("person")       Result getPerson(@Query("id") Long id);   }

日志打印

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:  # 请求重试拦截器  retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor

错误解码器

@Componentpublic 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);    }}

全局网络拦截器

熔断降级

1. 开启熔断降级功能

<dependency>    <groupId>com.alibaba.cspgroupId>    <artifactId>sentinel-coreartifactId>    <version>1.6.3version>dependency>

2. 配置降级规则（可选）

@Slf4j@Servicepublic class HttpDegradeFallback implements HttpDegradeApi {
    @Override    public Result test() {        Result fallback = new Result<>();        fallback.setCode(100)                .setMsg("fallback")                .setBody(1000000);        return fallback;    }}@Slf4j@Servicepublic class HttpDegradeFallbackFactory implements FallbackFactory<HttpDegradeApi> {
    /**     * Returns an instance of the fallback appropriate for the given cause     *     * @param cause fallback cause     * @return 实现了retrofit接口的实例。an instance that implements the retrofit interface.     */    @Override    public HttpDegradeApi create(Throwable cause) {        log.error("触发熔断了! ", cause.getMessage(), cause);        return new HttpDegradeApi() {            @Override            public Result test() {                Result fallback = new Result<>();                fallback.setCode(100)                        .setMsg("fallback")                        .setBody(1000000);                return fallback;            }    }}

微服务之间的HTTP调用

配置ServiceInstanceChooser为Spring容器Bean

@RetrofitClient(serviceId = "${jy-helicarrier-api.serviceId}", path = "/m/count", errorDecoder = HelicarrierErrorDecoder.class)@Retrypublic interface ApiCountService {
}

调用适配器和数据转码器

调用适配器

 ResponseCallAdapterFactory

• 默认启用，可通过配置 retrofit.enable-response-call-adapter=false关闭
• 同步执行http请求，将响应体内容适配成 Retrofit.Response返回。
• 如果方法的返回值类型为 Retrofit.Response，则可以使用该适配器。

• Call: 不执行适配处理，直接返回 Call对象
• CompletableFuture: 将响应体内容适配成 CompletableFuture对象返回
• Void: 不关注返回类型可以使用 Void。如果http状态码不是2xx，直接抛错！
• Response: 将响应内容适配成 Response对象返回
• 其他任意Java类型：将响应体内容适配成一个对应的Java类型对象返回，如果http状态码不是2xx，直接抛错！
  
  

retrofit:  # 全局调用适配器工厂  global-call-adapter-factories:    - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory    - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory复制代码

数据转码器

• 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
• JAXB: com.squareup.retrofit2:converter-jaxb

retrofit:  # 全局转换器工厂  global-converter-factories:    - retrofit2.converter.jackson.JacksonConverterFactory

总结

推荐阅读：

干掉 RESTful API ！

IDEA 上位？不！Eclipse Theia 1.0 发布！

微信扫描二维码，关注我的公众号

朕已阅