fix(pom): Merge metadata module into autoconfigure module

oxsean · Nov 7, 2023 · 8c62620 · 8c62620
1 parent 88deb9b
commit 8c62620
Show file tree

Hide file tree

Showing 10 changed files with 94 additions and 220 deletions.
diff --git a/.artifacts b/.artifacts
@@ -107,7 +107,6 @@ dubbo-spring-boot-actuator
 dubbo-spring-boot-actuator-compatible
 dubbo-spring-boot-autoconfigure
 dubbo-spring-boot-autoconfigure-compatible
-dubbo-spring-boot-configuration-metadata-compatible
 dubbo-spring-boot-compatible
 dubbo-observability-spring-boot-starters
 dubbo-observability-spring-boot-autoconfigure

diff --git a/dubbo-distribution/dubbo-bom/pom.xml b/dubbo-distribution/dubbo-bom/pom.xml
@@ -643,11 +643,6 @@
                 <artifactId>dubbo-spring-boot-autoconfigure-compatible</artifactId>
                 <version>${project.version}</version>
             </dependency>
-            <dependency>
-                <groupId>org.apache.dubbo</groupId>
-                <artifactId>dubbo-spring-boot-configuration-metadata-compatible</artifactId>
-                <version>${project.version}</version>
-            </dependency>
             <dependency>
                 <groupId>org.apache.dubbo</groupId>
                 <artifactId>dubbo-spring-boot-starter</artifactId>

diff --git a/...spring-boot-compatible/metadata/README.md → ...g-boot-compatible/autoconfigure/README.md b/...spring-boot-compatible/metadata/README.md → ...g-boot-compatible/autoconfigure/README.md
@@ -1,4 +1,4 @@
-# About dubbo-spring-boot-configuration-metadata-compatible module
+# About spring-configuration-metadata
 
 ## Why
 
@@ -10,9 +10,7 @@ This leads to missing comments and a lack of nested configuration options. There
 
 1. Copy classes under `org/apache/dubbo/config` from `dubbo-common` to the `generated-sources` directory.
 2. Replace `@Nest` with `@NestedConfigurationProperty`.
-3. Copy the class `DubboConfigurationProperties.java` from `autoconfigure` to the `generated-sources` directory.
-4. Use an annotation-only option to compile and generate `spring-configuration-metadata.json`.
-5. During `autoconfigure` module compilation, will read `spring-configuration-metadata.json` from this module.
+3. Use an annotation-only option to compile and generate `spring-configuration-metadata.json`.
 
 ## How to add a new configuration option
 

diff --git a/dubbo-spring-boot/dubbo-spring-boot-compatible/autoconfigure/pom.xml b/dubbo-spring-boot/dubbo-spring-boot-compatible/autoconfigure/pom.xml
@@ -29,6 +29,10 @@
     <artifactId>dubbo-spring-boot-autoconfigure-compatible</artifactId>
     <description>Apache Dubbo Spring Boot Compatible for Spring Boot 1.x Auto-Configure</description>
 
+    <properties>
+        <sources_directory>${project.build.directory}/generated-sources/java</sources_directory>
+    </properties>
+
     <dependencies>
         <!-- Spring Boot dependencies -->
         <dependency>
@@ -70,10 +74,9 @@
         </dependency>
 
         <dependency>
-            <groupId>org.apache.dubbo</groupId>
-            <artifactId>dubbo-spring-boot-configuration-metadata-compatible</artifactId>
-            <version>${project.version}</version>
-            <scope>provided</scope>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
+            <optional>true</optional>
         </dependency>
 
         <!-- Test Dependencies -->
@@ -85,17 +88,87 @@
     </dependencies>
 
     <build>
