Merge pull request #27 from LianjiaTech/develop

chentianming11 · web-flow · commit d97b5cbd362f · 2020-09-23T00:05:35.000-05:00
Develop
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@
 <dependency>
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.1.6</version>
+    <version>2.1.7</version>
 </dependency>
 ```
 
@@ -588,18 +588,23 @@ You only need to implement the `NetworkInterceptor` interface and configure it a
 
 `Retrofit` uses `Converter` to convert the object annotated with `@Body` into the request body, and the response body data into a `Java` object. The following types of `Converter` can be used:
 
-- 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
+- [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
 
-`Retrofit-spring-boot-starter` uses jackson to perform serialization conversion by default. You can directly configure `jackson` serialization rules through `spring.jackson.*`. For configuration, please refer to [Customize the Jackson ObjectMapper](https://docs.spring.io/spring-boot/docs/2.1.5.RELEASE/reference/htmlsingle/#howto-customize-the-jackson-objectmapper)! **If you need to use other serialization methods, introduce the corresponding dependency in the project, and then configure the corresponding `ConverterFactory` as a spring bean**.
+`retrofit-spring-boot-starter` supports configuring the global `converter factory` through `retrofit.global-converter-factories`. The converter factory instance is first obtained from the Spring container. If it is not obtained, it is created by reflection. The default global data converter factory is `retrofit2.converter.jackson.JacksonConverterFactory`, you can directly configure the `jackson` serialization rules through `spring.jackson.*`, please refer to [Customize the Jackson ObjectMapper](https:/ /docs.spring.io/spring-boot/docs/2.1.5.RELEASE/reference/htmlsingle/#howto-customize-the-jackson-objectmapper)!
 
-**We can also implement our own `Converter` by extending the extension of `Converter.Factory`** and then configure the custom `Converter.Factory` as the `bean` of `spring`!
+```yaml
+retrofit:
+  global-converter-factories:
+    - retrofit2.converter.jackson.JacksonConverterFactory
+```
 
-> The custom configuration of `Converter.Factory` has higher priority!
+For each Java interface, you can also specify the `Converter.Factory` used by the current interface through `converterFactories()` annotated by `@RetrofitClient`, and the specified converter factory instance is still preferentially obtained from the Spring container.
 
 
 ## Other features
diff --git a/README_CN.md b/README_CN.md
@@ -41,7 +41,7 @@
 <dependency>
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.1.6</version>
+    <version>2.1.7</version>
 </dependency>
 ```
 
