如何在Spring Boot Maven衍生模块api2中禁用指定@RestController

我给你几个实用的方案，你可以根据项目的实际情况选择：

方案1：通过@ComponentScan排除特定控制器 #

在api2模块的主启动类上，调整@SpringBootApplication注解的扫描规则，直接排除你不想加载的那个@RestController类。

比如假设api1里要禁用的控制器是com.example.api1.controller.UnwantedController，那么api2的启动类可以这么写：

@SpringBootApplication(
    excludeFilters = @ComponentScan.Filter(
        type = FilterType.ASSIGNABLE_TYPE,
        value = UnwantedController.class
    )
)
public class Api2Application {
    public static void main(String[] args) {
        SpringApplication.run(Api2Application.class, args);
    }
}

这种方式直接粗暴，适合明确知道要排除哪个类的场景。

方案2：用条件注解控制控制器加载 #

如果希望更灵活地控制（比如后续可能在某些场景下又需要加载这个控制器），可以在api1的目标控制器上加上@ConditionalOnProperty注解，通过配置属性来开关它的加载。

先修改api1里的控制器：

@RestController
@ConditionalOnProperty(
    name = "api1.controllers.unwanted.enabled",
    havingValue = "true",
    matchIfMissing = true // 默认开启，这样api1自己启动时不受影响
)
public class UnwantedController {
    // ... 控制器逻辑
}

然后在api2的application.properties或者application.yml里添加配置，关闭这个控制器：

api1.controllers.unwanted.enabled=false

这种方式的好处是不用修改代码，只改配置就能控制，扩展性更强。

方案3：利用Spring Profile隔离加载 #

给api1里的目标控制器指定一个专属的Profile，只有当这个Profile被激活时才加载它。

修改api1的控制器：

@RestController
@Profile("api1-unwanted-controller")
public class UnwantedController {
    // ... 控制器逻辑
}

然后在api2的配置里，不要激活这个Profile（默认就不会激活），这样api2启动时就不会加载这个控制器了。如果哪天需要加载，只需要在api2的配置里激活这个Profile即可：

spring.profiles.active=api1-unwanted-controller

这种方式适合按环境或场景分组管理组件的情况。

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