Merge pull request #39 from LianjiaTech/develop

RetrofitClient接口自动注册

Author: chentianming11

README.md

@@ -42,25 +42,10 @@
 <dependency>
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.2.0</version>
+    <version>2.2.1</version>
 </dependency>
 ```
 
-### 配置`@RetrofitScan`注解
-
-你可以给带有 `@Configuration` 的类配置`@RetrofitScan`，或者直接配置到`spring-boot`的启动类上，如下：
-
-```java
-@SpringBootApplication
-@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
-public class RetrofitTestApplication {
-
-    public static void main(String[] args) {
-        SpringApplication.run(RetrofitTestApplication.class, args);
-    }
-}
-```
-
 ### 定义http接口
 
 **接口必须使用`@RetrofitClient`注解标记**！http相关注解可参考官方文档：[retrofit官方文档](https://square.github.io/retrofit/)。
@@ -93,6 +78,9 @@ public class TestService {
 }
 ```
 
+**默认情况下，自动使用`SpringBoot`扫描路径进行`retrofitClient`注册**。你也可以在配置类加上`@RetrofitScan`手工指定扫描路径。
+
+
 ## HTTP请求相关注解
 
 `HTTP`请求相关注解，全部使用了`retrofit`原生注解。**详细信息可参考官方文档：[retrofit官方文档](https://square.github.io/retrofit/)**，以下是一个简单说明。

README_EN.md

@@ -43,25 +43,10 @@
 <dependency>
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.2.0</version>
+    <version>2.2.1</version>
 </dependency>
 ```
 
-### Configure `@RetrofitScan` annotation
-
-You can configure `@Configuration` for the class with `@RetrofitScan` or directly configure it to the startup class of `spring-boot`, as follows:
-
-```java
-@SpringBootApplication
-@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
-public class RetrofitTestApplication {
-
-    public static void main(String[] args) {
-        SpringApplication.run(RetrofitTestApplication.class, args);
-    }
-}
-```
-
 ### Define HTTP interface
 
 **The interface must be marked with `@RetrofitClient` annotation**! Related annotations of HTTP can refer to the official documents: [Retrofit official documents](https://square.github.io/retrofit/).
@@ -92,6 +77,8 @@ public class TestService {
 }
 ```
 
+**By default, the SpringBoot scan path is automatically used for retrofitClient registration**. You can also add `@RetrofitScan` to the configuration class to manually specify the scan path.
+
 ## Related annotations of HTTP request
 
 All of the related annotations of `HTTP` request use native annotations of `retrofit`. **For more information, please refer to the official document: [Retrofit official documents](https://square.github.io/retrofit/)**. The following is a brief description:

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.lianjiatech</groupId>
     <artifactId>retrofit-spring-boot-starter</artifactId>
-    <version>2.2.0</version>
+    <version>2.2.1</version>
 
     <name>retrofit-spring-boot-starter</name>
     <description>retrofit-spring-boot-starter</description>

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

@@ -1,6 +1,6 @@
 package com.github.lianjiatech.retrofit.spring.boot.annotation;
 
-import com.github.lianjiatech.retrofit.spring.boot.core.RetrofitClientRegistrar;
+import com.github.lianjiatech.retrofit.spring.boot.core.RetrofitClientScannerRegistrar;
 import org.springframework.context.annotation.Import;
 
 import java.lang.annotation.*;
@@ -11,7 +11,7 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 @Documented
-@Import(RetrofitClientRegistrar.class)
+@Import(RetrofitClientScannerRegistrar.class)
 public @interface RetrofitScan {
 
     /**

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

@@ -3,9 +3,7 @@
 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.NoValidServiceInstanceChooser;
-import com.github.lianjiatech.retrofit.spring.boot.core.PrototypeInterceptorBdfProcessor;
-import com.github.lianjiatech.retrofit.spring.boot.core.ServiceInstanceChooser;
+import com.github.lianjiatech.retrofit.spring.boot.core.*;
 import com.github.lianjiatech.retrofit.spring.boot.degrade.BaseResourceNameParser;
 import com.github.lianjiatech.retrofit.spring.boot.degrade.RetrofitDegradeRuleInitializer;
 import com.github.lianjiatech.retrofit.spring.boot.interceptor.BaseGlobalInterceptor;
@@ -17,6 +15,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.InitializingBean;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -26,6 +25,7 @@
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 import retrofit2.CallAdapter;
 import retrofit2.Converter;
 import retrofit2.converter.jackson.JacksonConverterFactory;
@@ -43,7 +43,7 @@
 @AutoConfigureAfter({JacksonAutoConfiguration.class})
 public class RetrofitAutoConfiguration implements ApplicationContextAware {
 
-    private final static Logger logger = LoggerFactory.getLogger(RetrofitAutoConfiguration.class);
+    private static final Logger logger = LoggerFactory.getLogger(RetrofitAutoConfiguration.class);
 
     @Autowired
     private RetrofitProperties retrofitProperties;
@@ -139,4 +139,15 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
     public RetrofitDegradeRuleInitializer retrofitDegradeRuleInitializer() {
         return new RetrofitDegradeRuleInitializer(retrofitProperties);
     }
+
+    @Configuration
+    @Import({AutoConfiguredRetrofitScannerRegistrar.class})
+    @ConditionalOnMissingBean(RetrofitFactoryBean.class)
+    public static class RetrofitScannerRegistrarNotFoundConfiguration implements InitializingBean {
+        @Override
+        public void afterPropertiesSet() {
+            logger.debug("No {} found.", RetrofitFactoryBean.class.getName());
+        }
+    }
+
 }

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

@@ -0,0 +1,78 @@
+package com.github.lianjiatech.retrofit.spring.boot.core;
+
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.BeanClassLoaderAware;
+import org.springframework.beans.factory.BeanFactory;
+import org.springframework.beans.factory.BeanFactoryAware;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
+import org.springframework.context.ResourceLoaderAware;
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.core.type.AnnotationMetadata;
+
+import java.util.List;
+
+/**
+ * This will just scan the same base package as Spring Boot does. If you want more power, you can explicitly use
+ * {@link com.github.lianjiatech.retrofit.spring.boot.annotation.RetrofitScan} but this will get typed mappers working correctly, out-of-the-box,
+ * similar to using Spring Data JPA repositories.
+ *
+ * @author 陈添明
+ */
+public class AutoConfiguredRetrofitScannerRegistrar implements BeanFactoryAware, ImportBeanDefinitionRegistrar, ResourceLoaderAware, BeanClassLoaderAware {
+
+    private static final Logger logger = LoggerFactory.getLogger(AutoConfiguredRetrofitScannerRegistrar.class);
+
+    private BeanFactory beanFactory;
+
+    private ResourceLoader resourceLoader;
+
+    private ClassLoader classLoader;
+
+    @Override
+    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
+        this.beanFactory = beanFactory;
+    }
+
+
+    @Override
+    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
+        if (!AutoConfigurationPackages.has(this.beanFactory)) {
+            logger.debug("Could not determine auto-configuration package, automatic retrofit scanning disabled.");
+            return;
+        }
+
+        logger.debug("Searching for retrofits annotated with @RetrofitClient");
+
+        List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
+        if (logger.isDebugEnabled()) {
+            packages.forEach(pkg -> logger.debug("Using auto-configuration base package '{}'", pkg));
+        }
+
+        // Scan the @RetrofitClient annotated interface under the specified path and register it to the BeanDefinitionRegistry
+        ClassPathRetrofitClientScanner scanner = new ClassPathRetrofitClientScanner(registry, classLoader);
+        if (resourceLoader != null) {
+            scanner.setResourceLoader(resourceLoader);
+        }
+        String[] packageArr = packages.toArray(new String[0]);
+        scanner.registerFilters();
+        // Scan and register to BeanDefinition
+        scanner.doScan(packageArr);
+    }
+
+
+    @Override
+    public void setResourceLoader(ResourceLoader resourceLoader) {
+        this.resourceLoader = resourceLoader;
+    }
+
+
+    @Override
+    public void setBeanClassLoader(ClassLoader classLoader) {
+        this.classLoader = classLoader;
+    }
+}

src/main/java/com/github/lianjiatech/retrofit/spring/boot/core/RetrofitClientRegistrar.java renamed to src/main/java/com/github/lianjiatech/retrofit/spring/boot/core/RetrofitClientScannerRegistrar.java

@@ -19,7 +19,7 @@
 /**
  * @author 陈添明
  */
-public class RetrofitClientRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, BeanClassLoaderAware {
+public class RetrofitClientScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, BeanClassLoaderAware {
 
     private ResourceLoader resourceLoader;
 
@@ -29,6 +29,9 @@ public class RetrofitClientRegistrar implements ImportBeanDefinitionRegistrar, R
     public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
         AnnotationAttributes attributes = AnnotationAttributes
                 .fromMap(metadata.getAnnotationAttributes(RetrofitScan.class.getName()));
+        if (attributes == null) {
+            return;
+        }
         // Scan the @RetrofitClient annotated interface under the specified path and register it to the BeanDefinitionRegistry
         ClassPathRetrofitClientScanner scanner = new ClassPathRetrofitClientScanner(registry, classLoader);
         if (resourceLoader != null) {

src/test/java/com/github/lianjiatech/retrofit/spring/boot/test/RetrofitTestApplication.java

@@ -1,6 +1,5 @@
 package com.github.lianjiatech.retrofit.spring.boot.test;
 
-import com.github.lianjiatech.retrofit.spring.boot.annotation.RetrofitScan;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.Bean;
@@ -11,7 +10,6 @@
  * @author 陈添明
  */
 @SpringBootApplication
-@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
 public class RetrofitTestApplication {
 
     public static void main(String[] args) {