@@ -605,18 +605,24 @@ public class SourceInterceptor extends BaseGlobalInterceptor {
 
 `Retrofit`使用`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
+- [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
 
-`retrofit-spring-boot-starter`默认使用的是jackson进行序列化转换，你可以直接通过`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)！**如果需要使用其它序列化方式，在项目中引入对应的依赖，再把对应的`ConverterFactory`配置成spring的bean即可**。
+`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)！
 
-**我们也可以通过继承`Converter.Factory`扩展实现自己的`Converter`**；然后将自定义的`Converter.Factory`配置成`spring`的`bean`！
+```yaml
+retrofit:
+  # 全局转换器工厂
+  global-converter-factories:
+    - retrofit2.converter.jackson.JacksonConverterFactory
+```
 
-> 自定义配置的`Converter.Factory`优先级更高！
+针对每个Java接口，还可以通过`@RetrofitClient`注解的`converterFactories()`指定当前接口采用的`Converter.Factory`，指定的转换器工厂实例依然优先从Spring容器获取。
 
 
 ## 其他功能示例
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.1.6</version>
+    <version>2.1.7</version>
 
     <name>retrofit-spring-boot-starter</name>
     <description>retrofit-spring-boot-starter</description>
@@ -113,6 +113,18 @@
             <version>${okhttp3.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.squareup.retrofit2</groupId>
+            <artifactId>converter-gson</artifactId>
+            <version>${retrofit.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.squareup.retrofit2</groupId>
+            <artifactId>converter-jaxb</artifactId>
+            <version>${retrofit.version}</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.squareup.okio</groupId>
             <artifactId>okio</artifactId>
diff --git a/src/main/java/com/github/lianjiatech/retrofit/spring/boot/annotation/RetrofitClient.java b/src/main/java/com/github/lianjiatech/retrofit/spring/boot/annotation/RetrofitClient.java
@@ -4,6 +4,7 @@
 import com.github.lianjiatech.retrofit.spring.boot.core.ErrorDecoder;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.LogStrategy;
 import org.slf4j.event.Level;
+import retrofit2.Converter;
 import retrofit2.Retrofit;
 
 import java.lang.annotation.*;
@@ -41,6 +42,14 @@
      */
     String path() default "";
 
+    /**
+     * 适用于当前接口的转换器工厂，优先级比全局转换器工厂更高。转换器实例优先从Spring容器获取，如果没有获取到，则反射创建。
+     * Converter factory for the current interface, higher priority than global converter factory.
+     * The converter instance is first obtained from the Spring container. If it is not obtained, it is created by reflection.
+     */
+    Class<? extends Converter.Factory>[] converterFactories() default {};
+
+
     /**
      * When calling {@link Retrofit#create(Class)} on the resulting {@link Retrofit} instance, eagerly validate the
      * configuration of all methods in the supplied interface.
diff --git a/src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitAutoConfiguration.java b/src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitAutoConfiguration.java
@@ -55,8 +55,7 @@ public static PrototypeInterceptorBdfProcessor prototypeInterceptorBdfProcessor(
 
     @Bean
     @ConditionalOnMissingBean
-    @Autowired
-    public RetrofitConfigBean retrofitConfigBean(ObjectMapper objectMapper) throws IllegalAccessException, InstantiationException {
+    public RetrofitConfigBean retrofitConfigBean() throws IllegalAccessException, InstantiationException {
         RetrofitConfigBean retrofitConfigBean = new RetrofitConfigBean(retrofitProperties);
         // Initialize the connection pool
         Map<String, ConnectionPool> poolRegistry = new ConcurrentHashMap<>(4);
@@ -86,14 +85,9 @@ public RetrofitConfigBean retrofitConfigBean(ObjectMapper objectMapper) throws I
         retrofitConfigBean.setCallAdapterFactories(callAdapterFactories);
 
         // converterFactory
-        List<Converter.Factory> converterFactories = new ArrayList<>();
-        Collection<Converter.Factory> converterFactoryBeans = getBeans(Converter.Factory.class);
-        if (!CollectionUtils.isEmpty(converterFactoryBeans)) {
-            converterFactories.addAll(converterFactoryBeans);
-        }
-        JacksonConverterFactory defaultJacksonConverterFactory = JacksonConverterFactory.create(objectMapper);
-        converterFactories.add(defaultJacksonConverterFactory);
-        retrofitConfigBean.setConverterFactories(converterFactories);
+        Class<? extends Converter.Factory>[] globalConverterFactories = retrofitProperties.getGlobalConverterFactories();
+        retrofitConfigBean.setGlobalConverterFactoryClasses(globalConverterFactories);
+
         // globalInterceptors
         Collection<BaseGlobalInterceptor> globalInterceptors = getBeans(BaseGlobalInterceptor.class);
         retrofitConfigBean.setGlobalInterceptors(globalInterceptors);
@@ -120,6 +114,7 @@ public RetrofitConfigBean retrofitConfigBean(ObjectMapper objectMapper) throws I
         return retrofitConfigBean;
     }
 
+
     @Bean
     @ConditionalOnMissingBean
     public ObjectMapper jacksonObjectMapper() {
@@ -128,6 +123,13 @@ public ObjectMapper jacksonObjectMapper() {
                 .setSerializationInclusion(JsonInclude.Include.NON_NULL);
     }
 
+    @Bean
+    @ConditionalOnMissingBean
+    @Autowired
+    public JacksonConverterFactory jacksonConverterFactory(ObjectMapper objectMapper) {
+        return JacksonConverterFactory.create(objectMapper);
+    }
+
 
     private <U> Collection<U> getBeans(Class<U> clz) {
         try {
@@ -139,7 +141,6 @@ private <U> Collection<U> getBeans(Class<U> clz) {
         return null;
     }
 
-
     @Override
     public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
         this.applicationContext = applicationContext;
diff --git a/src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitConfigBean.java b/src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitConfigBean.java
@@ -21,8 +21,6 @@ public class RetrofitConfigBean {
 
     private List<CallAdapter.Factory> callAdapterFactories;
 
-    private List<Converter.Factory> converterFactories;
-
     private Map<String, ConnectionPool> poolRegistry;
 
     private Collection<BaseGlobalInterceptor> globalInterceptors;
@@ -33,6 +31,8 @@ public class RetrofitConfigBean {
 
     private ServiceInstanceChooserInterceptor serviceInstanceChooserInterceptor;
 
+    private Class<? extends Converter.Factory>[] globalConverterFactoryClasses;
+
     public RetrofitProperties getRetrofitProperties() {
         return retrofitProperties;
     }
@@ -51,14 +51,6 @@ public void setCallAdapterFactories(List<CallAdapter.Factory> callAdapterFactori
         this.callAdapterFactories = callAdapterFactories;
     }
 
-    public List<Converter.Factory> getConverterFactories() {
-        return converterFactories;
-    }
-
-    public void setConverterFactories(List<Converter.Factory> converterFactories) {
-        this.converterFactories = converterFactories;
-    }
-
     public Map<String, ConnectionPool> getPoolRegistry() {
         return poolRegistry;
     }
@@ -98,4 +90,12 @@ public ServiceInstanceChooserInterceptor getServiceInstanceChooserInterceptor()
     public void setServiceInstanceChooserInterceptor(ServiceInstanceChooserInterceptor serviceInstanceChooserInterceptor) {
         this.serviceInstanceChooserInterceptor = serviceInstanceChooserInterceptor;
     }
+
+    public Class<? extends Converter.Factory>[] getGlobalConverterFactoryClasses() {
+        return globalConverterFactoryClasses;
+    }
+
+    public void setGlobalConverterFactoryClasses(Class<? extends Converter.Factory>[] globalConverterFactoryClasses) {
+        this.globalConverterFactoryClasses = globalConverterFactoryClasses;
+    }
 }
diff --git a/src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitProperties.java b/src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitProperties.java
@@ -8,6 +8,8 @@
 import com.github.lianjiatech.retrofit.spring.boot.retry.BaseRetryInterceptor;
 import com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import retrofit2.Converter;
+import retrofit2.converter.jackson.JacksonConverterFactory;
 
 import java.util.LinkedHashMap;
 import java.util.Map;
@@ -47,7 +49,6 @@ public class RetrofitProperties {
     /**
      * 日志打印拦截器
      * Log print Interceptor
-     *
      */
     private Class<? extends BaseLoggingInterceptor> loggingInterceptor = DefaultLoggingInterceptor.class;
 
@@ -63,6 +64,13 @@ public class RetrofitProperties {
      */
     private boolean disableVoidReturnType = false;
 
+    /**
+     * 全局转换器工厂，转换器实例优先从Spring容器获取，如果没有获取到，则反射创建。
+     * global converter factories, The converter instance is first obtained from the Spring container. If it is not obtained, it is created by reflection.
+     */
+    @SuppressWarnings("unchecked")
+    private Class<? extends Converter.Factory>[] globalConverterFactories = (Class<? extends Converter.Factory>[]) new Class[]{JacksonConverterFactory.class};
+
 
     public Class<? extends BaseLoggingInterceptor> getLoggingInterceptor() {
         return loggingInterceptor;
@@ -123,4 +131,12 @@ public Class<? extends BaseRetryInterceptor> getRetryInterceptor() {
     public void setRetryInterceptor(Class<? extends BaseRetryInterceptor> retryInterceptor) {
         this.retryInterceptor = retryInterceptor;
     }
+
+    public Class<? extends Converter.Factory>[] getGlobalConverterFactories() {
+        return globalConverterFactories;
+    }
+
+    public void setGlobalConverterFactories(Class<? extends Converter.Factory>[] globalConverterFactories) {
+        this.globalConverterFactories = globalConverterFactories;
+    }
 }
diff --git a/src/main/java/com/github/lianjiatech/retrofit/spring/boot/core/RetrofitFactoryBean.java b/src/main/java/com/github/lianjiatech/retrofit/spring/boot/core/RetrofitFactoryBean.java
@@ -50,6 +50,8 @@ public class RetrofitFactoryBean<T> implements FactoryBean<T>, EnvironmentAware,
 
     private ApplicationContext applicationContext;
 
+    private static final Map<Class<? extends Converter.Factory>, Converter.Factory> CONVERTER_FACTORIES_CACHE = new HashMap<>();
+
     public RetrofitFactoryBean(Class<T> retrofitInterface) {
         this.retrofitInterface = retrofitInterface;
     }
@@ -323,13 +325,47 @@ private synchronized Retrofit getRetrofit(Class<?> retrofitClientInterfaceClass)
             callAdapterFactories.forEach(retrofitBuilder::addCallAdapterFactory);
         }
         // 添加Converter.Factory
-        List<Converter.Factory> converterFactories = retrofitConfigBean.getConverterFactories();
+        Class<? extends Converter.Factory>[] converterFactoryClasses = retrofitClient.converterFactories();
+        Class<? extends Converter.Factory>[] globalConverterFactoryClasses = retrofitConfigBean.getGlobalConverterFactoryClasses();
+
+        List<Converter.Factory> converterFactories = getConverterFactories(converterFactoryClasses, globalConverterFactoryClasses);
         if (!CollectionUtils.isEmpty(converterFactories)) {
             converterFactories.forEach(retrofitBuilder::addConverterFactory);
         }
         return retrofitBuilder.build();
     }
 
+    private List<Converter.Factory> getConverterFactories(Class<? extends Converter.Factory>[] converterFactoryClasses, Class<? extends Converter.Factory>[] globalConverterFactoryClasses) throws IllegalAccessException, InstantiationException {
+        List<Class<? extends Converter.Factory>> combineConverterFactoryClasses = new ArrayList<>();
+
+        if (converterFactoryClasses != null && converterFactoryClasses.length != 0) {
+            combineConverterFactoryClasses.addAll(Arrays.asList(converterFactoryClasses));
+        }
+
+        if (globalConverterFactoryClasses != null && globalConverterFactoryClasses.length != 0) {
+            combineConverterFactoryClasses.addAll(Arrays.asList(globalConverterFactoryClasses));
+        }
+
+        if (combineConverterFactoryClasses.isEmpty()) {
+            return Collections.emptyList();
+        }
+
+        List<Converter.Factory> converterFactories = new ArrayList<>();
+
+        for (Class<? extends Converter.Factory> converterFactoryClass : combineConverterFactoryClasses) {
+            Converter.Factory converterFactory = CONVERTER_FACTORIES_CACHE.get(converterFactoryClass);
+            if (converterFactory == null) {
+                converterFactory = getBean(converterFactoryClass);
+                if (converterFactory == null) {
+                    converterFactory = converterFactoryClass.newInstance();
+                }
+                CONVERTER_FACTORIES_CACHE.put(converterFactoryClass, converterFactory);
+            }
+            converterFactories.add(converterFactory);
+        }
+        return converterFactories;
+    }
+
 
     @Override
     public void setEnvironment(Environment environment) {
diff --git a/src/test/java/com/github/lianjiatech/retrofit/spring/boot/test/RetrofitConvertFactoriesTest.java b/src/test/java/com/github/lianjiatech/retrofit/spring/boot/test/RetrofitConvertFactoriesTest.java
diff --git a/src/test/java/com/github/lianjiatech/retrofit/spring/boot/test/RetrofitTestApplication.java b/src/test/java/com/github/lianjiatech/retrofit/spring/boot/test/RetrofitTestApplication.java
diff --git a/src/test/java/com/github/lianjiatech/retrofit/spring/boot/test/http/ConvertFactoriesTestApi.java b/src/test/java/com/github/lianjiatech/retrofit/spring/boot/test/http/ConvertFactoriesTestApi.java
diff --git a/src/test/resources/application.yml b/src/test/resources/application.yml
