Spring 中使用 @Order 注解排序 Bean 和依赖

在Spring框架中,@Order是一个经常被忽视但非常重要的注解。 在项目开发中,当我们需要维护bean的特定顺序或者存在许多相同类型的bean时,这个注解就发挥了作用。这篇文章讲的就是如何利用@Order注解对bean和依赖进行排序。

理解@Order注解

在了解@Order怎么用之前,我们先看看@Order注解发挥了什么作用。本质上,Spring框架中的@Order注解就是指定bean或组件的顺序。当有多个相同类型的 bean 并且想要控制它们的调用或注入Spring时,@Order就发挥了作用。

和@Bean搭配使用

@Order 的主要用途之一是与 @Bean 结合使用。让我们看一个简单的例子:

@Configuration
public class AppConfig {

    @Bean
    @Order(2)
    public String beanOne() {
        return "Bean One";
    }

    @Bean
    @Order(1)
    public String beanTwo() {
        return "Bean Two";
    }

}

如上所述,我们有两个 String 类型的 bean。如果您要在另一个组件中自动装配 String beans 列表,由于声明指定的顺序,beanTwo 将 在beanOne 之前注入。

排序注入的集合

如果项目中存在多个相同类型的 bean ,Spring 可以将他们以集合的形式注入容器。@Order注解就可以定义他们在集合中的顺序。

@Service
public class ServiceRunner {

    @Autowired
    private List<String> beans;

    public void printBeans() {
        beans.forEach(System.out::println);
    }
}

当调用printBean方法时,就会输出

Bean Two
Bean One

与@Component等衍生的方式一起使用

@Order注解还可以与@Component、@Service、@Repository 和@Controller 注解一起使用。

切面(AOP)的排序

如果您熟悉 Spring 中的面向切面编程 (AOP),您就会意识到对切面进行排序的需求。 @Order 在这里非常简便。

假设您有两个切面:LoggingAspect 和SecurityAspect,并且您希望确保在安全检查之后进行日志记录。以下是使用 @Order 注解的方法:

@Aspect
@Order(2)
@Component
public class LoggingAspect {

}

@Aspect
@Order(1)
@Component
public class SecurityAspect {

}

过滤器排序

@Order 的另一个常见用例是定义过滤器时,特别是当您需要特定过滤器在其他过滤器之前运行时:

@Component
@Order(1)
public class TransactionFilter implements Filter {

}

@Component
@Order(2)
public class AuthenticationFilter implements Filter {

}

在上面的例子中,TransactionFilter 将在 AuthenticationFilter 之前执行。

@Order(value)的重要性

使用@Order时,最好在value之间留出间隙。这种做法可以更轻松地在中间添加新组件,而无需重新排序所有内容。例如,从长远来看,使用 10、20、30 等value值代替 1、2、3 可能是比较好的

总结

@Order 注解是 Spring 框架中的一个实用工具,可以对 Bean 和组件的顺序进行精细控制。无论是排序 bean、切面还是过滤器,@Order 都能确保您的组件协调有序地工作。随着项目的发展,您会发现更多场景中维护特定order变得至关重要。@Order 注解将展示它的能力,确保您的 Spring bean 和依赖项无缝地协同工作。

作者:代码小人物
链接:https://juejin.cn/post/7302439422672224291

请登录后发表评论

    没有回复内容