pump version, public ConfigurationChangedEvent with diff props

Author: Joey Yang

README-zh.md

@@ -41,15 +41,15 @@ Maven
 
 <dependency>
     <groupId>top.code2life</groupId>
-    <artifactId>spring-boot-dynamic-config</artifactId>
-    <version>1.0.6</version>
+   <artifactId>spring-boot-dynamic-config</artifactId>
+   <version>1.0.7</version>
 </dependency>
 ```
 
 Gradle
 
 ```groovy
-implementation 'top.code2life:spring-boot-dynamic-config:1.0.6'
+implementation 'top.code2life:spring-boot-dynamic-config:1.0.7'
 ```
 
 ### 步骤二：在代码中添加 @DynamicConfig 注解

README.md

@@ -42,14 +42,14 @@ Maven
 <dependency>
     <groupId>top.code2life</groupId>
    <artifactId>spring-boot-dynamic-config</artifactId>
-   <version>1.0.6</version>
+   <version>1.0.7</version>
 </dependency>
 ```
 
 Gradle
 
 ```groovy
-implementation 'top.code2life:spring-boot-dynamic-config:1.0.6'
+implementation 'top.code2life:spring-boot-dynamic-config:1.0.7'
 ```
 
 ### Step2. Add @DynamicConfig Annotation

build.gradle

@@ -16,7 +16,7 @@ java {
 }
 
 group = 'top.code2life'
-version = '1.0.6'
+version = '1.0.7'
 sourceCompatibility = JavaVersion.VERSION_1_8
 
 repositories {

example/build.gradle

@@ -27,5 +27,5 @@ dependencies {
 	annotationProcessor 'org.projectlombok:lombok:1.18.20'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 
-	implementation 'top.code2life:spring-boot-dynamic-config:1.0.6'
+	implementation 'top.code2life:spring-boot-dynamic-config:1.0.7'
 }

src/main/java/top/code2life/config/ConfigurationChangedEvent.java

@@ -3,7 +3,8 @@
 import lombok.Getter;
 import lombok.Setter;
 import org.springframework.context.ApplicationEvent;
-import org.springframework.core.env.PropertySource;
+
+import java.util.Map;
 
 /**
  * Application event that represents configuration file has been changed
@@ -16,18 +17,12 @@
 public class ConfigurationChangedEvent extends ApplicationEvent {
 
     /**
-     * previous property source of changed config file
-     */
-    private PropertySource<?> previous;
-
-    /**
-     * current property source of changed config file
+     * The diff properties, keys are normalized, values are newest values
      */
-    private PropertySource<?> current;
+    private Map<Object, Object> diff;
 
-    ConfigurationChangedEvent(String path, PropertySource<?> previous, PropertySource<?> current) {
-        super(path);
-        this.previous = previous;
-        this.current = current;
+    ConfigurationChangedEvent(Map<Object, Object> diff) {
+        super(diff.keySet());
+        this.diff = diff;
     }
 }

src/main/java/top/code2life/config/ConfigurationChangedEventHandler.java

@@ -11,7 +11,10 @@
 import org.springframework.boot.context.properties.ConfigurationPropertiesBindingPostProcessor;
 import org.springframework.boot.origin.OriginTrackedValue;
 import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.event.EventListener;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
 import org.springframework.util.StringUtils;
 
 import java.lang.reflect.Field;
@@ -38,8 +41,11 @@ public class ConfigurationChangedEventHandler {
     private final BeanExpressionContext exprContext;
     private final ConfigurationPropertiesBindingPostProcessor processor;
     private final ConfigurableListableBeanFactory beanFactory;
+    private final ApplicationEventPublisher eventPublisher;
 
-    ConfigurationChangedEventHandler(ApplicationContext applicationContext, BeanFactory beanFactory) {
+    ConfigurationChangedEventHandler(ApplicationContext applicationContext, BeanFactory beanFactory,
+                                     ApplicationEventPublisher eventPublisher) {
+        this.eventPublisher = eventPublisher;
         if (!(beanFactory instanceof ConfigurableListableBeanFactory)) {
             throw new IllegalArgumentException(
                     "DynamicConfig requires a ConfigurableListableBeanFactory");
@@ -56,9 +62,10 @@ public class ConfigurationChangedEventHandler {
      *
      * @param event ConfigurationChangedEvent indicates a configuration file changed event
      */
-    @EventListener
     @SuppressWarnings("unchecked")
-    public synchronized void handleEvent(ConfigurationChangedEvent event) {
+    @Order(Ordered.HIGHEST_PRECEDENCE)
+    @EventListener(ConfigurationFileChangedEvent.class)
+    public synchronized void handleEvent(ConfigurationFileChangedEvent event) {
         try {
             Map<Object, Object> diff = getPropertyDiff((Map<Object, OriginTrackedValue>) event.getPrevious().getSource(), (Map<Object, OriginTrackedValue>) event.getCurrent().getSource());
             Map<String, ValueBeanFieldBinder> toRefreshProps = new HashMap<>(4);
@@ -69,6 +76,7 @@ public synchronized void handleEvent(ConfigurationChangedEvent event) {
             }
             rebindRelatedConfigurationPropsBeans(diff, toRefreshProps);
             log.info("config changes of {} have been processed", event.getSource());
+            eventPublisher.publishEvent(new ConfigurationChangedEvent(diff));
         } catch (Exception ex) {
             log.warn("config changes of {} can not be processed, error:", event.getSource(), ex);
         }

src/main/java/top/code2life/config/ConfigurationFileChangedEvent.java

@@ -0,0 +1,33 @@
+package top.code2life.config;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.springframework.context.ApplicationEvent;
+import org.springframework.core.env.PropertySource;
+
+/**
+ * Application event that represents configuration file has been changed
+ *
+ * @author Code2Life
+ * @see DynamicConfigPropertiesWatcher
+ */
+@Getter
+@Setter
+public class ConfigurationFileChangedEvent extends ApplicationEvent {
+
+    /**
+     * previous property source of changed config file
+     */
+    private PropertySource<?> previous;
+
+    /**
+     * current property source of changed config file
+     */
+    private PropertySource<?> current;
+
+    ConfigurationFileChangedEvent(String path, PropertySource<?> previous, PropertySource<?> current) {
+        super(path);
+        this.previous = previous;
+        this.current = current;
+    }
+}

src/main/java/top/code2life/config/DynamicConfigPropertiesWatcher.java

@@ -34,7 +34,7 @@
  * listening any changes on configuration files, then publish ConfigurationChangedEvent.
  *
  * @author Code2Life
- * @see ConfigurationChangedEvent
+ * @see ConfigurationFileChangedEvent
  */
 @Slf4j
 @ConditionalOnProperty("spring.config.location")
@@ -230,7 +230,7 @@ private void loadPropertiesAndPublishEvent(PropertySourceMeta propertySourceMeta
             return;
         }
         PropertySource<?> newProps = newPropsList.get(0);
-        ConfigurationChangedEvent event = new ConfigurationChangedEvent(path, env.getPropertySources().get(propertySourceName), newProps);
+        ConfigurationFileChangedEvent event = new ConfigurationFileChangedEvent(path, env.getPropertySources().get(propertySourceName), newProps);
         env.getPropertySources().replace(propertySourceName, newProps);
         propertySourceMeta.setLastModifyTime(modifyTime);
         eventPublisher.publishEvent(event);