🛠️ [chore] Centralize Spring Boot configuration property prefixes

TrueNine · TrueNine · commit d64134eb289f · 2025-08-10T08:27:37.000+08:00
- Introduced `SpringBootConfigurationPropertiesPrefixes` for unified configuration prefix management.
- Refactored multiple modules to use the centralized constants (`@ConfigurationProperties`) replacing hardcoded prefixes.
- Enhanced maintainability and reduced redundancy across shared, security, OSS, pay, PSDK, depend, and testtoolkit modules.
diff --git a/depend/depend-paho/src/main/kotlin/io/github/truenine/composeserver/depend/paho/properties/SingleMqttProperties.kt b/depend/depend-paho/src/main/kotlin/io/github/truenine/composeserver/depend/paho/properties/SingleMqttProperties.kt
@@ -1,11 +1,10 @@
 package io.github.truenine.composeserver.depend.paho.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import java.util.*
 import org.springframework.boot.context.properties.ConfigurationProperties
 
-private const val PREFIX = "compose.depend.paho"
-
-@ConfigurationProperties(prefix = "$PREFIX.client")
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.DEPEND_PAHO_CLIENT)
 data class SingleMqttProperties(
   /** schema = tcp:// */
   var url: String? = null,
diff --git a/depend/depend-servlet/src/main/kotlin/io/github/truenine/composeserver/depend/servlet/properties/ServletWebApplicationProperties.kt b/depend/depend-servlet/src/main/kotlin/io/github/truenine/composeserver/depend/servlet/properties/ServletWebApplicationProperties.kt
@@ -1,18 +1,17 @@
 package io.github.truenine.composeserver.depend.servlet.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import kotlin.reflect.KClass
 import org.springframework.boot.context.properties.ConfigurationProperties
 import org.springframework.http.converter.StringHttpMessageConverter
 
-private const val PREFIX = "compose.depend.servlet"
-
 /**
  * spring web mvc http servlet 配置属性
  *
  * @author TrueNine
  * @since 2023-02-20
  */
-@ConfigurationProperties(prefix = PREFIX)
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.DEPEND_SERVLET)
 data class ServletWebApplicationProperties(
   var allowConverters: MutableList<String> = mutableListOf("getDocumentation", "swaggerResources", "openapiJson"),
   var allowConverterClasses: MutableList<KClass<*>> = mutableListOf(StringHttpMessageConverter::class),
diff --git a/depend/depend-springdoc-openapi/src/main/kotlin/io/github/truenine/composeserver/depend/springdocopenapi/properties/SpringdocOpenApiProperties.kt b/depend/depend-springdoc-openapi/src/main/kotlin/io/github/truenine/composeserver/depend/springdocopenapi/properties/SpringdocOpenApiProperties.kt
@@ -1,13 +1,12 @@
 package io.github.truenine.composeserver.depend.springdocopenapi.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import org.springframework.boot.context.properties.ConfigurationProperties
 import org.springframework.boot.context.properties.ConfigurationPropertiesBinding
 import org.springframework.boot.context.properties.NestedConfigurationProperty
 
-private const val PREFIX = "compose.depend.springdoc-open-api"
-
 @ConfigurationPropertiesBinding
-@ConfigurationProperties(prefix = PREFIX, ignoreUnknownFields = true)
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.DEPEND_SPRINGDOC_OPENAPI, ignoreUnknownFields = true)
 data class SpringdocOpenApiProperties(
   /** 扫描的包 */
   var scanPackages: MutableList<String> = mutableListOf(),
diff --git a/oss/oss-minio/src/main/kotlin/io/github/truenine/composeserver/oss/minio/autoconfig/MinioAutoConfiguration.kt b/oss/oss-minio/src/main/kotlin/io/github/truenine/composeserver/oss/minio/autoconfig/MinioAutoConfiguration.kt
@@ -1,5 +1,6 @@
 package io.github.truenine.composeserver.oss.minio.autoconfig
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import io.github.truenine.composeserver.logger
 import io.github.truenine.composeserver.oss.ObjectStorageService
 import io.github.truenine.composeserver.oss.minio.MinioObjectStorageService
@@ -23,7 +24,7 @@ import org.springframework.context.annotation.Configuration
  */
 @Configuration
 @ConditionalOnClass(MinioClient::class)
-@ConditionalOnProperty(prefix = "compose.oss", name = ["provider"], havingValue = "minio")
+@ConditionalOnProperty(prefix = SpringBootConfigurationPropertiesPrefixes.OSS, name = ["provider"], havingValue = "minio")
 @EnableConfigurationProperties(MinioProperties::class, OssProperties::class)
 class MinioAutoConfiguration {
 
diff --git a/oss/oss-minio/src/main/kotlin/io/github/truenine/composeserver/oss/minio/properties/MinioProperties.kt b/oss/oss-minio/src/main/kotlin/io/github/truenine/composeserver/oss/minio/properties/MinioProperties.kt
@@ -1,10 +1,9 @@
 package io.github.truenine.composeserver.oss.minio.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import java.time.Duration
 import org.springframework.boot.context.properties.ConfigurationProperties
 
-private const val PREFIX = "compose.oss.minio"
-
 /**
  * Modern MinIO configuration properties
  *
@@ -22,7 +21,7 @@ private const val PREFIX = "compose.oss.minio"
  * @author TrueNine
  * @since 2025-01-04
  */
-@ConfigurationProperties(prefix = PREFIX)
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.OSS_MINIO)
 data class MinioProperties(
   var endpoint: String = "127.0.0.1",
   var port: Int = 9000,
diff --git a/oss/oss-shared/src/main/kotlin/io/github/truenine/composeserver/oss/properties/OssProperties.kt b/oss/oss-shared/src/main/kotlin/io/github/truenine/composeserver/oss/properties/OssProperties.kt
@@ -1,10 +1,9 @@
 package io.github.truenine.composeserver.oss.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import java.time.Duration
 import org.springframework.boot.context.properties.ConfigurationProperties
 
-private const val PREFIX = "compose.oss"
-
 /**
  * Modern OSS configuration properties
  *
@@ -28,7 +27,7 @@ private const val PREFIX = "compose.oss"
  * @author TrueNine
  * @since 2025-01-04
  */
-@ConfigurationProperties(prefix = PREFIX)
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.OSS)
 data class OssProperties(
   /** OSS provider type (minio, volcengine-tos, aliyun-oss, etc.) */
   var provider: String? = null,
diff --git a/oss/oss-volcengine-tos/src/main/kotlin/io/github/truenine/composeserver/oss/volcengine/autoconfig/VolcengineTosAutoConfiguration.kt b/oss/oss-volcengine-tos/src/main/kotlin/io/github/truenine/composeserver/oss/volcengine/autoconfig/VolcengineTosAutoConfiguration.kt
@@ -5,6 +5,7 @@ import com.volcengine.tos.TOSV2
 import com.volcengine.tos.TOSV2ClientBuilder
 import com.volcengine.tos.auth.StaticCredentials
 import com.volcengine.tos.transport.TransportConfig
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import io.github.truenine.composeserver.logger
 import io.github.truenine.composeserver.oss.ObjectStorageService
 import io.github.truenine.composeserver.oss.properties.OssProperties
@@ -32,7 +33,7 @@ import org.springframework.context.annotation.Configuration
  */
 @Configuration
 @ConditionalOnClass(TOSV2::class)
-@ConditionalOnProperty(prefix = "compose.oss", name = ["provider"], havingValue = "volcengine-tos")
+@ConditionalOnProperty(prefix = SpringBootConfigurationPropertiesPrefixes.OSS, name = ["provider"], havingValue = "volcengine-tos")
 @EnableConfigurationProperties(VolcengineTosProperties::class, OssProperties::class)
 class VolcengineTosAutoConfiguration {
 
diff --git a/oss/oss-volcengine-tos/src/main/kotlin/io/github/truenine/composeserver/oss/volcengine/properties/VolcengineTosProperties.kt b/oss/oss-volcengine-tos/src/main/kotlin/io/github/truenine/composeserver/oss/volcengine/properties/VolcengineTosProperties.kt
@@ -1,9 +1,8 @@
 package io.github.truenine.composeserver.oss.volcengine.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import org.springframework.boot.context.properties.ConfigurationProperties
 
-private const val PREFIX = "compose.oss.volcengine-tos"
-
 /**
  * Volcengine TOS configuration properties with optimized defaults
  *
@@ -41,7 +40,7 @@ private const val PREFIX = "compose.oss.volcengine-tos"
  * @author TrueNine
  * @since 2025-08-04
  */
-@ConfigurationProperties(prefix = PREFIX)
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.OSS_VOLCENGINE_TOS)
 data class VolcengineTosProperties(
   /** Service endpoint URL */
   var endpoint: String? = null,
diff --git a/pay/pay-wechat/src/main/kotlin/io/github/truenine/composeserver/pay/wechat/properties/WeChatPayProperties.kt b/pay/pay-wechat/src/main/kotlin/io/github/truenine/composeserver/pay/wechat/properties/WeChatPayProperties.kt
@@ -1,17 +1,16 @@
 package io.github.truenine.composeserver.pay.wechat.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import org.springframework.boot.context.properties.ConfigurationProperties
 
-private const val PREFIX = "compose.pay"
-
 /**
  * # 微信单支付 js API 配置 <br></br>
  * [微信支付文档](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_1.shtml)
  *
  * @author shanghua
  * @since 2023-05-05
  */
-@ConfigurationProperties(prefix = "$PREFIX.wechat", ignoreUnknownFields = true)
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.PAY_WECHAT, ignoreUnknownFields = true)
 data class WeChatPayProperties(
   /** 开启 单配置支付 */
   var enableSingle: Boolean = false,
diff --git a/psdk/psdk-wxpa/src/main/kotlin/io/github/truenine/composeserver/psdk/wxpa/autoconfig/WxpaAutoConfiguration.kt b/psdk/psdk-wxpa/src/main/kotlin/io/github/truenine/composeserver/psdk/wxpa/autoconfig/WxpaAutoConfiguration.kt
@@ -1,5 +1,6 @@
 package io.github.truenine.composeserver.psdk.wxpa.autoconfig
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import io.github.truenine.composeserver.logger
 import io.github.truenine.composeserver.psdk.wxpa.api.IWxpaWebClient
 import io.github.truenine.composeserver.psdk.wxpa.core.WxpaSignatureGenerator
@@ -62,7 +63,12 @@ class WxpaAutoConfiguration {
   }
 
   @Bean
-  @ConditionalOnProperty(prefix = "compose.psdk.wxpa.wxpa", name = ["enable-auto-refresh"], havingValue = "true", matchIfMissing = true)
+  @ConditionalOnProperty(
+    prefix = "${SpringBootConfigurationPropertiesPrefixes.PSDK_WXPA}.wxpa",
+    name = ["enable-auto-refresh"],
+    havingValue = "true",
+    matchIfMissing = true,
+  )
   fun wxpaTokenEventManager(tokenManager: WxpaTokenManager, properties: WxpaProperties): WxpaTokenEventManager {
     log.info("Creating WxpaTokenEventManager")
     return WxpaTokenEventManager(tokenManager, properties)
diff --git a/psdk/psdk-wxpa/src/main/kotlin/io/github/truenine/composeserver/psdk/wxpa/properties/WechatProperties.kt b/psdk/psdk-wxpa/src/main/kotlin/io/github/truenine/composeserver/psdk/wxpa/properties/WechatProperties.kt
@@ -1,8 +1,8 @@
 package io.github.truenine.composeserver.psdk.wxpa.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import org.springframework.boot.context.properties.ConfigurationProperties
 import org.springframework.boot.context.properties.NestedConfigurationProperty
 
-private const val PREFIX = "compose.psdk.wxpa"
-
-@ConfigurationProperties(prefix = PREFIX) data class WechatProperties(@NestedConfigurationProperty var wxpa: WxpaProperties = WxpaProperties())
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.PSDK_WXPA)
+data class WechatProperties(@NestedConfigurationProperty var wxpa: WxpaProperties = WxpaProperties())
diff --git a/security/security-spring/src/main/kotlin/io/github/truenine/composeserver/security/properties/JwtProperties.kt b/security/security-spring/src/main/kotlin/io/github/truenine/composeserver/security/properties/JwtProperties.kt
@@ -1,12 +1,11 @@
 package io.github.truenine.composeserver.security.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import org.springframework.boot.context.properties.ConfigurationProperties
 import org.springframework.boot.context.properties.ConfigurationPropertiesBinding
 
-private const val PREFIX = "compose.security"
-
 @ConfigurationPropertiesBinding
-@ConfigurationProperties(prefix = "$PREFIX.jwt")
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.SECURITY_JWT)
 data class JwtProperties(
   var publicKeyClassPath: String = "security/pub.key",
   var privateKeyClassPath: String = "security/pri.key",
diff --git a/security/security-spring/src/main/kotlin/io/github/truenine/composeserver/security/properties/KeysProperties.kt b/security/security-spring/src/main/kotlin/io/github/truenine/composeserver/security/properties/KeysProperties.kt
@@ -1,16 +1,15 @@
 package io.github.truenine.composeserver.security.properties
 
+import io.github.truenine.composeserver.consts.SpringBootConfigurationPropertiesPrefixes
 import org.springframework.boot.context.properties.ConfigurationProperties
 
-private const val PREFIX = "compose.security"
-
 /**
  * 密钥
  *
  * @author TrueNine
  * @since 2023-04-22
  */
-@ConfigurationProperties(prefix = "$PREFIX.keys")
+@ConfigurationProperties(prefix = SpringBootConfigurationPropertiesPrefixes.SECURITY_KEYS)
 data class KeysProperties(
   /** 密钥存放的 resources 对应目录 */
   var dir: String = "security",
diff --git a/shared/src/main/kotlin/io/github/truenine/composeserver/consts/SpringBootConfigurationPropertiesPrefixes.kt b/shared/src/main/kotlin/io/github/truenine/composeserver/consts/SpringBootConfigurationPropertiesPrefixes.kt
@@ -0,0 +1,153 @@
+package io.github.truenine.composeserver.consts
+
+/**
+ * Centralized Spring Boot Configuration Properties prefixes for the entire project.
+ *
+ * This object contains all the configuration property prefixes used across different modules to provide a single source of truth and easier management of
+ * configuration namespaces.
+ *
+ * ## Module Organization
+ * - **Shared**: Core shared functionality prefixes
+ * - **Security**: Security-related configuration prefixes
+ * - **OSS**: Object Storage Service configuration prefixes
+ * - **Pay**: Payment service configuration prefixes
+ * - **PSDK**: Platform SDK configuration prefixes
+ * - **Depend**: Dependency module configuration prefixes
+ * - **TestToolkit**: Testing framework configuration prefixes
+ *
+ * @author TrueNine
+ * @since 2025-01-09
+ */
+object SpringBootConfigurationPropertiesPrefixes {
+
+  // ========== Base Prefixes ==========
+
+  /** Root prefix for all compose server configurations */
+  const val ROOT = "compose"
+
+  // ========== Shared Module Prefixes ==========
+
+  /** Base prefix for shared module configurations */
+  const val SHARED = "$ROOT.shared"
+
+  /** Snowflake ID generator configuration prefix */
+  const val SHARED_SNOWFLAKE = "$SHARED.snowflake"
+
+  /** Data loading configuration prefix */
+  const val SHARED_DATA_LOAD = "$SHARED.data-load"
+
+  /** Resource holder configuration prefix */
+  const val SHARED_RESOURCE_HOLDER = "$SHARED.resource-holder"
+
+  // ========== Security Module Prefixes ==========
+
+  /** Base prefix for security module configurations */
+  const val SECURITY = "$ROOT.security"
+
+  /** JWT configuration prefix */
+  const val SECURITY_JWT = "$SECURITY.jwt"
+
+  /** Keys configuration prefix */
+  const val SECURITY_KEYS = "$SECURITY.keys"
+
+  // ========== OSS Module Prefixes ==========
+
+  /** Base prefix for OSS module configurations */
+  const val OSS = "$ROOT.oss"
+
+  /** MinIO OSS configuration prefix */
+  const val OSS_MINIO = "$OSS.minio"
+
+  /** Volcengine TOS configuration prefix */
+  const val OSS_VOLCENGINE_TOS = "$OSS.volcengine-tos"
+
+  // ========== Pay Module Prefixes ==========
+
+  /** Base prefix for payment module configurations */
+  const val PAY = "$ROOT.pay"
+
+  /** WeChat Pay configuration prefix */
+  const val PAY_WECHAT = "$PAY.wechat"
+
+  // ========== PSDK Module Prefixes ==========
+
+  /** Base prefix for platform SDK configurations */
+  const val PSDK = "$ROOT.psdk"
+
+  /** WeChat Platform API configuration prefix */
+  const val PSDK_WXPA = "$PSDK.wxpa"
+
+  // ========== Depend Module Prefixes ==========
+
+  /** Base prefix for dependency module configurations */
+  const val DEPEND = "$ROOT.depend"
+
+  /** Servlet web application configuration prefix */
+  const val DEPEND_SERVLET = "$DEPEND.servlet"
+
+  /** PAHO MQTT client configuration prefix */
+  const val DEPEND_PAHO = "$DEPEND.paho"
+
+  /** PAHO MQTT client specific configuration prefix */
+  const val DEPEND_PAHO_CLIENT = "$DEPEND_PAHO.client"
+
+  /** SpringDoc OpenAPI configuration prefix */
+  const val DEPEND_SPRINGDOC_OPENAPI = "$DEPEND.springdoc-open-api"
+
+  // ========== TestToolkit Module Prefixes ==========
+
+  /** Base prefix for test toolkit configurations */
+  const val TESTTOOLKIT = "$ROOT.testtoolkit"
+
+  /** Testcontainers configuration prefix */
+  const val TESTTOOLKIT_TESTCONTAINERS = "$TESTTOOLKIT.testcontainers"
+
+  // ========== Utility Methods ==========
+
+  /**
+   * Get all prefixes as a list for validation or documentation purposes.
+   *
+   * @return List of all configuration prefixes
+   */
+  fun getAllPrefixes(): List<String> =
+    listOf(
+      ROOT,
+      SHARED,
+      SHARED_SNOWFLAKE,
+      SHARED_DATA_LOAD,
+      SHARED_RESOURCE_HOLDER,
+      SECURITY,
+      SECURITY_JWT,
+      SECURITY_KEYS,
+      OSS,
+      OSS_MINIO,
+      OSS_VOLCENGINE_TOS,
+      PAY,
+      PAY_WECHAT,
+      PSDK,
+      PSDK_WXPA,
+      DEPEND,
+      DEPEND_SERVLET,
+      DEPEND_PAHO,
+      DEPEND_PAHO_CLIENT,
+      DEPEND_SPRINGDOC_OPENAPI,
+      TESTTOOLKIT,
+      TESTTOOLKIT_TESTCONTAINERS,
+    )
+
+  /**
+   * Get prefixes by module for organized access.
+   *
+   * @return Map of module name to list of prefixes
+   */
+  fun getPrefixesByModule(): Map<String, List<String>> =
+    mapOf(
+      "shared" to listOf(SHARED, SHARED_SNOWFLAKE, SHARED_DATA_LOAD, SHARED_RESOURCE_HOLDER),
+      "security" to listOf(SECURITY, SECURITY_JWT, SECURITY_KEYS),
+      "oss" to listOf(OSS, OSS_MINIO, OSS_VOLCENGINE_TOS),
+      "pay" to listOf(PAY, PAY_WECHAT),
+      "psdk" to listOf(PSDK, PSDK_WXPA),
+      "depend" to listOf(DEPEND, DEPEND_SERVLET, DEPEND_PAHO, DEPEND_PAHO_CLIENT, DEPEND_SPRINGDOC_OPENAPI),
+      "testtoolkit" to listOf(TESTTOOLKIT, TESTTOOLKIT_TESTCONTAINERS),
+    )
+}
diff --git a/shared/src/main/kotlin/io/github/truenine/composeserver/holders/config/ResourceHolderConfiguration.kt b/shared/src/main/kotlin/io/github/truenine/composeserver/holders/config/ResourceHolderConfiguration.kt
diff --git a/shared/src/main/kotlin/io/github/truenine/composeserver/properties/DataLoadProperties.kt b/shared/src/main/kotlin/io/github/truenine/composeserver/properties/DataLoadProperties.kt
diff --git a/shared/src/main/kotlin/io/github/truenine/composeserver/properties/SnowflakeProperties.kt b/shared/src/main/kotlin/io/github/truenine/composeserver/properties/SnowflakeProperties.kt
diff --git a/testtoolkit/src/main/kotlin/io/github/truenine/composeserver/testtoolkit/SpringBootConfigurationPropertiesPrefixes.kt b/testtoolkit/src/main/kotlin/io/github/truenine/composeserver/testtoolkit/SpringBootConfigurationPropertiesPrefixes.kt
diff --git a/testtoolkit/src/main/kotlin/io/github/truenine/composeserver/testtoolkit/properties/TestConfigurationProperties.kt b/testtoolkit/src/main/kotlin/io/github/truenine/composeserver/testtoolkit/properties/TestConfigurationProperties.kt
diff --git a/testtoolkit/src/main/kotlin/io/github/truenine/composeserver/testtoolkit/properties/TestcontainersProperties.kt b/testtoolkit/src/main/kotlin/io/github/truenine/composeserver/testtoolkit/properties/TestcontainersProperties.kt
