java - 通过Java配置定义Spring RestController

Question

是否可以在Java配置(带有@Configuration注释的类)单独定义一个Spring RestController(@RestController注释的类)在标有 @Bean 的方法中)？

我有一个由 spring boot 管理的应用程序(就问题而言，版本并不重要，即使是最后一个可用的版本)。该应用程序通过 REST 公开一些端点，因此有多个 REST Controller ，它们依次调用服务(像往常一样)。

现在，根据配置(application.yml 中的属性)，我想避免启动一些服务，例如使用 @RestController 注释注释的 2 个类，因为它们处理我想排除的“功能 X”。

我想通过Java 配置来配置我的所有bean，这是一个要求。所以我最初的方法是在一个单独的配置中定义所有的bean( Controller 和服务)，该配置是由spring boot在扫描期间找到的)，并在配置上放置一个@ConditionalOnProperty，以便它出现在一处:

@Configuration
public class MyAppGeneralConfiguration {
  // here I define all the beans that are not relevant for "feature X"
  @Bean
  public ServiceA serviceA() {}
  ...
}

@Configuration 
@ConditionalOnProperty(name = "myapp.featureX.enabled", havingValue = "true")
public class MyAppFeatureXConfiguration {
   // here I will define all the beans relevant for feature X:

  @Bean
  public ServiceForFeatureX1 serviceForFeatureX1() {}   

  @Bean
  public ServiceForFeatureX2 serviceForFeatureX2() {}   
}

通过这种方法，我的服务根本没有任何 spring 注释，并且我不使用 @Autowired 注释，因为所有内容都是通过 @Configuration 类中的构造函数注入(inject)的:

// no @Service / @Component annotation
public class ServiceForFeatureX1 {}

现在我的问题是关于用 @RestContoller 注释注释的类。假设我有 2 个这样的 Controller :

@RestController
public class FeatureXRestController1 {
  ...
}

@RestController
public class FeatureXRestController2 {
 ...
}

理想情况下，我也想在 Java 配置中定义它们，这样当我禁用该功能时，这两个 Controller 就不会加载:

@ConditionalOnProperty(name = "myapp.featureX.enabled", havingValue = "true", matchIfMissing=true)
public class MyAppFeatureXConfiguration {

    @Bean
    @RestController // this doesn't work because the @RestController has target Type and can't be applied 
                    // to methods
    public FeatureXRestController1 featureXRestController1() {
    } 

所以问题基本上是可以这样做吗？

RestController 是一个 Controller ，它又是一个组件，因此它需要进行组件扫描。因此，如果功能 X 被禁用，功能 X 的其余 Controller 仍将开始加载并失败因为不会有“服务”——配置中排除的bean，所以spring boot将无法注入(inject)。

我想到的一种方法是定义一个特殊的注释，例如 @FeatureXRestController 并将其设为 @RestController 并将 @ConditionalOnProperty 放在那里，但它的还有两个地方，这是我能想到的最佳解决方案:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RestController
@ConditionalOnProperty(name = "myapp.featureX.enabled", havingValue = "true", matchIfMissing=true)
public @interface FeatureXRestController {
}

...
@FeatureXRestController
public class FeatureXRestController1 {...}

@FeatureXRestController
public class FeatureXRestController2 {...}

Answer 1

我找到了一个相对优雅的解决方法，可能对社区有帮助:我没有像我在问题中建议的那样使用专门的元注释，而是使用常规 @RestController 注释来注释功能 X 的 Controller :

@RestController
public class FeatureXController {
  ...
}

Spring boot应用程序类可以被“指示”在组件扫描排除过滤器期间不加载RestControllers。为了在答案中举例，我将使用内置注释过滤器，但通常可以为更复杂(真实)的情况创建自定义过滤器:

// Note the annotation - component scanning process won't recognize classes annotated with RestController, so from now on all the rest controllers in the application must be defined in `@Configuration` classes.
@ComponentScan(excludeFilters = @Filter(RestController.class))
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

现在，由于我希望仅在启用功能 X 时才加载其余 Controller ，因此我在 FeatureXConfiguration 中创建相应的方法:

@Configuration
@ConditionalOnProperty(value = "mayapp.featureX.enabled", havingValue = "true", matchIfMissing = false)
public class FeatureXConfiguration {

    @Bean
    public FeatureXService featureXService () {
        return new FeatureXService();
    }

    @Bean
    public FeatureXRestController featureXRestController () {
        return new FeatureXRestController(featureXService());
    }
}

虽然组件扫描过程不会加载其余 Controller ，但显式 bean 定义“覆盖”此行为，并且其余 Controller 的 bean 定义是在启动期间创建的。然后 Spring MVC 引擎对其进行分析，并且由于 @RestController 注释的存在，它像通常一样公开相应的端点。