optimize: spring boot compatible with file.conf and registry.conf (#6811)

changes/en-us/2.x.md

@@ -84,6 +84,7 @@ Add changes here for all PR submitted to the 2.x branch.
 - [[#6794](https://github.com/apache/incubator-seata/pull/6794)] optimize NacosMockTest UT case
 - [[#6806](https://github.com/apache/incubator-seata/pull/6806)] optimize `tableMeta` cache scheduled refresh issue
 - [[#6808](https://github.com/apache/incubator-seata/pull/6808)] change version to 2.2.0-SNAPSHOT
+- [[#6828](https://github.com/apache/incubator-seata/pull/6828)] spring boot compatible with file.conf and registry.conf
 
 
 ### refactor:

changes/zh-cn/2.x.md

@@ -83,6 +83,7 @@
 - [[#6793](https://github.com/apache/incubator-seata/pull/6795)] 独立server的meta信息初始化逻辑
 - [[#6806](https://github.com/apache/incubator-seata/pull/6806)] 优化`tableMeta`缓存定时刷新问题
 - [[#6808](https://github.com/apache/incubator-seata/pull/6808)] 修改版本号为2.2.0-SNAPSHOT
+- [[#6828](https://github.com/apache/incubator-seata/pull/6828)] seata-spring-boot-starter兼容file.conf和registry.conf
 
 ### refactor:
 

common/src/main/java/org/apache/seata/common/Constants.java

@@ -127,6 +127,10 @@ public interface Constants {
      * The constant BEAN_NAME_SPRING_APPLICATION_CONTEXT_PROVIDER
      */
     String BEAN_NAME_SPRING_APPLICATION_CONTEXT_PROVIDER = "springApplicationContextProvider";
+    /**
+     * The constant BEAN_NAME_SEATA_FILE_CONFIGURATION_PROVIDER
+     */
+    String BEAN_NAME_SEATA_FILE_CONFIGURATION_PROVIDER = "seataFileConfigurationProvider";
     /**
      * The constant BEAN_NAME_SPRING_FENCE_CONFIG
      */

seata-spring-autoconfigure/seata-spring-autoconfigure-core/pom.xml

@@ -38,5 +38,10 @@
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

seata-spring-autoconfigure/seata-spring-autoconfigure-core/src/main/java/org/apache/seata/spring/boot/autoconfigure/SeataCoreAutoConfiguration.java

@@ -16,13 +16,15 @@
  */
 package org.apache.seata.spring.boot.autoconfigure;
 
+import org.apache.seata.spring.boot.autoconfigure.provider.SeataFileConfigurationProvider;
 import org.apache.seata.spring.boot.autoconfigure.provider.SpringApplicationContextProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
+import static org.apache.seata.common.Constants.BEAN_NAME_SEATA_FILE_CONFIGURATION_PROVIDER;
 import static org.apache.seata.common.Constants.BEAN_NAME_SPRING_APPLICATION_CONTEXT_PROVIDER;
 import static org.apache.seata.spring.boot.autoconfigure.StarterConstants.SEATA_PREFIX;
 
@@ -37,4 +39,10 @@ public class SeataCoreAutoConfiguration {
     public SpringApplicationContextProvider springApplicationContextProvider() {
         return new SpringApplicationContextProvider();
     }
+
+    @Bean(BEAN_NAME_SEATA_FILE_CONFIGURATION_PROVIDER)
+    @ConditionalOnMissingBean(name = {BEAN_NAME_SEATA_FILE_CONFIGURATION_PROVIDER})
+    public SeataFileConfigurationProvider seataFileConfigurationProvider() {
+        return new SeataFileConfigurationProvider();
+    }
 }

seata-spring-autoconfigure/seata-spring-autoconfigure-core/src/main/java/org/apache/seata/spring/boot/autoconfigure/provider/SeataFileConfigurationProvider.java

@@ -0,0 +1,83 @@
+package org.apache.seata.spring.boot.autoconfigure.provider;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Properties;
+
+import org.apache.commons.lang.StringUtils;
+import org.apache.seata.common.util.CollectionUtils;
+import org.apache.seata.config.FileConfiguration;
+import org.apache.seata.config.ConfigurationFactory;
+import org.apache.seata.config.file.FileConfig;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.context.ApplicationListener;
+import org.springframework.context.event.ContextRefreshedEvent;
+import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.PropertiesPropertySource;
+
+import static org.apache.seata.common.ConfigurationKeys.FILE_ROOT_PREFIX_CONFIG;
+import static org.apache.seata.common.ConfigurationKeys.FILE_ROOT_PREFIX_REGISTRY;
+import static org.apache.seata.common.ConfigurationKeys.SERVER_PREFIX;
+import static org.apache.seata.common.ConfigurationKeys.STORE_PREFIX;
+import static org.apache.seata.common.ConfigurationKeys.METRICS_PREFIX;
+import static org.apache.seata.common.ConfigurationKeys.TRANSPORT_PREFIX;
+import static org.apache.seata.common.ConfigurationKeys.SEATA_FILE_PREFIX_ROOT_CONFIG;
+
+public class SeataFileConfigurationProvider implements ApplicationContextAware, ApplicationListener<ContextRefreshedEvent> {
+
+    private ApplicationContext applicationContext;
+
+    // Prefix list for filtering configuration keys
+    List<String> prefixList = Arrays.asList(FILE_ROOT_PREFIX_CONFIG, FILE_ROOT_PREFIX_REGISTRY, SERVER_PREFIX,
+            STORE_PREFIX, METRICS_PREFIX, TRANSPORT_PREFIX);
+
+    @Override
+    public void setApplicationContext(ApplicationContext applicationContext) {
+        this.applicationContext = applicationContext;
+    }
+
+    @Override
+    public void onApplicationEvent(ContextRefreshedEvent event) {
+        // Only process if the event is for the current application context
+        if (event.getApplicationContext().equals(this.applicationContext)) {
+            ConfigurableEnvironment environment = (ConfigurableEnvironment) applicationContext.getEnvironment();
+            loadAndAddConfigurations(environment);
+        }
+    }
+
+    /**
+     * Loads configurations from file.conf and registry.conf and adds them to the Spring environment.
+     *
+     * @param environment the Spring environment
+     */
+    private void loadAndAddConfigurations(ConfigurableEnvironment environment) {
+        // Get configurations from file.conf and registry.conf
+        FileConfiguration configuration = ConfigurationFactory.getOriginFileInstanceRegistry();
+        FileConfig fileConfig = configuration.getFileConfig();
+        Map<String, Object> configs = fileConfig.getAllConfig();
+
+        if (CollectionUtils.isNotEmpty(configs)) {
+            // Optionally merge other configurations
+            Optional<FileConfiguration> originFileInstance = ConfigurationFactory.getOriginFileInstance();
+            originFileInstance.ifPresent(fileConfiguration ->
+                    configs.putAll(fileConfiguration.getFileConfig().getAllConfig())
+            );
+
+            // Convert and filter configurations based on prefix
+            Properties properties = new Properties();
+            configs.forEach((k, v) -> {
+                if (v instanceof String && StringUtils.isNotEmpty((String) v)) {
+                    if (prefixList.stream().anyMatch(k::startsWith)) {
+                        properties.put(SEATA_FILE_PREFIX_ROOT_CONFIG + k, v);
+                    }
+                }
+            });
+
+            // Add the properties to the environment with the lowest priority
+            environment.getPropertySources().addLast(new PropertiesPropertySource("seataFileConfig", properties));
+        }
+    }
+}

seata-spring-autoconfigure/seata-spring-autoconfigure-core/src/main/java/org/apache/seata/spring/boot/autoconfigure/provider/SpringBootConfigurationProvider.java

@@ -68,6 +68,10 @@ public Configuration provide(Configuration originalConfiguration) {
                     // 1. Get config value from the system property
                     result = originalConfiguration.getConfigFromSys(rawDataId);
 
+                    if (result == null) {
+                        result = originalConfiguration.getConfig(rawDataId);
+                    }
+
                     if (result == null) {
                         String dataId = convertDataId(rawDataId);
 

seata-spring-autoconfigure/seata-spring-autoconfigure-core/src/test/java/org/apache/seata/spring/boot/autoconfigure/SeataCoreAutoConfigurationTest.java

@@ -0,0 +1,35 @@
+package org.apache.seata.spring.boot.autoconfigure;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.core.env.Environment;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@ExtendWith(SpringExtension.class)
+@SpringBootTest(classes = SeataCoreAutoConfiguration.class)
+@TestPropertySource(locations = "classpath:application-test.properties")
+public class SeataCoreAutoConfigurationTest {
+
+    @Autowired
+    private Environment environment;
+
+    @Test
+    public void testSeataPropertiesLoaded() {
+        // default file.conf
+        String txServiceGroup = environment.getProperty("seata.store.db.url");
+        assertEquals("jdbc:mysql://127.0.0.1:3306/seata?rewriteBatchedStatements=true&configType=file", txServiceGroup, "The transaction service group should be correctly loaded from configuration");
+
+        // overridden by application-test.properties
+        String registryType = environment.getProperty("seata.config.type");
+        assertEquals("file", registryType, "The config type should be file");
+
+        // overridden by application-test.properties
+        String seataNamespaces = environment.getProperty("seata.config.nacos.namespace");
+        assertEquals("seata-test-application.yml", seataNamespaces, "The config type should be file");
+    }
+}

seata-spring-autoconfigure/seata-spring-autoconfigure-core/src/test/resources/application-test.properties

@@ -33,7 +33,7 @@ seata.config.apollo.apollo-config-service=fff
 seata.config.etcd3.server-addr=aaa
 seata.config.etcd3.key=bbb
 
-seata.config.nacos.namespace=ddd
+seata.config.nacos.namespace=seata-test-application.yml
 seata.config.nacos.server-addr=aaa
 seata.config.nacos.group=ccc
 seata.config.nacos.username=eee

seata-spring-autoconfigure/seata-spring-autoconfigure-core/src/test/resources/file.conf

@@ -0,0 +1,67 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+#reduce delay for test
+## transaction log store, only used in seata-server
+store {
+  ## store mode: file、db
+  mode = "file"
+
+  ## file store property
+  file {
+    ## store location dir
+    dir = "sessionStore"
+  }
+
+  ## database store property
+  db {
+    ## the implement of javax.sql.DataSource, such as DruidDataSource(druid)/BasicDataSource(dbcp) etc.
+    datasource = "dbcp"
+    ## mysql/oracle/h2/oceanbase etc.
+    dbType = "mysql"
+    driverClassName = "com.mysql.jdbc.Driver"
+    ## if using mysql to store the data, recommend add rewriteBatchedStatements=true in jdbc connection param
+    url = "jdbc:mysql://127.0.0.1:3306/seata?rewriteBatchedStatements=true"
+    user = "mysql"
+    password = "mysql"
+  }
+}
+server {
+  recovery {
+    #schedule committing retry period in milliseconds
+    committingRetryPeriod = 100
+    #schedule asyn committing retry period in milliseconds
+    asynCommittingRetryPeriod = 100
+    #schedule rollbacking retry period in milliseconds
+    rollbackingRetryPeriod = 100
+    #schedule timeout retry period in milliseconds
+    timeoutRetryPeriod = 100
+  }
+  undo {
+    logSaveDays = 2
+    #schedule delete expired undo_log in milliseconds
+    logDeletePeriod = 86400000
+  }
+}
+## metrics settings
+metrics {
+  enabled = true
+  registryType = "compact"
+  # multi exporters use comma divided
+  exporterList = "prometheus"
+  exporterPrometheusPort = 9898
+}

seata-spring-autoconfigure/seata-spring-autoconfigure-core/src/test/resources/registry.conf

@@ -0,0 +1,30 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+config {
+  type = "file"
+
+  file {
+    name = "file.conf"
+  }
+  nacos {
+    application = "seata-server"
+    serverAddr = "127.0.0.1:8848"
+    namespace = "seata-test"
+    cluster = "default"
+  }
+}