diff --git a/README_ZN.md b/README_ZN.md new file mode 100644 index 0000000..eb1612c --- /dev/null +++ b/README_ZN.md @@ -0,0 +1,905 @@ +## retrofit-spring-boot-starter + +[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) +[![Build Status](https://api.travis-ci.com/LianjiaTech/retrofit-spring-boot-starter.svg?branch=master)](https://travis-ci.com/github/LianjiaTech/retrofit-spring-boot-starter) +[![Maven central](https://maven-badges.herokuapp.com/maven-central/com.github.lianjiatech/retrofit-spring-boot-starter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.lianjiatech/retrofit-spring-boot-starter) +[![GitHub release](https://img.shields.io/github/v/release/lianjiatech/retrofit-spring-boot-starter.svg)](https://github.com/LianjiaTech/retrofit-spring-boot-starter/releases) +[![License](https://img.shields.io/badge/JDK-1.8+-4EB1BA.svg)](https://docs.oracle.com/javase/8/docs/index.html) +[![License](https://img.shields.io/badge/SpringBoot-1.5+-green.svg)](https://docs.spring.io/spring-boot/docs/2.1.5.RELEASE/reference/htmlsingle/) +[![Author](https://img.shields.io/badge/Author-chentianming-orange.svg?style=flat-square)](https://juejin.im/user/3562073404738584/posts) +[![QQ-Group](https://img.shields.io/badge/QQ%E7%BE%A4-806714302-orange.svg?style=flat-square) ](https://img.ljcdn.com/hc-picture/6302d742-ebc8-4649-95cf-62ccf57a1add) + +[English Document](https://github.com/LianjiaTech/retrofit-spring-boot-starter/blob/master/README_EN.md) + +`Retrofit`是适用于`Android`和`Java`且类型安全的HTTP客户端,其最大的特性的是**支持通过`接口`的方式发起HTTP请求**。而`spring-boot`是使用最广泛的Java开发框架,但是`Retrofit` +官方没有支持与`spring-boot`框架快速整合,因此我们开发了`retrofit-spring-boot-starter`。 + +**`retrofit-spring-boot-starter`实现了`Retrofit`与`spring-boot`框架快速整合,并且支持了诸多功能增强,极大简化开发**。 + +🚀项目持续优化迭代,欢迎大家提ISSUE和PR!麻烦大家能给一颗star✨,您的star是我们持续更新的动力! + +github项目地址:[https://github.com/LianjiaTech/retrofit-spring-boot-starter](https://github.com/LianjiaTech/retrofit-spring-boot-starter) + +gitee项目地址:[https://gitee.com/lianjiatech/retrofit-spring-boot-starter](https://gitee.com/lianjiatech/retrofit-spring-boot-starter) + +示例demo:[https://github.com/ismart-yuxi/retrofit-spring-boot-demo](https://github.com/ismart-yuxi/retrofit-spring-boot-demo) + +> 感谢`@ismart-yuxi`为本项目写的示例demo + + + +## 功能特性 + +- [x] [自定义注入OkHttpClient](#自定义注入OkHttpClient) +- [x] [注解式拦截器](#注解式拦截器) +- [x] [连接池管理](#连接池管理) +- [x] [日志打印](#日志打印) +- [x] [请求重试](#请求重试) +- [x] [错误解码器](#错误解码器) +- [x] [全局拦截器](#全局拦截器) +- [x] [熔断降级](#熔断降级) +- [x] [微服务之间的HTTP调用](#微服务之间的HTTP调用) +- [x] [调用适配器](#调用适配器) +- [x] [数据转换器](#数据转码器) + +## 快速使用 + +### 引入依赖 + +```xml + + + com.github.lianjiatech + retrofit-spring-boot-starter + 2.2.8 + +``` + +**本项目依赖Retrofit-2.9.0,okhttp-3.14.9,okio-1.17.5版本,如果冲突,烦请手动引入相关jar包**。完整依赖如下: + +```xml + + + com.github.lianjiatech + retrofit-spring-boot-starter + 2.2.8 + + +com.squareup.okhttp3 +logging-interceptor +3.14.9 + + +com.squareup.okhttp3 +okhttp +3.14.9 + + +com.squareup.okio +okio +1.17.5 + + +com.squareup.retrofit2 +retrofit +2.9.0 + + +com.squareup.retrofit2 +converter-jackson +2.9.0 + +``` + +### 定义http接口 + +**接口必须使用`@RetrofitClient`注解标记**!http相关注解可参考官方文档:[retrofit官方文档](https://square.github.io/retrofit/)。 + +```java + +@RetrofitClient(baseUrl = "${test.baseUrl}") +public interface HttpApi { + + @GET("person") + Result getPerson(@Query("id") Long id); +} +``` + +> 友情提示:**方法请求路径慎用`/`开头**。对于`Retrofit`而言,如果`baseUrl=http://localhost:8080/api/test/`,方法请求路径如果是`person`,则该方法完整的请求路径是:`http://localhost:8080/api/test/person`。而方法请求路径如果是`/person`,则该方法完整的请求路径是:`http://localhost:8080/person`。 + +### 注入使用 + +**将接口注入到其它Service中即可使用!** + +```java + +@Service +public class TestService { + + @Autowired + private HttpApi httpApi; + + public void test() { + // 通过httpApi发起http请求 + } +} +``` + +**默认情况下,自动使用`SpringBoot`扫描路径进行`retrofitClient`注册**。你也可以在配置类加上`@RetrofitScan`手工指定扫描路径。 + +## HTTP请求相关注解 + +`HTTP`请求相关注解,全部使用了`retrofit`原生注解。**详细信息可参考官方文档:[retrofit官方文档](https://square.github.io/retrofit/)**,以下是一个简单说明。 + +| 注解分类|支持的注解 | +|------------|-----------| +|请求方式|`@GET` `@HEAD` `@POST` `@PUT` `@DELETE` `@OPTIONS` `@HTTP`| +|请求头|`@Header` `@HeaderMap` `@Headers`| +|Query参数|`@Query` `@QueryMap` `@QueryName`| +|path参数|`@Path`| +|form-encoded参数|`@Field` `@FieldMap` `@FormUrlEncoded`| +| 请求体 |`@Body`| +|文件上传|`@Multipart` `@Part` `@PartMap`| +|url参数|`@Url`| + +## 配置项说明 + +`retrofit-spring-boot-starter` +支持了多个可配置的属性,用来应对不同的业务场景。详细信息可参考[配置项示例](https://github.com/LianjiaTech/retrofit-spring-boot-starter/blob/master/src/test/resources/application.yml)。 + +## 高级功能 + +### 自定义注入OkHttpClient + +通常情况下,通过`@RetrofitClient`注解属性动态创建`OkHttpClient`对象能够满足大部分使用场景。但是在某些情况下,用户可能需要自定义`OkHttpClient` +,这个时候,可以在接口上定义返回类型是`OkHttpClient.Builder`的静态方法来实现。代码示例如下: + +```java + +@RetrofitClient(baseUrl = "http://ke.com") +public interface HttpApi3 { + + @OkHttpClientBuilder + static OkHttpClient.Builder okhttpClientBuilder() { + return new OkHttpClient.Builder() + .connectTimeout(1, TimeUnit.SECONDS) + .readTimeout(1, TimeUnit.SECONDS) + .writeTimeout(1, TimeUnit.SECONDS); + + } + + @GET + Result getPerson(@Url String url, @Query("id") Long id); +} +``` + +> 方法必须使用`@OkHttpClientBuilder`注解标记! + +### 注解式拦截器 + +很多时候,我们希望某个接口下的某些http请求执行统一的拦截处理逻辑。为了支持这个功能,`retrofit-spring-boot-starter`提供了**注解式拦截器**,做到了**基于url路径的匹配拦截**。使用的步骤主要分为2步: + +1. 继承`BasePathMatchInterceptor`编写拦截处理器; +2. 接口上使用`@Intercept`进行标注。如需配置多个拦截器,在接口上标注多个`@Intercept`注解即可! + +下面以*给指定请求的url后面拼接timestamp时间戳*为例,介绍下如何使用注解式拦截器。 + +#### 继承`BasePathMatchInterceptor`编写拦截处理器 + +```java + +@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`进行标注 + +```java + +@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步: + +1. 自定义拦截注解 +2. 继承`BasePathMatchInterceptor`编写拦截处理器 +3. 接口上使用自定义拦截注解; + +例如我们需要**在请求头里面动态加入`accessKeyId`、`accessKeySecret`签名信息才能正常发起http请求**,这个时候**可以自定义一个加签拦截器注解`@Sign`来实现**。下面以自定义`@Sign` +拦截注解为例进行说明。 + +#### 自定义`@Sign`注解 + +```java + +@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 handler() default SignInterceptor.class; +} +``` + +扩展`自定义拦截注解`有以下2点需要注意: + +1. `自定义拦截注解`必须使用`@InterceptMark`标记。 +2. 注解中必须包括`include()、exclude()、handler()`属性信息。 + +#### 实现`SignInterceptor` + +```java + +@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`方法**。 + +#### 接口上使用`@Sign` + +```java + +@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. 配置连接池。 + + ```yaml + retrofit: + # 连接池配置 + pool: + # test1连接池配置 + test1: + # 最大空闲连接数 + max-idle-connections: 3 + # 连接保活时间(秒) + keep-alive-second: 100 + ``` + +2. 通过`@RetrofitClient`的`poolName`属性来指定使用的连接池。 + + ```java + @RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1") + public interface HttpApi { + + @GET("person") + Result getPerson(@Query("id") Long id); + } + ``` + +### 日志打印 + +很多情况下,我们希望将http请求日志记录下来。本框架支持以下全局日志打印配置: + +```yaml +retrofit: + # 日志打印配置 + log: + # 启用日志打印 + enable: true + # 日志打印拦截器 + logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor + # 全局日志打印级别 + global-log-level: info + # 全局日志打印策略 + global-log-strategy: body + +``` + +**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). + +针对每个接口,如果需要单独定制的话,可以设置`@RetrofitClient`的`enableLog`、`logLevel`和`logStrategy`。 + +### 请求重试 + +`retrofit-spring-boot-starter`支持支持全局重试和声明式重试。 + +#### 全局重试 + +全局重试默认开启,可以通过配置`retrofit.retry.enable-global-retry=false`关闭。开启之后,所有`HTTP`请求都会按照配置参数自动重试,详细配置项如下: + +```yaml +retrofit: + # 重试配置 + retry: + # 是否启用全局重试 + enable-global-retry: true + # 全局重试间隔时间 + global-interval-ms: 20 + # 全局最大重试次数 + global-max-retries: 10 + # 全局重试规则 + global-retry-rules: + - response_status_not_2xx + # 重试拦截器 + retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor +``` + +**重试规则支持三种配置**: + +1. `RESPONSE_STATUS_NOT_2XX`:响应状态码不是`2xx`时执行重试; +2. `OCCUR_IO_EXCEPTION`:发生IO异常时执行重试; +3. `OCCUR_EXCEPTION`:发生任意异常时执行重试; + +#### 声明式重试 + +如果只需要在指定某些请求才执行重试,可以使用声明式重试!具体就是在接口或者方法上声明`@Retry`注解。 + +### 错误解码器 + +在`HTTP`发生请求错误(包括发生异常或者响应数据不符合预期)的时候,错误解码器可将`HTTP`相关信息解码到自定义异常中。你可以在`@RetrofitClient`注解的`errorDecoder()` +指定当前接口的错误解码器,自定义错误解码器需要实现`ErrorDecoder`接口: + +```java +/** + * 错误解码器。ErrorDecoder. + * 当请求发生异常或者收到无效响应结果的时候,将HTTP相关信息解码到异常中,无效响应由业务自己判断 + * + * When an exception occurs in the request or an invalid response result is received, the HTTP related information is decoded into the exception, + * and the invalid response is determined by the business itself. + * + * @author 陈添明 + */ +public interface ErrorDecoder { + + /** + * 当无效响应的时候,将HTTP信息解码到异常中,无效响应由业务自行判断。 + * When the response is invalid, decode the HTTP information into the exception, invalid response is determined by business. + * + * @param request request + * @param response response + * @return If it returns null, the processing is ignored and the processing continues with the original response. + */ + default RuntimeException invalidRespDecode(Request request, Response response) { + if (!response.isSuccessful()) { + throw RetrofitException.errorStatus(request, response); + } + return null; + } + + + /** + * 当请求发生IO异常时,将HTTP信息解码到异常中。 + * When an IO exception occurs in the request, the HTTP information is decoded into the exception. + * + * @param request request + * @param cause IOException + * @return RuntimeException + */ + default RuntimeException ioExceptionDecode(Request request, IOException cause) { + return RetrofitException.errorExecuting(request, cause); + } + + /** + * 当请求发生除IO异常之外的其它异常时,将HTTP信息解码到异常中。 + * When the request has an exception other than the IO exception, the HTTP information is decoded into the exception. + * + * @param request request + * @param cause Exception + * @return RuntimeException + */ + default RuntimeException exceptionDecode(Request request, Exception cause) { + return RetrofitException.errorUnknown(request, cause); + } + +} + +``` + +## 全局拦截器 + +### 全局应用拦截器 + +如果我们需要对整个系统的的http请求执行统一的拦截处理,可以自定义实现全局拦截器`BaseGlobalInterceptor`, 并配置成`spring`容器中的`bean`!例如我们需要在整个系统发起的http请求,都带上来源信息。 + +```java + +@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); + } +} +``` + +### 全局网络拦截器 + +只需要实现`NetworkInterceptor`接口 并配置成`spring`容器中的`bean`就支持自动织入全局网络拦截器。 + +### 熔断降级 + +`retrofit-spring-boot-starter` +支持熔断降级功能,底层基于[Sentinel](https://sentinelguard.io/zh-cn/docs/introduction.html)实现。具体来说,支持了**熔断资源自发现**和**注解式降级规则配置**。如需使用熔断降级,只需要进行以下操作即可: + +#### 1. 开启熔断降级功能 + +**默认情况下,熔断降级功能是关闭的,需要设置相应的配置项来开启熔断降级功能**: + +```yaml +retrofit: + # 熔断降级配置 + degrade: + # 是否启用熔断降级 + enable: true + # 熔断降级实现方式 + degrade-type: sentinel + # 熔断资源名称解析器 + resource-name-parser: com.github.lianjiatech.retrofit.spring.boot.degrade.DefaultResourceNameParser +``` + +资源名称解析器用于实现用户自定义资源名称,默认配置是`DefaultResourceNameParser`,对应的资源名称格式为`HTTP_OUT: +GET:http://localhost:8080/api/degrade/test`。用户可以继承`BaseResourceNameParser`类实现自己的资源名称解析器。 + +另外,由于熔断降级功能是可选的,**因此启用熔断降级需要用户自行引入Sentinel依赖**: + +```xml + + + com.alibaba.csp + sentinel-core + 1.6.3 + +``` + +#### 2. 配置降级规则(可选) + +**`retrofit-spring-boot-starter`支持注解式配置降级规则,通过`@Degrade`注解来配置降级规则**。`@Degrade`注解可以配置在接口或者方法上,配置在方法上的优先级更高。 + +```java + +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.TYPE}) +@Documented +public @interface Degrade { + + /** + * RT threshold or exception ratio threshold count. + */ + double count(); + + /** + * Degrade recover timeout (in seconds) when degradation occurs. + */ + int timeWindow() default 5; + + /** + * Degrade strategy (0: average RT, 1: exception ratio). + */ + DegradeStrategy degradeStrategy() default DegradeStrategy.AVERAGE_RT; +} +``` + +> **如果应用项目已支持通过配置中心配置降级规则,可忽略注解式配置方式**。 + +#### 3. @RetrofitClient设置fallback或者fallbackFactory (可选) + +如果`@RetrofitClient`不设置`fallback`或者`fallbackFactory`,当触发熔断时,会直接抛出`RetrofitBlockException`异常。**用户可以通过设置`fallback` +或者`fallbackFactory`来定制熔断时的方法返回值**。`fallback`类必须是当前接口的实现类,`fallbackFactory`必须是`FallbackFactory` +实现类,泛型参数类型为当前接口类型。另外,`fallback`和`fallbackFactory`实例必须配置成`Spring`容器的`Bean`。 + +**`fallbackFactory`相对于`fallback`,主要差别在于能够感知每次熔断的异常原因(cause)**。参考示例如下: + +```java + +@Slf4j +@Service +public class HttpDegradeFallback implements HttpDegradeApi { + + @Override + public Result test() { + Result fallback = new Result<>(); + fallback.setCode(100) + .setMsg("fallback") + .setBody(1000000); + return fallback; + } +} +``` + +```java + +@Slf4j +@Service +public class HttpDegradeFallbackFactory implements FallbackFactory { + + /** + * 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` + +用户可以自行实现`ServiceInstanceChooser`接口,完成服务实例的选取逻辑,并将其配置成`Spring`容器的`Bean`。对于`Spring Cloud`应用,`retrofit-spring-boot-starter` +提供了`SpringCloudServiceInstanceChooser`实现,用户只需将其配置成`Spring`的`Bean`即可。 + +```java +@Bean +@Autowired +public ServiceInstanceChooser serviceInstanceChooser(LoadBalancerClient loadBalancerClient){ + return new SpringCloudServiceInstanceChooser(loadBalancerClient); + } +``` + +#### 使用`@Retrofit`的`serviceId`和`path`属性,可以实现微服务之间的HTTP调用 + +```java + +@RetrofitClient(serviceId = "${jy-helicarrier-api.serviceId}", path = "/m/count", errorDecoder = HelicarrierErrorDecoder.class) +@Retry +public interface ApiCountService { + +} +``` + +## 调用适配器和数据转码器 + +### 调用适配器 + +`Retrofit`可以通过调用适配器`CallAdapterFactory`将`Call`对象适配成接口方法的返回值类型。`retrofit-spring-boot-starter`扩展2种`CallAdapterFactory` +实现: + +1. `BodyCallAdapterFactory` + - 默认启用,可通过配置`retrofit.enable-body-call-adapter=false`关闭 + - 同步执行http请求,将响应体内容适配成接口方法的返回值类型实例。 + - 除了`Retrofit.Call`、`Retrofit.Response`、`java.util.concurrent.CompletableFuture`之外,其它返回类型都可以使用该适配器。 +2. `ResponseCallAdapterFactory` + - 默认启用,可通过配置`retrofit.enable-response-call-adapter=false`关闭 + - 同步执行http请求,将响应体内容适配成`Retrofit.Response`返回。 + - 如果方法的返回值类型为`Retrofit.Response`,则可以使用该适配器。 + +**Retrofit自动根据方法返回值类型选用对应的`CallAdapterFactory`执行适配处理!加上Retrofit默认的`CallAdapterFactory`,可支持多种形式的方法返回值类型:** + +- 任意POJO类型: 将响应体内容适配成一个对应的POJO类型对象返回,如果http状态码不是2xx,直接抛错!(推荐) +- `CompletableFuture`: 将响应体内容适配成`CompletableFuture`对象返回!(异步调用推荐) +- `Void`: 不关注返回类型可以使用`Void`。如果http状态码不是2xx,直接抛错!(不关注返回值) +- `Response`: 将响应内容适配成`Response`对象返回!(不推荐) +- `Call`: 不执行适配处理,直接返回`Call`对象!(不推荐) + +```java + +/** + * 其他任意Java类型 + * 将响应体内容适配成一个对应的Java类型对象返回,如果http状态码不是2xx,直接抛错! + * @param id + * @return + */ +@GET("person") + Result getPerson(@Query("id") Long id); + +/** + * CompletableFuture + * 将响应体内容适配成CompletableFuture对象返回 + * @param id + * @return + */ +@GET("person") + CompletableFuture>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>getPersonResponse(@Query("id") Long id); + +/** + * Call + * 不执行适配处理,直接返回Call对象 + * @param id + * @return + */ +@GET("person") + Call>getPersonCall(@Query("id") Long id); + +``` + +**我们也可以通过继承`CallAdapter.Factory`扩展实现自己的`CallAdapter`**! + +`retrofit-spring-boot-starter`支持通过`retrofit.global-call-adapter-factories` +配置全局调用适配器工厂,工厂实例优先从Spring容器获取,如果没有获取到,则反射创建。默认的全局调用适配器工厂是`[BodyCallAdapterFactory, ResponseCallAdapterFactory]`! + +```yaml +retrofit: + # 全局调用适配器工厂 + global-call-adapter-factories: + - com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory + - com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory +``` + +针对每个Java接口,还可以通过`@RetrofitClient`注解的`callAdapterFactories()`指定当前接口采用的`CallAdapter.Factory`,指定的工厂实例依然优先从Spring容器获取。 + +**注意:如果`CallAdapter.Factory`没有`public`的无参构造器,请手动将其配置成`Spring`容器的`Bean`对象**! + +### 数据转码器 + +`Retrofit`使用`Converter`将`@Body`注解标注的对象转换成请求体,将响应体数据转换成一个`Java`对象,可以选用以下几种`Converter`: + +- [Gson](https://github.com/google/gson): com.squareup.Retrofit:converter-gson +- [Jackson](https://github.com/FasterXML/jackson): com.squareup.Retrofit:converter-jackson +- [Moshi](https://github.com/square/moshi/): com.squareup.Retrofit:converter-moshi +- [Protobuf](https://developers.google.com/protocol-buffers/): com.squareup.Retrofit:converter-protobuf +- [Wire](https://github.com/square/wire): com.squareup.Retrofit:converter-wire +- [Simple XML](http://simple.sourceforge.net/): com.squareup.Retrofit:converter-simplexml +- [JAXB](https://docs.oracle.com/javase/tutorial/jaxb/intro/index.html): com.squareup.retrofit2:converter-jaxb +- fastJson:com.alibaba.fastjson.support.retrofit.Retrofit2ConverterFactory + +`retrofit-spring-boot-starter`支持通过`retrofit.global-converter-factories` +配置全局数据转换器工厂,转换器工厂实例优先从Spring容器获取,如果没有获取到,则反射创建。默认的全局数据转换器工厂是`retrofit2.converter.jackson.JacksonConverterFactory` +,你可以直接通过`spring.jackson.*`配置`jackson` +序列化规则,配置可参考[Customize the Jackson ObjectMapper](https://docs.spring.io/spring-boot/docs/2.1.5.RELEASE/reference/htmlsingle/#howto-customize-the-jackson-objectmapper)! + +```yaml +retrofit: + # 全局转换器工厂 + global-converter-factories: + - retrofit2.converter.jackson.JacksonConverterFactory +``` + +针对每个Java接口,还可以通过`@RetrofitClient`注解的`converterFactories()`指定当前接口采用的`Converter.Factory`,指定的转换器工厂实例依然优先从Spring容器获取。 + +**注意:如果`Converter.Factory`没有`public`的无参构造器,请手动将其配置成`Spring`容器的`Bean`对象**! + +## 其他功能示例 + +### 上传文件 + +#### 构建MultipartBody.Part + +```java +// 对文件名使用URLEncoder进行编码 +String fileName=URLEncoder.encode(Objects.requireNonNull(file.getOriginalFilename()),"utf-8"); + okhttp3.RequestBody requestBody=okhttp3.RequestBody.create(MediaType.parse("multipart/form-data"),file.getBytes()); + MultipartBody.Part file=MultipartBody.Part.createFormData("file",fileName,requestBody); + apiService.upload(file); +``` + +#### http上传接口 + +```java +@POST("upload") +@Multipart +Void upload(@Part MultipartBody.Part file); + +``` + +### 下载文件 + +#### http下载接口 + +```java + +@RetrofitClient(baseUrl = "https://img.ljcdn.com/hc-picture/") +public interface DownloadApi { + + @GET("{fileKey}") + Response download(@Path("fileKey") String fileKey); +} + +``` + +#### http下载使用 + +```java + +@SpringBootTest(classes = RetrofitTestApplication.class) +@RunWith(SpringRunner.class) +public class DownloadTest { + @Autowired + DownloadApi downLoadApi; + + @Test + public void download() throws Exception { + String fileKey = "6302d742-ebc8-4649-95cf-62ccf57a1add"; + Response response = downLoadApi.download(fileKey); + ResponseBody responseBody = response.body(); + // 二进制流 + InputStream is = responseBody.byteStream(); + + // 具体如何处理二进制流,由业务自行控制。这里以写入文件为例 + File tempDirectory = new File("temp"); + if (!tempDirectory.exists()) { + tempDirectory.mkdir(); + } + File file = new File(tempDirectory, UUID.randomUUID().toString()); + if (!file.exists()) { + file.createNewFile(); + } + FileOutputStream fos = new FileOutputStream(file); + byte[] b = new byte[1024]; + int length; + while ((length = is.read(b)) > 0) { + fos.write(b, 0, length); + } + is.close(); + fos.close(); + } +} +``` + +### 动态URL + +使用`@url`注解可实现动态URL。 + +**注意:`@url`必须放在方法参数的第一个位置。原有定义`@GET`、`@POST`等注解上,不需要定义端点路径**! + +```java + @GET + Map test3(@Url String url,@Query("name") String name); + +``` + +### DELETE请求传请求体 + +```java +@HTTP(method = "DELETE", path = "/user/delete", hasBody = true) +``` + +### GET请求传请求体 + +**okhttp3自身不支持`GET`请求带请求体**。源码如下: + +![image](https://user-images.githubusercontent.com/30620547/108949806-0a9f7780-76a0-11eb-9eb4-326d5d546e98.png) + +![image](https://user-images.githubusercontent.com/30620547/108949831-1ab75700-76a0-11eb-955c-95d324084580.png) + +作者给出了具体原因,可以参考这个issue:https://github.com/square/okhttp/issues/3154 + +but,如果实在需要这么干,可以使用`@HTTP(method = "get", path = "/user/get", hasBody = true)`。使用小写`get`绕过上述限制。 + +## 反馈建议 + +如有任何问题,欢迎提issue或者加QQ群反馈。 + +群号:806714302 + +![QQ群图片](https://github.com/LianjiaTech/retrofit-spring-boot-starter/blob/master/qun.png) +