18-conditional-configuration

条件配置指南,涵盖 @Conditional 注解、Profile 配置、特性开关、配置优先级、动态配置加载。当用户实现条件化 Bean 加载、配置多环境、使用特性开关或处理配置优先级时使用。

⭐2.5kstars🔀514forks📁View on GitHub🕐Updated Jan 9, 2026⬇️1downloads

When & Why to Use This Skill

This Claude skill provides a comprehensive guide for implementing conditional configuration in Spring Boot applications using Kotlin. It covers essential annotations like @ConditionalOnProperty, profile-based settings, and feature toggles to enable flexible bean loading and multi-environment support, ensuring a robust and maintainable software architecture.

Use Cases

  • Switching between different service implementations (e.g., RBAC vs. Sample authentication) dynamically based on configuration properties.
  • Managing environment-specific configurations to ensure seamless transitions and behavior differentiation between development, testing, and production.
  • Implementing feature toggles to enable or disable specific system functionalities at runtime without requiring code redeployment.
  • Optimizing application context and resource usage by conditionally loading beans only when specific classes, other beans, or SpEL expressions are present.
  • Handling configuration priority and dynamic loading to resolve complex dependency injection scenarios in microservices.
name18-conditional-configuration
description条件配置指南,涵盖 @Conditional 注解、Profile 配置、特性开关、配置优先级、动态配置加载。当用户实现条件化 Bean 加载、配置多环境、使用特性开关或处理配置优先级时使用。

条件配置

条件配置指南.

触发条件

当用户需要实现多实现切换、环境差异化配置、功能开关时,使用此 Skill。

@ConditionalOnProperty

@Configuration
@ConditionalOnProperty(
    prefix = "auth",
    name = ["idProvider"],
    havingValue = "rbac"
)
class RbacConfiguration {
    @Bean
    fun permissionService(): PermissionService {
        return RbacPermissionService()
    }
}

@Configuration
@ConditionalOnProperty(
    prefix = "auth",
    name = ["idProvider"],
    havingValue = "sample",
    matchIfMissing = true  // 默认使用
)
class SampleConfiguration {
    @Bean
    fun permissionService(): PermissionService {
        return SamplePermissionService()
    }
}

配置示例

# application.yml
auth:
  idProvider: rbac  # 或 sample

pipeline:
  permission:
    enabled: true
    strategy: stream  # 或 default

多实现切换

// 接口定义
interface PermissionService {
    fun check(userId: String, resource: String): Boolean
}

// RBAC 实现
@Service
@ConditionalOnProperty(name = ["auth.idProvider"], havingValue = "rbac")
class RbacPermissionService : PermissionService {
    override fun check(userId: String, resource: String): Boolean {
        // RBAC 权限检查
    }
}

// 简单实现
@Service
@ConditionalOnProperty(name = ["auth.idProvider"], havingValue = "sample", matchIfMissing = true)
class SamplePermissionService : PermissionService {
    override fun check(userId: String, resource: String): Boolean {
        return true  // 简单实现,全部放行
    }
}

其他条件注解

注解 说明
@ConditionalOnProperty 基于配置属性
@ConditionalOnBean 基于 Bean 存在
@ConditionalOnMissingBean 基于 Bean 不存在
@ConditionalOnClass 基于类存在
@ConditionalOnExpression 基于 SpEL 表达式

最佳实践

  1. 默认实现:使用 matchIfMissing = true 指定默认
  2. 清晰命名:配置项命名要清晰表达含义
  3. 文档说明:在配置模板中说明各选项含义
  4. 测试覆盖:确保各条件分支都有测试

相关文件

  • process/biz-process/src/main/kotlin/com/tencent/devops/process/permission/config/
  • auth/biz-auth/src/main/kotlin/com/tencent/devops/auth/provider/