add demo screenshot, improve documents and example codes

Author: Joey Yang

README-zh.md

@@ -1,19 +1,21 @@
-<p align="center">
+## Spring Boot Dynamic Config
+
+<p align="left">
+<br>
 <a href="https://github.com/code2life/spring-boot-dynamic-config"><img src="https://github.com/code2life/spring-boot-dynamic-config/actions/workflows/gradle.yml/badge.svg" /></a>
-<a href="https://github.com/code2life/spring-boot-dynamic-config/actions/workflows/gradle.yml">coverage<img src=".github/badges/jacoco.svg" /></a>
+<a href="https://github.com/code2life/spring-boot-dynamic-config/actions/workflows/gradle.yml"><img src=".github/badges/jacoco.svg" /></a>
 <a href="https://codebeat.co/projects/github-com-code2life-spring-boot-dynamic-config-main"><img alt="codebeat badge" src="https://codebeat.co/badges/ea7b2127-62f3-45f4-9f38-55f8203c0121" /></a>
+<br>
 </p>
 
-## Spring Boot Dynamic Config
-
 一个注解实现SpringBoot应用的**动态配置**，配置热重载最简洁的方案。
 
 [English](https://github.com/Code2Life/spring-boot-dynamic-config/blob/main/README.md) [简体中文](https://github.com/Code2Life/spring-boot-dynamic-config/blob/main/README-zh.md)
 
 - :heart: **无侵入**，完全兼容SpringBoot原生的配置获取方式（@Value / @ConfigurationProperties）
 - :zap: **超轻量，超快响应**, 不依赖SpringBoot核心库以外的任何三方库
 - :grinning: **极易使用**, 只提供一个简单的注解: @DynamicConfig；一个事件：ConfigurationChangedEvent
-- ☸ 在K8S集群中运行SpringBoot/SpringCloud应用，与K8S ConfigMap完美结合的方案
+- ☸ 在K8S集群中和K8S ConfigMap完美结合的SpringBoot/SpringCloud应用的动态配置方式
 
 #### 相比于spring-cloud-starter-config：
 
@@ -27,6 +29,8 @@
 
 ## 演示
 
+<img src="example/demo.gif" alt="Demo" />
+
 ## 快速开始
 
 ### 步骤一：添加依赖spring-boot-dynamic-config

README.md

@@ -1,39 +1,44 @@
-<p align="center">
+## Spring Boot Dynamic Config
+
+<p align="left">
+<br>
 <a href="https://github.com/code2life/spring-boot-dynamic-config"><img src="https://github.com/code2life/spring-boot-dynamic-config/actions/workflows/gradle.yml/badge.svg" /></a>
-<a href="https://github.com/code2life/spring-boot-dynamic-config/actions/workflows/gradle.yml">coverage<img src=".github/badges/jacoco.svg" /></a>
+<a href="https://github.com/code2life/spring-boot-dynamic-config/actions/workflows/gradle.yml"><img src=".github/badges/jacoco.svg" /></a>
 <a href="https://codebeat.co/projects/github-com-code2life-spring-boot-dynamic-config-main"><img alt="codebeat badge" src="https://codebeat.co/badges/ea7b2127-62f3-45f4-9f38-55f8203c0121" /></a>
+<br>
 </p>
 
-## Spring Boot Dynamic Config
-
 Hot-reload your SpringBoot configurations, with just a '@DynamicConfig' annotation, the simplest solution, ever.
 
 [English](https://github.com/Code2Life/spring-boot-dynamic-config/blob/main/README.md) [简体中文](https://github.com/Code2Life/spring-boot-dynamic-config/blob/main/README-zh.md)
 
 - :heart: **Non-intrusive**, compatible with SpringBoot native ways (@Value, @ConfigurationProperties)
 - :zap: **Lightweight & Blazing Fast**, depend on nothing but SpringBoot core libs
 - :grinning: **Extremely easy to use**, only provide an annotation: @DynamicConfig, an event: ConfigurationChangedEvent
-- ☸ Perfect solution for running SpringBoot on Kubernetes, combine with K8S ConfigMap
-
+- ☸ Perfect solution for host-reloading configurations of SpringBoot application on Kubernetes, with K8S ConfigMap
 
 #### Compare with spring-cloud-starter-config
 
 - No need for config server
 - No SpringCloud dependency and @RefreshScope annotation, won't destroy and rebuild beans
 
 #### Compare with Alibaba Nacos / Ctripcorp Apollo
+
 - No need for Nacos/Apollo server
 - No need for learning Annotations, Client APIs, etc.
 
 ## Demo
 
+<img src="example/demo.gif" alt="Demo" />
+
 ## Getting Started
 
 ### Step1. Add spring-boot-dynamic-config Dependency
 
 Maven
 
 ```xml
+
 <dependency>
     <groupId>top.code2life</groupId>
     <artifactId>spring-boot-dynamic-config</artifactId>
@@ -106,9 +111,9 @@ import java.util.Map;
 public class TestConfigurationProperties {
 
     private String str;
-    
+
     private Double doubleVal;
-    
+
     private Map<String, Object> mapVal;
 }
 
@@ -127,24 +132,27 @@ public class TestConfigurationProperties {
 java -jar your-spring-boot-app.jar --spring.config.location=/path/to/config
 ```
 
-Then, modifications on /path/to/config/application-<some-profile>.yml will take effect and reflect on @DynamicConfig beans **immediately**.
+Then, modifications on /path/to/config/application-<some-profile>.yml will take effect and reflect on @DynamicConfig
+beans **immediately**.
 
 ### Best Practices
+
 - Configuration as Code, Everything as Code
 - Configurations should be maintained in Git, rather than any GUI system.
 - Configurations should be applied to dev/production environments by Continuous Integration system.
-- Git-Based DevOps workflow is the modern way of operating services, at scale. 
+- Git-Based DevOps workflow is the modern way of operating services, at scale.
 
 ## Implementation
 
 1. Bean 'DynamicConfigPropertiesWatcher' will be initialized if 'spring.config.location' is specified
 2. Bean 'DynamicConfigBeanPostProcessor' will be initialized if 'DynamicConfigPropertiesWatcher' exists
-3. DynamicConfigBeanPostProcessor collects beans' metadata after initializing 
+3. DynamicConfigBeanPostProcessor collects beans' metadata after initializing
 4. DynamicConfigPropertiesWatcher watches configuration directory, then replace PropertySource in Environment on changes
 5. DynamicConfigPropertiesWatcher publishes 'ConfigurationChangedEvent'
 6. DynamicConfigBeanPostProcessor listens 'ConfigurationChangedEvent', calculate diff
 7. For each changed key, DynamicConfigBeanPostProcessor will use preserved bean metadata to check if it's related
-8. After filtering related beans, it will use reflect API or ConfigurationPropertiesBindingPostProcessor API to modify fields of existing bean
+8. After filtering related beans, it will use reflect API or ConfigurationPropertiesBindingPostProcessor API to modify
+   fields of existing bean
 
 ## Compatibility
 
@@ -158,10 +166,12 @@ Any SpringBoot/SpringCloud application within following SpringBoot version can u
 - √ SpringBoot 2.0.x
 - X SpringBoot 1.5.x and Lower
 
-NOTES: 
+NOTES:
+
 - For SpringBoot 2.0.x, use Junit4 rather than Junit5.
 - This lib does not depend on ANY other libs except SpringBoot core libs.
 
 ## License
 
-Spring Boot Dynamic Config is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
+Spring Boot Dynamic Config is Open Source software released under
+the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

example/build.gradle

@@ -3,46 +3,29 @@ buildscript {
 		springBootVersion = '2.1.0.RELEASE'
 	}
 }
-
 plugins {
 	id 'org.springframework.boot' version "${springBootVersion}"
 	id 'java-library'
 }
 
 group = 'com.example'
-version = '0.0.1-SNAPSHOT'
+version = '1.0.0'
 sourceCompatibility = JavaVersion.VERSION_1_8
 
-configurations {
-	compileOnly {
-		extendsFrom annotationProcessor
-	}
-}
-
 bootJar {
 	mainClassName "com.example.demo.DemoApplication"
 }
 
 repositories {
 	mavenCentral()
-	maven {
-		url "https://s01.oss.sonatype.org/content/repositories/snapshots"
-	}
 }
 
 dependencies {
 	api platform("org.springframework.boot:spring-boot-dependencies:${springBootVersion}")
 
 	compileOnly 'org.projectlombok:lombok:1.18.20'
 	annotationProcessor 'org.projectlombok:lombok:1.18.20'
-
-	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
-	implementation 'top.code2life:spring-boot-dynamic-config:1.0.3-SNAPSHOT'
-
-	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-}
 
-test {
-	useJUnitPlatform()
-}
+	implementation 'top.code2life:spring-boot-dynamic-config:1.0.4'
+}

