java - 如何在spring配置类中创建RestControllerAdvice类型的spring @bean

Question

我正在尝试编写 RestControllerAdvice ，它是我希望在某个属性的存在上可用的公共(public)库的一部分。根据我们的通用库，我们通过配置而不是注释来定义所有 bean，以便我们可以按需导入该配置类，而不是总是创建这些 bean。但我发现很难提到 bean 实际上是 Spring 配置类中的 RestControllerAdvice 类型。

下面是我的 RestControllerAdvice。我删除了 @RestControllerAdvice从这个 ExceptionHandler 否则无论如何都会创建这个 bean 并且在我的配置类中我添加了 @AliasFor(annotation = RestControllerAdvice.class)但我不确定它是否是正确的方法，它也不起作用。

@Order(Ordered.HIGHEST_PRECEDENCE)
public class ExceptionHandler {


    @ExceptionHandler(CustomException.class)
    @ResponseBody
    public ResponseEntity<Void> handleMyException(CustomException e) {
        return new ResponseEntity(new UnauthorizedResponse().withMessage(e.getMessage()).withStatus(HttpStatus.UNAUTHORIZED.value()), null, HttpStatus.UNAUTHORIZED);
    }

}


@Configuration
public class ServiceCommonConfiguration {

    @Bean
    @AliasFor(annotation = RestControllerAdvice.class)
    @ConditionalOnProperty(name = PROPERTY, havingValue = "enable")
    public ExceptionHandler serviceCommonExceptionHandler() {
        return new ExceptionHandler();
    }
}

Answer 1

请试试这个:

@Configuration
public class ServiceCommonConfiguration {

    @RestControllerAdvice
    @ConditionalOnProperty(name = PROPERTY, havingValue = "enable")
    private class SpecificExceptionHandler extends ExceptionHandler {
      // Extends 'ExceptionHandler' class in your question.
    }
}

Spring 可以从内部类创建 bean，据我测试，甚至 private 的实例和非静态类已成功创建。

当然，你可以通过使用 @Import 来使用这个配置类。如下所示。

@Configuration
@Import(ServiceCommonConfiguration.class)
public class SomeUserOfLibraryConfiguration {.... 

当你既不导入配置类也不让Spring组件扫描类的包时，异常处理程序的bean不会被创建。

注意

您可以使用 @RestControllerAdvice/@ControllerAdvice注解只能在类级别使用，不能在方法级别使用。因此，您需要声明一个类并用其中一个注释该类。

@AliasFor注释，正如它的 javadoc 所说，“用于声明注释属性的别名”(@RestControllerAdvice 的源代码就是一个很好的例子)。所以，我认为 @AliasFor(annotation = RestControllerAdvice.class)在上面的源代码中什么都不做。

另见

Spring Framework Documentation Core Technologies - 1.3.2. Instantiating Beans