SpringBoot中如何使用HTTP客戶端工具Retrofit-java教程-PHP中文網

簡介

Retrofit是適用於Android和Java且型別安全的HTTP用戶端工具，在Github上已經有39k Star。其最大的特性的是支援透過介面的方式發起HTTP請求，類似我們用Feign呼叫微服務介面的那種方式。

SpringBoot中如何使用HTTP客戶端工具Retrofit

SpringBoot是使用最廣泛的Java開發框架，但Retrofit官方並沒有提供專門的Starter。於是有位老哥就開發了retrofit-spring-boot-starter，它實現了Retrofit與SpringBoot框架的快速整合，並且支持了諸多功能增強，極大簡化開發。今天我們將使用這個第三方Starter來操作Retrofit。

SpringBoot中如何使用HTTP客戶端工具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接口，

SpringBoot中如何使用HTTP客戶端工具Retrofit

我們先來調用下登入接口試試，在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官方文件；

SpringBoot中如何使用HTTP客戶端工具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-ui/

SpringBoot中如何使用HTTP客戶端工具Retrofit

#註解式攔截器

商品品牌管理接口，需要新增登入認證頭才可以正常訪問，我們可以使用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中呼叫介面進行測試，發現已經可以成功呼叫。

SpringBoot中如何使用HTTP客戶端工具Retrofit

全域攔截器

如果你想給所有請求都加個請求頭的話，可以使用全域攔截器。

建立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日誌策略，列印的日誌非常簡單；

SpringBoot中如何使用HTTP客戶端工具Retrofit

我們可以將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

登入後複製

#修改日誌列印策略後，日誌資訊更全面了；

SpringBoot中如何使用HTTP客戶端工具Retrofit

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支持如下三种配置。