-        <resources>
-            <resource>
-                <directory>src/main/resources</directory>
-            </resource>
-            <resource>
-                <targetPath>META-INF</targetPath>
-                <directory>../metadata/target/classes/META-INF</directory>
-                <includes>
-                    <include>spring-configuration-metadata.json</include>
-                </includes>
-            </resource>
-        </resources>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-antrun-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>copy-sources</id>
+                        <phase>generate-sources</phase>
+                        <goals>
+                            <goal>run</goal>
+                        </goals>
+                        <configuration>
+                            <target>
+                                <delete dir="${sources_directory}" quiet="true"/>
+                                <copy todir="${sources_directory}">
+                                    <fileset dir="../../../dubbo-common/src/main/java">
+                                        <include name="org/apache/dubbo/config/**/*.java"/>
+                                    </fileset>
+                                </copy>
+                                <replace token="@Nested" value="@org.springframework.boot.context.properties.NestedConfigurationProperty">
+                                    <fileset dir="${sources_directory}">
+                                        <include name="**/*.java"/>
+                                    </fileset>
+                                </replace>
+                            </target>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>clean-sources</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>run</goal>
+                        </goals>
+                        <configuration>
+                            <target>
+                                <delete dir="${sources_directory}" quiet="true"/>
+                            </target>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>build-helper-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>add-sources</id>
+                        <phase>generate-sources</phase>
+                        <goals>
+                            <goal>add-source</goal>
+                        </goals>
+                        <configuration>
+                            <sources>
+                                <source>${sources_directory}</source>
+                            </sources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>gen-metadata</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                        <configuration combine.self="override">
+                            <proc>only</proc>
+                            <fork>true</fork>
+                        </configuration>
+                    </execution>
+                </executions>
+                <configuration>
+                    <excludes>
+                        <exclude>**/DubboMetadataGenerateAutoConfiguration.java</exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
+        </plugins>
     </build>
 </project>
diff --git a/...rc/main/java/org/apache/dubbo/spring/boot/autoconfigure/DubboConfigurationProperties.java b/...rc/main/java/org/apache/dubbo/spring/boot/autoconfigure/DubboConfigurationProperties.java
@@ -36,13 +36,15 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+import static org.apache.dubbo.spring.boot.util.DubboUtils.DUBBO_PREFIX;
+
 /**
  * Dubbo {@link ConfigurationProperties Config Properties} only used to generate JSON metadata (non-public class)
  *
  * @see ConfigKeys
  * @since 2.7.1
  */
-@ConfigurationProperties("dubbo")
+@ConfigurationProperties(DUBBO_PREFIX)
 public class DubboConfigurationProperties {
 
     /**

diff --git a/...bboMetadataGenerateAutoConfiguration.java → ...bboMetadataGenerateAutoConfiguration.java b/...bboMetadataGenerateAutoConfiguration.java → ...bboMetadataGenerateAutoConfiguration.java
diff --git a/...tional-spring-configuration-metadata.json → ...tional-spring-configuration-metadata.json b/...tional-spring-configuration-metadata.json → ...tional-spring-configuration-metadata.json
diff --git a/dubbo-spring-boot/dubbo-spring-boot-compatible/metadata/pom.xml b/dubbo-spring-boot/dubbo-spring-boot-compatible/metadata/pom.xml
diff --git a/dubbo-spring-boot/dubbo-spring-boot-compatible/pom.xml b/dubbo-spring-boot/dubbo-spring-boot-compatible/pom.xml
@@ -37,7 +37,6 @@
     <modules>
         <module>autoconfigure</module>
         <module>actuator</module>
-        <module>metadata</module>
     </modules>
 
     <profiles>

diff --git a/dubbo-test/dubbo-dependencies-all/pom.xml b/dubbo-test/dubbo-dependencies-all/pom.xml
@@ -517,11 +517,6 @@
             <artifactId>dubbo-spring-boot-autoconfigure-compatible</artifactId>
             <version>${project.version}</version>
         </dependency>
-        <dependency>
-            <groupId>org.apache.dubbo</groupId>
-            <artifactId>dubbo-spring-boot-configuration-metadata-compatible</artifactId>
-            <version>${project.version}</version>
-        </dependency>
         <dependency>
             <groupId>org.apache.dubbo</groupId>
             <artifactId>dubbo-spring-boot-starter</artifactId>