From 989963edc4eb60ae386ec721c4f446a6419d40a1 Mon Sep 17 00:00:00 2001
From: mercyblitz <mercyblitz@gmail.com>
Date: Wed, 16 Jan 2019 13:19:23 +0800
Subject: [PATCH] Polish apache/incubator-dubbo#3193 : [Enhancement] Change the
 default behavior of @EnableDubboConfig.multiple()

---
 .../DubboConfigConfigurationRegistrar.java    | 44 +++----------------
 .../context/annotation/EnableDubboConfig.java |  9 ++--
 .../DubboConfigBindingRegistrarTest.java      | 14 +++++-
 .../DubboConfigBindingsRegistrarTest.java     |  2 +-
 .../DubboConfigConfigurationTest.java         |  4 +-
 .../annotation/EnableDubboConfigTest.java     | 44 +++++++------------
 .../test/resources/META-INF/config.properties |  2 +-
 7 files changed, 44 insertions(+), 75 deletions(-)

diff --git a/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationRegistrar.java b/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationRegistrar.java
index fc292411db2..ff20d8dfd5f 100644
--- a/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationRegistrar.java
+++ b/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationRegistrar.java
@@ -19,32 +19,23 @@
 import com.alibaba.dubbo.config.AbstractConfig;
 
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
-import org.springframework.context.EnvironmentAware;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.AnnotationAttributes;
-import org.springframework.core.env.Environment;
 import org.springframework.core.type.AnnotationMetadata;
 
 import static com.alibaba.dubbo.config.spring.util.AnnotatedBeanDefinitionRegistryUtils.registerBeans;
 
 
 /**
- * Dubbo {@link AbstractConfig Config} {@link ImportBeanDefinitionRegistrar register}, which order can be configured
+ * Dubbo {@link AbstractConfig Config} {@link ImportBeanDefinitionRegistrar register}
  *
  * @see EnableDubboConfig
  * @see DubboConfigConfiguration
  * @see Ordered
  * @since 2.5.8
  */
