Merge pull request #20 from LianjiaTech/develop

Develop

Author: chentianming11

README.md

@@ -6,7 +6,7 @@
 [![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.x+-green.svg)](https://docs.spring.io/spring-boot/docs/2.1.5.RELEASE/reference/htmlsingle/)
+[![License](https://img.shields.io/badge/SpringBoot-1.x+-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/HTTP-exception-information-formatter6302d742-ebc8-4649-95cf-62ccf57a1add)
 
@@ -24,6 +24,7 @@
 ## Features
 
 - [x] [Custom injection OkHttpClient](#Custom-injection-OkHttpClient)
+- [x] [HTTP calls between microservices](#HTTP-calls-between-microservices)
 - [x] [Annotation interceptor](#Annotation-interceptor)
 - [x] [Connection pool management](#Connection-pool-management)
 - [x] [Log printing](#Log-printing)
@@ -41,7 +42,7 @@
 <dependency>
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.1.3</version>
+    <version>2.1.4</version>
 </dependency>
 ```
 
@@ -170,6 +171,36 @@ public interface HttpApi3 {
 
 > The method must be marked with `@OkHttpClientBuilder` annotation!
 
+
+### HTTP calls between microservices
+
+**By configuring the `serviceId` and `path` properties of `@Retrofit`, HTTP calls between microservices can be realized**.
+
+```java
+@RetrofitClient(serviceId = "${jy-helicarrier-api.serviceId}", path = "/m/count", errorDecoder = HelicarrierErrorDecoder.class)
+@Retry
+public interface ApiCountService {
+
+}
+```
+
+Users need to implement the `ServiceInstanceChooser` interface by themselves, complete the selection logic of the service instance, and configure it as the `Bean` of the `Spring` container.
+For `Spring Cloud` applications, `retrofit-spring-boot-starter` provides the implementation of `SpringCloudServiceInstanceChooser`.
+
+```java
+public interface ServiceInstanceChooser {
+
+    /**
+     * Chooses a ServiceInstance URI from the LoadBalancer for the specified service.
+     *
+     * @param serviceId The service ID to look up the LoadBalancer.
+     * @return Return the uri of ServiceInstance
+     */
+    URI choose(String serviceId);
+
+}
+```
+
 ### Annotation interceptor
 
 In many cases, we hope that certain http requests in a certain interface execute a unified interception processing logic. So as to support this feature, `retrofit-spring-boot-starter` provide **annotation interceptor** and at the same time achieves **matching interception based on URL path**. The use is mainly divided into 2 steps:

README_CN.md

@@ -23,6 +23,7 @@
 ## 功能特性
 
 - [x] [自定义注入OkHttpClient](#自定义注入OkHttpClient)
+- [x] [微服务之间的HTTP调用](#微服务之间的HTTP调用)
 - [x] [注解式拦截器](#注解式拦截器)
 - [x] [连接池管理](#连接池管理)
 - [x] [日志打印](#日志打印)
@@ -40,7 +41,7 @@
 <dependency>
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.1.3</version>
+    <version>2.1.4</version>
 </dependency>
 ```
 
@@ -169,6 +170,35 @@ public interface HttpApi3 {
 
 > 方法必须使用`@OkHttpClientBuilder`注解标记！
 
+### 微服务之间的HTTP调用
+
+**通过配置`@Retrofit`的`serviceId`和`path`属性，可以实现微服务之间的HTTP调用**。比如：
+
+```java
+@RetrofitClient(serviceId = "${jy-helicarrier-api.serviceId}", path = "/m/count", errorDecoder = HelicarrierErrorDecoder.class)
+@Retry
+public interface ApiCountService {
+
+}
+```
+
+用户需要自行实现`ServiceInstanceChooser`接口，完成服务实例的选取逻辑，并将其配置成`Spring`容器的`Bean`。对于`Spring Cloud`应用，`retrofit-spring-boot-starter`提供了`SpringCloudServiceInstanceChooser`实现。
+
+```java
+public interface ServiceInstanceChooser {
+
+    /**
+     * Chooses a ServiceInstance URI from the LoadBalancer for the specified service.
+     *
+     * @param serviceId The service ID to look up the LoadBalancer.
+     * @return Return the uri of ServiceInstance
+     */
+    URI choose(String serviceId);
+
+}
+```
+
+
 ### 注解式拦截器
 
 很多时候，我们希望某个接口下的某些http请求执行统一的拦截处理逻辑。为了支持这个功能，`retrofit-spring-boot-starter`提供了**注解式拦截器**，同时做到了**基于url路径的匹配拦截**。使用的步骤主要分为2步：

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.1.3</version>
+    <version>2.1.4</version>
 
     <name>retrofit-spring-boot-starter</name>
     <description>retrofit-spring-boot-starter</description>
@@ -48,6 +48,13 @@
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-commons</artifactId>
+            <version>2.1.6.RELEASE</version>
+            <scope>provided</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>

src/main/java/com/github/lianjiatech/retrofit/spring/boot/annotation/RetrofitClient.java

@@ -2,7 +2,7 @@
 
 import com.github.lianjiatech.retrofit.spring.boot.core.DefaultErrorDecoder;
 import com.github.lianjiatech.retrofit.spring.boot.core.ErrorDecoder;
-import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseLoggingInterceptor;
+import com.github.lianjiatech.retrofit.spring.boot.interceptor.LogStrategy;
 import org.slf4j.event.Level;
 import retrofit2.Retrofit;
 
@@ -17,13 +17,29 @@
 public @interface RetrofitClient {
 
     /**
-     * 基础url, 支持占位符形式配置。
-     * baseUrl, Supports placeholder configuration.
-     * http://${baseUrl.test}
+     * 绝对URL（协议是必需的）。
+     * 可以指定为属性键，例如：$ {propertyKey}。
+     * 如果baseUrl没有配置，则必须配置serviceId以及，path可选配置。
+     *
+     * An absolute URL (the protocol is necessary).
+     * Can be specified as property key, eg: ${propertyKey}.
+     * If baseUrl is not configured, you must configure serviceId and path optional configuration.
+     *
      *
      * @return baseUrl
      */
-    String baseUrl();
+    String baseUrl() default "";
+
+    /**
+     * The name of the service.
+     * Can be specified as property key, eg: ${propertyKey}.
+     */
+    String serviceId() default "";
+
+    /**
+     * Path prefix to be used by all method-level mappings.
+     */
+    String path() default "";
 
     /**
      * When calling {@link Retrofit#create(Class)} on the resulting {@link Retrofit} instance, eagerly validate the
@@ -136,10 +152,10 @@
     Level logLevel() default Level.INFO;
 
     /**
-     * 日志打印策略，支持的日志打印策略参见{@link BaseLoggingInterceptor.LogStrategy}
-     * Log printing strategy, see {@link BaseLoggingInterceptor.LogStrategy} for supported log printing strategies
+     * 日志打印策略，支持的日志打印策略参见{@link LogStrategy}
+     * Log printing strategy, see {@link LogStrategy} for supported log printing strategies
      *
      * @return logStrategy
      */
-    BaseLoggingInterceptor.LogStrategy logStrategy() default BaseLoggingInterceptor.LogStrategy.BASIC;
+    LogStrategy logStrategy() default LogStrategy.BASIC;
 }

src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitAutoConfiguration.java

@@ -3,19 +3,22 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.github.lianjiatech.retrofit.spring.boot.core.BodyCallAdapterFactory;
-import com.github.lianjiatech.retrofit.spring.boot.core.PrototypeInterceptorBdfProcessor;
-import com.github.lianjiatech.retrofit.spring.boot.core.ResponseCallAdapterFactory;
+import com.github.lianjiatech.retrofit.spring.boot.core.*;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseGlobalInterceptor;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.NetworkInterceptor;
+import com.github.lianjiatech.retrofit.spring.boot.interceptor.ServiceInstanceChooserInterceptor;
 import com.github.lianjiatech.retrofit.spring.boot.retry.BaseRetryInterceptor;
 import okhttp3.ConnectionPool;
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.cloud.client.loadbalancer.LoadBalancerAutoConfiguration;
+import org.springframework.cloud.client.loadbalancer.LoadBalancerClient;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Bean;
@@ -37,7 +40,7 @@
  */
 @Configuration
 @EnableConfigurationProperties(RetrofitProperties.class)
-@AutoConfigureAfter(JacksonAutoConfiguration.class)
+@AutoConfigureAfter({JacksonAutoConfiguration.class, LoadBalancerAutoConfiguration.class})
 public class RetrofitAutoConfiguration implements ApplicationContextAware {
 
     @Autowired
@@ -56,7 +59,8 @@ public static PrototypeInterceptorBdfProcessor prototypeInterceptorBdfProcessor(
 
     @Bean
     @ConditionalOnMissingBean
-    public RetrofitConfigBean retrofitConfigBean(@Autowired ObjectMapper objectMapper) throws IllegalAccessException, InstantiationException {
+    @Autowired
+    public RetrofitConfigBean retrofitConfigBean(ObjectMapper objectMapper) throws IllegalAccessException, InstantiationException {
         RetrofitConfigBean retrofitConfigBean = new RetrofitConfigBean(retrofitProperties);
         // Initialize the connection pool
         Map<String, ConnectionPool> poolRegistry = new ConcurrentHashMap<>(4);
@@ -106,6 +110,17 @@ public RetrofitConfigBean retrofitConfigBean(@Autowired ObjectMapper objectMappe
         Collection<NetworkInterceptor> networkInterceptors = getBeans(NetworkInterceptor.class);
         retrofitConfigBean.setNetworkInterceptors(networkInterceptors);
 
+        // add ServiceInstanceChooserInterceptor
+        ServiceInstanceChooser serviceInstanceChooser;
+        try {
+            serviceInstanceChooser = applicationContext.getBean(ServiceInstanceChooser.class);
+        } catch (BeansException e) {
+            serviceInstanceChooser = new NoValidServiceInstanceChooser();
+        }
+
+        ServiceInstanceChooserInterceptor serviceInstanceChooserInterceptor = new ServiceInstanceChooserInterceptor(serviceInstanceChooser);
+        retrofitConfigBean.setServiceInstanceChooserInterceptor(serviceInstanceChooserInterceptor);
+
         return retrofitConfigBean;
     }
 
@@ -117,6 +132,16 @@ public ObjectMapper jacksonObjectMapper() {
                 .setSerializationInclusion(JsonInclude.Include.NON_NULL);
     }
 
+    @Bean
+    @ConditionalOnMissingBean
+    @ConditionalOnClass(LoadBalancerClient.class)
+    @ConditionalOnBean(LoadBalancerClient.class)
+    @Autowired
+    public ServiceInstanceChooser serviceInstanceChooser(LoadBalancerClient loadBalancerClient) {
+        return new SpringCloudServiceInstanceChooser(loadBalancerClient);
+    }
+
+
     private <U> Collection<U> getBeans(Class<U> clz) {
         try {
             Map<String, U> beanMap = applicationContext.getBeansOfType(clz);

src/main/java/com/github/lianjiatech/retrofit/spring/boot/config/RetrofitConfigBean.java

@@ -2,6 +2,7 @@
 
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseGlobalInterceptor;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.NetworkInterceptor;
+import com.github.lianjiatech.retrofit.spring.boot.interceptor.ServiceInstanceChooserInterceptor;
 import com.github.lianjiatech.retrofit.spring.boot.retry.BaseRetryInterceptor;
 import okhttp3.ConnectionPool;
 import retrofit2.CallAdapter;
@@ -30,6 +31,8 @@ public class RetrofitConfigBean {
 
     private BaseRetryInterceptor retryInterceptor;
 
+    private ServiceInstanceChooserInterceptor serviceInstanceChooserInterceptor;
+
     public RetrofitProperties getRetrofitProperties() {
         return retrofitProperties;
     }
@@ -87,4 +90,12 @@ public Collection<NetworkInterceptor> getNetworkInterceptors() {
     public void setNetworkInterceptors(Collection<NetworkInterceptor> networkInterceptors) {
         this.networkInterceptors = networkInterceptors;
     }
+
+    public ServiceInstanceChooserInterceptor getServiceInstanceChooserInterceptor() {
+        return serviceInstanceChooserInterceptor;
+    }
+
+    public void setServiceInstanceChooserInterceptor(ServiceInstanceChooserInterceptor serviceInstanceChooserInterceptor) {
+        this.serviceInstanceChooserInterceptor = serviceInstanceChooserInterceptor;
+    }
 }

src/main/java/com/github/lianjiatech/retrofit/spring/boot/core/NoValidServiceInstanceChooser.java

@@ -0,0 +1,23 @@
+package com.github.lianjiatech.retrofit.spring.boot.core;
+
+import com.github.lianjiatech.retrofit.spring.boot.exception.ServiceInstanceChooseException;
+
+import java.net.URI;
+
+/**
+ * @author 陈添明
+ */
+public class NoValidServiceInstanceChooser implements ServiceInstanceChooser {
+
+
+    /**
+     * Chooses a ServiceInstance URI from the LoadBalancer for the specified service.
+     *
+     * @param serviceId The service ID to look up the LoadBalancer.
+     * @return Return the uri of ServiceInstance
+     */
+    @Override
+    public URI choose(String serviceId) {
+        throw new ServiceInstanceChooseException("No valid service instance selector, Please configure it!");
+    }
+}