关于java:还在用HttpUtil试试这款优雅的HTTP客户端工具吧跟SpringBoot绝配

咱们平时开发我的项目时，就算是单体利用，也免不了要调用一下其余服务提供的接口。此时就会用到 HTTP 客户端工具，之前始终应用的是 Hutool 中的 HttpUtil，尽管容易上手，但用起来颇为麻烦！最近发现一款更好用的 HTTP 客户端工具Retrofit，你只需申明接口就可发动 HTTP 申请，无需进行连贯、后果解析之类的反复操作，用起来够优雅，举荐给大家！

SpringBoot 实战电商我的项目 mall（50k+star）地址：https://github.com/macrozheng/mall

简介

Retrofit 是实用于 Android 和Java且类型平安的 HTTP 客户端工具，在 Github 上曾经有39k+Star。其最大的个性的是反对通过接口的形式发动 HTTP 申请，相似于咱们用 Feign 调用微服务接口的那种形式。

SpringBoot 是应用最宽泛的 Java 开发框架，然而 Retrofit 官网并没有提供专门的 Starter。于是有位老哥就开发了retrofit-spring-boot-starter，它实现了 Retrofit 与 SpringBoot 框架的疾速整合，并且反对了诸多性能加强，极大简化开发。明天咱们将应用这个第三方 Starter 来操作 Retrofit。

应用

在 SpringBoot 中应用 Retrofit 是非常简单的，上面咱们就来体验下。

依赖集成

有了第三方 Starter 的反对，集成 Retrofit 仅需一步，增加如下依赖即可。

<!--Retrofit 依赖 -->
<dependency>
    <groupId>com.github.lianjiatech</groupId>
    <artifactId>retrofit-spring-boot-starter</artifactId>
    <version>2.2.18</version>
</dependency>

根本应用

上面以调用 mall-tiny-swagger 中的接口为例，咱们来体验下 Retrofit 的根本应用。

• 首先咱们筹备一个服务来不便近程调用，应用的是之前的 mall-tiny-swagger 这个 Demo，关上 Swagger 看下，外面有一个登录接口和须要登录认证的商品品牌 CRUD 接口，我的项目地址：https://github.com/macrozheng…

• 咱们先来调用下登录接口试试，在 application.yml 中配置好 mall-tiny-swagger 的服务地址；

remote:
  baseUrl: http://localhost:8088/

• 再通过 @RetrofitClient 申明一个 Retrofit 客户端，因为登录接口是通过 POST 表单模式调用的，这里应用到了 @POST 和@FormUrlEncoded注解；

/**
 * 定义 Http 接口，用于调用近程的 UmsAdmin 服务
 * Created by macro on 2022/1/19.
 */
@RetrofitClient(baseUrl = "${remote.baseUrl}")
public interface UmsAdminApi {

    @FormUrlEncoded
    @POST("admin/login")
    CommonResult<LoginInfo> login(@Field("username") String username, @Field("password") String password);
}

• 如果你不太明确这些注解是干嘛的，看下上面的表根本就懂了，更具体的话能够参考 Retrofit 官网文档；

• 接下来在 Controller 中注入UmsAdminApi，而后进行调用即可；

/**
 * Retrofit 测试接口
 * Created by macro on 2022/1/19.
 */
@Api(tags = "RetrofitController", description = "Retrofit 测试接口")
@RestController
@RequestMapping("/retrofit")
public class RetrofitController {

    @Autowired
    private UmsAdminApi umsAdminApi;
    @Autowired
    private TokenHolder tokenHolder;

    @ApiOperation(value = "调用近程登录接口获取 token")
    @PostMapping(value = "/admin/login")
    public CommonResult<LoginInfo> login(@RequestParam String username, @RequestParam String password) {CommonResult<LoginInfo> result = umsAdminApi.login(username, password);
        LoginInfo loginInfo = result.getData();
        if (result.getData() != null) {tokenHolder.putToken(loginInfo.getTokenHead() + " " + loginInfo.getToken());
        }
        return result;
    }
}

