通过 Java 配置定义 Spring RestController

Question

是否可以在Java配置中定义一个Spring RestController（@RestController注解类）单独（@Configuration方法中注解@Bean的类）？ p>

我有一个由 spring boot 管理的应用程序（版本无关紧要，即使是最后一个可用的版本）。此应用程序使用 REST 公开了一些端点，因此有几个 REST 控制器，它们依次调用服务（像往常一样）。

现在取决于配置（application.yml 中的属性），我想避免启动一些服务，比如用 @RestController 注释注释的 2 个类，因为它们处理我想要排除的“功能 X”。

我想通过 Java 配置 配置我所有的 bean，这是一个要求。所以我最初的方法是在一个单独的配置中定义所有 bean（控制器和服务），该配置由 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 类中的构造函数注入的：

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

现在我的问题是关于带有@RestContoller 注释的类。假设我有 2 个这样的控制器：

@RestController
public class FeatureXRestController1 {
  ...
}

@RestController
public class FeatureXRestController2 {
 ...
}

理想情况下，我也想在 Java 配置中定义它们，这样当我禁用该功能时，这两个控制器甚至都不会加载：

@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 是一个控制器，它又是一个组件，因此它受到组件扫描的影响。因此，如果功能 X 被禁用，功能 X 的其余控制器仍将开始加载并失败 因为不会有“服务”——配置中排除了bean，所以spring boot将无法注入。

我想到的一种方法是定义一个特殊的注释，如 @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 注释来注释 Feature X 的控制器：

@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);
    }

}

现在，由于我希望仅在启用 Feature X 时才加载其余控制器，因此我在 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());
    }
}

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

Answer 2

您可以在 java 配置中使用本地类。 E.e.

@Configuration
public class MyAppFeatureXConfiguration  {

  @Bean
  public FeatureXRestController1 featureXRestController1(AutowireCapableBeanFactory beanFactory) {

     @RestController
     class FeatureXRestController1Bean extends FeatureRestController1 {
     }

     FeatureXRestController1Bean featureBean = new FeatureXRestController1Bean();

     // You don't need this line if you use constructor injection
     autowireCapableBeanFactory.autowireBean(featureBean);
  
     return featureBean;
  } 
}

然后您可以在“真实”实现中省略@RestController 注释，但照常使用其他注释，如@RequestMapping。

@RequestMapping(...)
public class FeatureXRestController1 {

    @RequestMapping(value="/somePath/{someId}", method=RequestMethod.GET)
    public String findSomething(@PathVariable String someId) {
       ...
    }
}

因为FeatureXRestController1 没有@RestController 注释，它不再是@Component，因此不会通过组件扫描被拾取。

MyAppFeatureXConfiguration 返回一个 @RestController 的 bean。这个FeatureXRestController1Bean 扩展了FeatureXRestController1，因此拥有超类的所有方法和请求映射。

由于FeatureXRestController1Bean 是一个本地类，它不包含在组件扫描中。这对我有用；）