如何通过配置属性启用/禁用Spring Boot @RestController指定方法

你已经搞定了类级别的控制器开关，要细化到单个方法其实很直接，下面给你几个实用的方案：

方案1：直接在方法上使用@ConditionalOnProperty #

这是最直观的方式，把类上的注解逻辑直接复用在方法层面，给每个需要单独控制的方法配置专属的属性键就行。

示例代码：

@RestController
@ConditionalOnProperty(name = "com.example.api.controller.decision.DecisionController.enabled", havingValue = "true")
@RequestMapping("/v1.0/decisions")
public class DecisionController {

    // 仅当该属性为true时，这个接口才生效
    @GetMapping("/{id}")
    @ConditionalOnProperty(name = "com.example.api.controller.decision.DecisionController.get.enabled", havingValue = "true")
    public ResponseEntity<Decision> getDecision(@PathVariable Long id) {
        // 业务逻辑
        return ResponseEntity.ok(new Decision());
    }

    // 另一个方法用不同的配置键
    @PostMapping
    @ConditionalOnProperty(name = "com.example.api.controller.decision.DecisionController.create.enabled", havingValue = "true")
    public ResponseEntity<Decision> createDecision(@RequestBody Decision decision) {
        // 业务逻辑
        return ResponseEntity.status(HttpStatus.CREATED).body(decision);
    }
}

对应的配置文件（比如application.yml）可以这样写：

com:
  example:
    api:
      controller:
        decision:
          DecisionController:
            enabled: true # 控制器整体启用
            get:
              enabled: true # 单个get方法启用
            create:
              enabled: false # 单个create方法禁用

注意：如果控制器类本身被@ConditionalOnProperty禁用了，那么不管方法上的配置是什么，所有方法都不会生效——毕竟类都没被Spring实例化嘛。

方案2：用@ConditionalOnExpression实现更灵活的逻辑 #

如果你的控制逻辑需要组合多个配置属性（比如“当A为true且B为false时才启用方法”），@ConditionalOnExpression会更适合，它支持SpEL表达式。

示例：

@GetMapping("/stats")
@ConditionalOnExpression("${com.example.api.controller.decision.DecisionController.stats.enabled:true} && ${com.example.feature.stats.enabled:true}")
public ResponseEntity<Stats> getDecisionStats() {
    // 业务逻辑
    return ResponseEntity.ok(new Stats());
}

这里的表达式意思是：只有当两个配置都为true时，这个方法才生效，并且给第二个配置加了默认值true，避免配置缺失时出错。

方案3：自定义Condition实现复杂逻辑 #

如果你的开关逻辑没法用简单的配置属性表达（比如需要读取数据库配置、调用外部接口判断状态），可以自定义一个Condition类。

步骤1：写自定义Condition类

public class CreateDecisionCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 这里可以写任意复杂的判断逻辑，比如读取数据库、调用外部服务
        Environment env = context.getEnvironment();
        // 举个例子：判断两个配置的组合，或者其他逻辑
        boolean isCreateEnabled = env.getProperty("com.example.api.controller.decision.DecisionController.create.enabled", Boolean.class, false);
        boolean isFeatureFlagOpen = env.getProperty("com.example.feature.create.open", Boolean.class, false);
        return isCreateEnabled && isFeatureFlagOpen;
    }
}

步骤2：在方法上使用@Conditional注解

@PostMapping
@Conditional(CreateDecisionCondition.class)
public ResponseEntity<Decision> createDecision(@RequestBody Decision decision) {
    // 业务逻辑
    return ResponseEntity.status(HttpStatus.CREATED).body(decision);
}

这样就能完全自定义方法的启用条件了，自由度拉满。

内容的提问来源于stack exchange，提问作者alexanoid