• 为不便后续调用须要登录认证的接口，我创立了 TokenHolder 这个类，把 token 存储到了 Session 中；

/**
 * 登录 token 存储（在 Session 中）* Created by macro on 2022/1/19.
 */
@Component
public class TokenHolder {
    /**
     * 增加 token
     */
    public void putToken(String token) {RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes) ra).getRequest();
        request.getSession().setAttribute("token", token);
    }

    /**
     * 获取 token
     */
    public String getToken() {RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes) ra).getRequest();
        Object token = request.getSession().getAttribute("token");
        if(token!=null){return (String) token;
        }
        return null;
    }

}

• 接下来通过 Swagger 进行测试，调用接口就能够获取到近程服务返回的 token 了，拜访地址：http://localhost:8086/swagger…

注解式拦截器

商品品牌治理接口，须要增加登录认证头才能够失常拜访，咱们能够应用 Retrofit 中的注解式拦截器来实现。

• 首先创立一个注解式拦截器 TokenInterceptor 继承 BasePathMatchInterceptor，而后在doIntercept 办法中给申请增加 Authorization 头；

/**
 * 给申请增加登录 Token 头的拦截器
 * Created by macro on 2022/1/19.
 */
@Component
public class TokenInterceptor extends BasePathMatchInterceptor {
    @Autowired
    private TokenHolder tokenHolder;

    @Override
    protected Response doIntercept(Chain chain) throws IOException {Request request = chain.request();
        if (tokenHolder.getToken() != null) {request = request.newBuilder()
                    .header("Authorization", tokenHolder.getToken())
                    .build();}
        return chain.proceed(request);
    }
}

• 创立调用品牌治理接口的客户端 PmsBrandApi，应用@Intercept 注解配置拦截器和拦挡门路；

/**
 * 定义 Http 接口，用于调用近程的 PmsBrand 服务
 * Created by macro on 2022/1/19.
 */
@RetrofitClient(baseUrl = "${remote.baseUrl}")
@Intercept(handler = TokenInterceptor.class, include = "/brand/**")
public interface PmsBrandApi {@GET("brand/list")
    CommonResult<CommonPage<PmsBrand>> list(@Query("pageNum") Integer pageNum, @Query("pageSize") Integer pageSize);

    @GET("brand/{id}")
    CommonResult<PmsBrand> detail(@Path("id") Long id);

    @POST("brand/create")
    CommonResult create(@Body PmsBrand pmsBrand);

    @POST("brand/update/{id}")
    CommonResult update(@Path("id") Long id, @Body PmsBrand pmsBrand);

    @GET("brand/delete/{id}")
    CommonResult delete(@Path("id") Long id);
}

• 再在 Controller 中注入 PmsBrandApi 实例，并增加办法调用近程服务即可；

/**
 * Retrofit 测试接口
 * Created by macro on 2022/1/19.
 */
@Api(tags = "RetrofitController", description = "Retrofit 测试接口")
@RestController
@RequestMapping("/retrofit")
public class RetrofitController {
    
    @Autowired
    private PmsBrandApi pmsBrandApi;

    @ApiOperation("调用近程接口分页查问品牌列表")
    @GetMapping(value = "/brand/list")
    public CommonResult<CommonPage<PmsBrand>> listBrand(@RequestParam(value = "pageNum", defaultValue = "1")
                                                        @ApiParam("页码") Integer pageNum,
                                                        @RequestParam(value = "pageSize", defaultValue = "3")
                                                        @ApiParam("每页数量") Integer pageSize) {return pmsBrandApi.list(pageNum, pageSize);
    }