-public class DubboConfigConfigurationRegistrar implements ImportBeanDefinitionRegistrar, EnvironmentAware, Ordered {
-
-    /**
-     * The property name of {@link EnableDubboConfig}'s {@link Ordered order}
-     */
-    public static final String DUBBO_CONFIG_ORDER_PROPERTY_NAME = "dubbo.config.order";
-
-    private int order;
+public class DubboConfigConfigurationRegistrar implements ImportBeanDefinitionRegistrar {
 
     @Override
     public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
@@ -54,34 +45,11 @@ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, B
 
         boolean multiple = attributes.getBoolean("multiple");
 
-        if (multiple) {
+        // Single Config Bindings
+        registerBeans(registry, DubboConfigConfiguration.Single.class);
+
+        if (multiple) { // Since 2.6.6 https://github.com/apache/incubator-dubbo/issues/3193
             registerBeans(registry, DubboConfigConfiguration.Multiple.class);
-        } else {
-            registerBeans(registry, DubboConfigConfiguration.Single.class);
         }
     }
-
-    /**
-     * Set {@link Ordered order}, it may be changed in in the future.
-     *
-     * @param order {@link Ordered order}
-     */
-    public void setOrder(int order) {
-        this.order = order;
-    }
-
-    @Override
-    public int getOrder() {
-        return order;
-    }
-
-    @Override
-    public void setEnvironment(Environment environment) {
-        this.order = environment.getProperty(DUBBO_CONFIG_ORDER_PROPERTY_NAME, int.class, LOWEST_PRECEDENCE);
-    }
-
-    private static <T> T[] of(T... values) {
-        return values;
-    }
-
 }
\ No newline at end of file
diff --git a/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfig.java b/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfig.java
index 8c70e114c4b..ad394f7f093 100644
--- a/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfig.java
+++ b/dubbo-config/dubbo-config-spring/src/main/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfig.java
@@ -46,7 +46,7 @@
  * <li>{@link ConsumerConfig} binding to property :  "dubbo.consumer"</li>
  * </ul>
  * <p>
- * In contrast, on multiple bean bindings that requires to set {@link #multiple()} to be <code>true</code> :
+ * On multiple bean bindings that requires to set {@link #multiple()} to be <code>true</code> :
  * <ul>
  * <li>{@link ApplicationConfig} binding to property : "dubbo.applications"</li>
  * <li>{@link ModuleConfig} binding to property :  "dubbo.modules"</li>
@@ -71,10 +71,13 @@
 
     /**
      * It indicates whether binding to multiple Spring Beans.
+     * <p>
+     * Please note that if {@link #multiple()} is <code>true</code> since 2.6.6, the multiple bean bindings will be
+     * enabled, works with single bean bindings, rather than they are mutually exclusive before.
      *
-     * @return the default value is <code>false</code>
+     * @return the default value is <code>true</code> since 2.6.6, the value is inverse earlier.
      * @revised 2.5.9
      */
-    boolean multiple() default false;
+    boolean multiple() default true;
 
 }
diff --git a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingRegistrarTest.java b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingRegistrarTest.java
index 853df842ba8..30fc54a6708 100644
--- a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingRegistrarTest.java
+++ b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingRegistrarTest.java
@@ -23,6 +23,11 @@
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.PropertySource;
 
+import java.util.Set;
+import java.util.TreeSet;
+
+import static java.util.Arrays.asList;
+
 /**
  * {@link DubboConfigBindingRegistrar}
  *
@@ -55,9 +60,14 @@ public void testRegisterBeanDefinitionsForMultiple() {
 
         context.refresh();
 
-        ApplicationConfig applicationConfig = context.getBean("applicationBean", ApplicationConfig.class);
+        Set<String> expectedBeanNames = new TreeSet<String>(asList("applicationBean1", "applicationBean2", "applicationBean3"));
+        Set<String> actualBeanNames = new TreeSet<String>(asList(context.getBeanNamesForType(ApplicationConfig.class)));
 
-        Assert.assertEquals("dubbo-demo-application", applicationConfig.getName());
+        Assert.assertEquals(expectedBeanNames, actualBeanNames);
+
+        ApplicationConfig applicationConfig = context.getBean("applicationBean1", ApplicationConfig.class);
+
+        Assert.assertEquals("dubbo-demo-application1", applicationConfig.getName());
 
         applicationConfig = context.getBean("applicationBean2", ApplicationConfig.class);
 
diff --git a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingsRegistrarTest.java b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingsRegistrarTest.java
index a73dbf2c62a..b871983fb70 100644
--- a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingsRegistrarTest.java
+++ b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigBindingsRegistrarTest.java
@@ -50,7 +50,7 @@ public void test() {
 
     @EnableDubboConfigBindings({
             @EnableDubboConfigBinding(prefix = "${application.prefix}", type = ApplicationConfig.class),
-            @EnableDubboConfigBinding(prefix = "dubbo.applications.applicationBean", type = ApplicationConfig.class)
+            @EnableDubboConfigBinding(prefix = "dubbo.applications.applicationBean1", type = ApplicationConfig.class)
     })
     @PropertySource("META-INF/config.properties")
     private static class TestConfig {
diff --git a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationTest.java b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationTest.java
index ff21bcd0197..5a4222eb741 100644
--- a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationTest.java
+++ b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/DubboConfigConfigurationTest.java
@@ -84,8 +84,8 @@ public void testMultiple() {
         context.refresh();
 
         // application
-        ApplicationConfig applicationConfig = context.getBean("applicationBean", ApplicationConfig.class);
-        Assert.assertEquals("dubbo-demo-application", applicationConfig.getName());
+        ApplicationConfig applicationConfig = context.getBean("applicationBean1", ApplicationConfig.class);
+        Assert.assertEquals("dubbo-demo-application1", applicationConfig.getName());
 
         ApplicationConfig applicationBean2 = context.getBean("applicationBean2", ApplicationConfig.class);
         Assert.assertEquals("dubbo-demo-application2", applicationBean2.getName());
diff --git a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfigTest.java b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfigTest.java
index f52f3af5fba..cb581190163 100644
--- a/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfigTest.java
+++ b/dubbo-config/dubbo-config-spring/src/test/java/com/alibaba/dubbo/config/spring/context/annotation/EnableDubboConfigTest.java
@@ -23,19 +23,17 @@
 import com.alibaba.dubbo.config.ProtocolConfig;
 import com.alibaba.dubbo.config.ProviderConfig;
 import com.alibaba.dubbo.config.RegistryConfig;
+import com.alibaba.dubbo.config.spring.util.ObjectUtils;
 
 import org.junit.Assert;
 import org.junit.Test;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.PropertySource;
-import org.springframework.core.env.ConfigurableEnvironment;
-import org.springframework.core.env.MapPropertySource;
-import org.springframework.core.env.StandardEnvironment;
 
-import java.util.HashMap;
-import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
 
-import static com.alibaba.dubbo.config.spring.context.annotation.DubboConfigConfigurationRegistrar.DUBBO_CONFIG_ORDER_PROPERTY_NAME;
+import static java.util.Arrays.asList;
 
 /**
  * {@link EnableDubboConfig} Test
@@ -44,26 +42,6 @@
  */
 public class EnableDubboConfigTest {
 
-    @Test
-    public void testOrder() {
-        Map<String, Object> source = new HashMap<String, Object>();
-        source.put(DUBBO_CONFIG_ORDER_PROPERTY_NAME, "1");
-        MapPropertySource propertySource = new MapPropertySource("test-property-source", source);
-        ConfigurableEnvironment environment = new StandardEnvironment();
-
-        environment.getPropertySources().addFirst(propertySource);
-
-        DubboConfigConfigurationRegistrar selector = new DubboConfigConfigurationRegistrar();
-
-        selector.setEnvironment(environment);
-
-        Assert.assertEquals(1, selector.getOrder());
-
-        selector.setOrder(2);
-
-        Assert.assertEquals(2, selector.getOrder());
-    }
-
     @Test
     public void testSingle() {
 
@@ -75,6 +53,8 @@ public void testSingle() {
         ApplicationConfig applicationConfig = context.getBean("applicationBean", ApplicationConfig.class);
         Assert.assertEquals("dubbo-demo-application", applicationConfig.getName());
 
+        Assert.assertArrayEquals(ObjectUtils.of("applicationBean"), context.getBeanNamesForType(ApplicationConfig.class));
+
         // module
         ModuleConfig moduleConfig = context.getBean("moduleBean", ModuleConfig.class);
         Assert.assertEquals("dubbo-demo-module", moduleConfig.getName());
@@ -110,10 +90,18 @@ public void testMultiple() {
         context.register(TestMultipleConfig.class);
         context.refresh();
 
+        Set<String> expectedBeanNames = new TreeSet<String>(asList("applicationBean", "applicationBean1", "applicationBean2", "applicationBean3"));
+        Set<String> actualBeanNames = new TreeSet<String>(asList(context.getBeanNamesForType(ApplicationConfig.class)));
+
+        Assert.assertEquals(expectedBeanNames, actualBeanNames);
+
         // application
         ApplicationConfig applicationConfig = context.getBean("applicationBean", ApplicationConfig.class);
         Assert.assertEquals("dubbo-demo-application", applicationConfig.getName());
 
+        applicationConfig = context.getBean("applicationBean1", ApplicationConfig.class);
+        Assert.assertEquals("dubbo-demo-application1", applicationConfig.getName());
+
         ApplicationConfig applicationBean2 = context.getBean("applicationBean2", ApplicationConfig.class);
         Assert.assertEquals("dubbo-demo-application2", applicationBean2.getName());
 
@@ -122,13 +110,13 @@ public void testMultiple() {
 
     }
 
-    @EnableDubboConfig(multiple = true)
+    @EnableDubboConfig
     @PropertySource("META-INF/config.properties")
     private static class TestMultipleConfig {
 
     }
 
-    @EnableDubboConfig
+    @EnableDubboConfig(multiple = false)
     @PropertySource("META-INF/config.properties")
     private static class TestConfig {
 
diff --git a/dubbo-config/dubbo-config-spring/src/test/resources/META-INF/config.properties b/dubbo-config/dubbo-config-spring/src/test/resources/META-INF/config.properties
index 6e728ccb208..d635aa97f93 100644
--- a/dubbo-config/dubbo-config-spring/src/test/resources/META-INF/config.properties
+++ b/dubbo-config/dubbo-config-spring/src/test/resources/META-INF/config.properties
@@ -27,6 +27,6 @@ dubbo.provider.host = 127.0.0.1
 dubbo.consumer.client = netty
 
 # multiple Bean definition
-dubbo.applications.applicationBean.name = dubbo-demo-application
+dubbo.applications.applicationBean1.name = dubbo-demo-application1
 dubbo.applications.applicationBean2.name = dubbo-demo-application2
 dubbo.applications.applicationBean3.name = dubbo-demo-application3
\ No newline at end of file