example/demo.gif

@@ -1,10 +1,9 @@
 package com.example.demo;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.Data;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.core.Ordered;
-import org.springframework.core.annotation.Order;
 import top.code2life.config.DynamicConfig;
 
 import java.util.List;
@@ -17,6 +16,7 @@
 @DynamicConfig
 @ConfigurationProperties(prefix = "dynamic.prop")
 @Configuration
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class DemoConfigProperties {
 
     private String str;
@@ -25,8 +25,6 @@ public class DemoConfigProperties {
 
     private List<Integer> listVal;
 
-    private List<DemoConfigProperties> nestedList;
-
     private Map<String, DemoConfigProperties> nestedMap;
 
     private DemoConfigProperties nested;

example/src/main/java/com/example/demo/DemoConfigProperties.java

@@ -1,15 +1,14 @@
 package com.example.demo;
 
 import lombok.RequiredArgsConstructor;
-import org.springframework.beans.factory.annotation.Value;
+import org.springframework.beans.BeanUtils;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
-import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
-import top.code2life.config.DynamicConfig;
 import top.code2life.config.FeatureGate;
 
-import java.util.Set;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * @author Code2Life
@@ -19,10 +18,6 @@
 public class DemoController {
 
 
-    @DynamicConfig
-    @Value("#{@featureGate.convert('${some.feature.beta-list}')}")
-    private Set<String> betaUserList;
-
     private final DemoConfigProperties demoConfigProps;
 
     private final DemoDynamicValue demoDynamicValue;
@@ -31,23 +26,14 @@ public class DemoController {
 
     @RequestMapping(value = "/demo", method = RequestMethod.GET)
     public Object getDemoConfigProps() {
-        DemoConfigProperties resp = new DemoConfigProperties();
-        resp.setStr(demoConfigProps.getStr());
-        resp.setListVal(demoConfigProps.getListVal());
-        resp.setMapVal(demoConfigProps.getMapVal());
-        resp.setNestedList(demoConfigProps.getNestedList());
-        resp.setNestedMap(demoConfigProps.getNestedMap());
-        resp.setNested(demoConfigProps.getNested());
+        Map<String, Object> resp = new HashMap<>(4);
+        DemoConfigProperties configurationProps = new DemoConfigProperties();
+        BeanUtils.copyProperties(demoConfigProps, configurationProps);
+        resp.put("valuePlaceHolder", demoDynamicValue.getDynamicHello());
+        resp.put("valueSpringEL", demoDynamicValue.getBetaUserList());
+        resp.put("someUserInWhiteList", featureGate.isFeatureEnabled(demoDynamicValue.getBetaUserList(), "user4"));
+        resp.put("betaFeatureEnabled", featureGate.isFeatureEnabled("beta.enabled"));
+        resp.put("configurationPropertiesObj", configurationProps);
         return resp;
     }
-
-    @RequestMapping(value = "/demo2", method = RequestMethod.GET)
-    public String getDemoConfig2() {
-        return demoDynamicValue.getDynamicHello();
-    }
-
-    @RequestMapping(value = "/demo3", method = RequestMethod.GET)
-    public boolean isUserInBetaList(@RequestParam String id) {
-        return featureGate.isFeatureEnabled(betaUserList, id);
-    }
 }

example/src/main/java/com/example/demo/DemoController.java

@@ -2,17 +2,22 @@
 
 import lombok.Getter;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.context.annotation.Configuration;
+import org.springframework.stereotype.Component;
 import top.code2life.config.DynamicConfig;
 
+import java.util.Set;
+
 /**
  * @author Code2Life
  **/
 @Getter
 @DynamicConfig
-@Configuration
+@Component
 public class DemoDynamicValue {
 
     @Value("${dynamic.hello-world}")
     private String dynamicHello;
+
+    @Value("#{@featureGate.convert('${some.feature.beta-list}')}")
+    private Set<String> betaUserList;
 }

example/src/main/java/com/example/demo/DemoDynamicValue.java

@@ -1,23 +1,21 @@
+# Run application with specified config location:
+# eg: java -jar app.jar --spring.config.location=src/main/resources/
+# then, it just works !
+dynamic.hello-world: Hello @DynamicConfig Awesome !!!
+beta.enabled: false
+some:
+  feature:
+    beta-list: user1, user2, user3,
 dynamic:
   prop:
-    str: hello
+    str: Hello @ConfigurationProperties !
     map-val:
       k1: v1
+
       k2: v2
-    list-val:
+    listVal:
       - 1
       - 2
       - 3
-    nested-list:
-      - str: hello-inner
-        map-val:
-          k2-inner: v1-inner
-    nested_map:
-      m1:
-        str: hello-map
-        list-val: [5,6,7]
-
     nested:
-      str: hello-recursive-1
-      map-val:
-        x1: y1
+      str: Hello Recursive ! Awesome !!!

example/src/main/java/com/example/demo/DemoSubConfig.java

@@ -3,12 +3,6 @@ spring:
     include:
       - another-profile
 
-dynamic:
-  hello-world: Hello World !!!
-some:
-  feature:
-    beta-list: user1, user2, user3
-
 logging:
   level:
     top.code2life: debug