    @ApiOperation("调用近程接口获取指定 id 的品牌详情")
    @GetMapping(value = "/brand/{id}")
    public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) {return pmsBrandApi.detail(id);
    }

    @ApiOperation("调用近程接口增加品牌")
    @PostMapping(value = "/brand/create")
    public CommonResult createBrand(@RequestBody PmsBrand pmsBrand) {return pmsBrandApi.create(pmsBrand);
    }
    @ApiOperation("调用近程接口更新指定 id 品牌信息")
    @PostMapping(value = "/brand/update/{id}")
    public CommonResult updateBrand(@PathVariable("id") Long id, @RequestBody PmsBrand pmsBrand) {return pmsBrandApi.update(id,pmsBrand);
    }

    @ApiOperation("调用近程接口删除指定 id 的品牌")
    @GetMapping(value = "/delete/{id}")
    public CommonResult deleteBrand(@PathVariable("id") Long id) {return  pmsBrandApi.delete(id);
    }
}

• 在 Swagger 中调用接口进行测试，发现曾经能够胜利调用。

全局拦截器

如果你想给所有申请都加个申请头的话，能够应用全局拦截器。

创立 SourceInterceptor 类继承 BaseGlobalInterceptor 接口，而后在 Header 中增加 source 申请头。

/**
 * 全局拦截器，给申请增加 source 头
 * Created by macro on 2022/1/19.
 */
@Component
public class SourceInterceptor extends BaseGlobalInterceptor {
    @Override
    protected Response doIntercept(Chain chain) throws IOException {Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("source", "retrofit")
                .build();
        return chain.proceed(newReq);
    }
}

配置

Retrofit 的配置很多，上面咱们讲讲日志打印、全局超时工夫和全局申请重试这三种最罕用的配置。

日志打印

• 默认配置下 Retrofit 应用 basic 日志策略，打印的日志非常简单；

• 咱们能够将 application.yml 中的 retrofit.global-log-strategy 属性批改为 body 来打印最全日志；

retrofit:
  # 日志打印配置
  log:
    # 启用日志打印
    enable: true
    # 日志打印拦截器
    logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
    # 全局日志打印级别
    global-log-level: info
    # 全局日志打印策略
    global-log-strategy: body

• 批改日志打印策略后，日志信息更全面了；

• Retrofit 反对四种日志打印策略；

  • NONE：不打印日志；
  • BASIC：只打印日志申请记录；
  • HEADERS：打印日志申请记录、申请和响应头信息；
  • BODY：打印日志申请记录、申请和响应头信息、申请和响应体信息。

全局超时工夫

有时候咱们须要批改一下 Retrofit 的申请超时工夫，能够通过如下配置实现。

retrofit:
  # 全局连贯超时工夫
  global-connect-timeout-ms: 3000
  # 全局读取超时工夫
  global-read-timeout-ms: 3000
  # 全局写入超时工夫
  global-write-timeout-ms: 35000
  # 全局残缺调用超时工夫
  global-call-timeout-ms: 0

全局申请重试

• retrofit-spring-boot-starter反对申请重试，能够通过如下配置实现。

retrofit:
  # 重试配置
  retry:
    # 是否启用全局重试
    enable-global-retry: true
    # 全局重试间隔时间
    global-interval-ms: 100
    # 全局最大重试次数
    global-max-retries: 2
    # 全局重试规定
    global-retry-rules:
      - response_status_not_2xx
      - occur_exception
    # 重试拦截器
    retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor

• 重试规定 global-retry-rules 反对如下三种配置。

  • RESPONSE_STATUS_NOT_2XX：响应状态码不是 2xx 时执行重试；
  • OCCUR_IO_EXCEPTION：产生 IO 异样时执行重试；
  • OCCUR_EXCEPTION：产生任意异样时执行重试。

总结

明天体验了一把 Retrofit，比照应用 HttpUtil，的确优雅不少！通过接口发动 HTTP 申请已不再是 Feign 的专属，通过 Retrofit 咱们在单体利用中照样能够应用这种形式。当然 retrofit-spring-boot-starter 提供的性能远不止于此，它还能反对微服务间的调用和熔断降级，感兴趣的敌人能够钻研下！

参考资料

官网文档：https://github.com/LianjiaTec…

我的项目源码地址

https://github.com/macrozheng…

本文 GitHub https://github.com/macrozheng/mall-learning 曾经收录，欢送大家 Star！