无需手动注册:精通Spring注解扫描的高效利用

简介: 无需手动注册:精通Spring注解扫描的高效利用


注解扫描

Spring 框架中,注解扫描(Annotation Scanning)是一种自动发现和注册带有特定注解的组件的机制。通过注解扫描,Spring 可以自动将带有特定注解的类注册为 Bean,并将其纳入到应用程序上下文中进行管理。

要配置注解扫描,可以使用 @ComponentScan 注解或通过 XML 配置文件进行配置。

XML 方式

我们需要再 Spring 的配置文件中引入 context 命名空间,然后使用 标签进行扫描的配置。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    <!-- 配置扫描包 -->
    <context:component-scan base-package="world.xuewei, world.zhangsan" use-default-filters="true">
        
    </context:component-scan>
</beans>

我们需要指定 base-package 属性,配置需要扫描的包路径(多个包用 , 分割),这样默认扫描策略就会扫描对应包及其子包下的 Bean。use-default-filters 属性表示是否开启默认扫描策略,默认为 true 表示开启。

排除方式

我们可以在 内通过 标签配置排除策略,配置排除策略需要我们开启默认的扫描策略,即 use-default-filters="true"

可以通过为标签的 type 属性指定策略,expression 属性指定对应策略的表达式内容。Spring 提供了五种策略可以使用:

  1. assignable:指定某一类型加入策略。expression 需要指定为某个类的全限定类名。
  2. annotation:指定某一注解加入策略,标记此注解的类都进行策略决策。expression 需要指定为某个注解类的全限定类名。
  3. aspectj:指定切入点表达式加入策略(只包含包名和类名部分),expression 值为切入点表达式。
  4. regex:指定正则表达式加入策略,expression 值为正则表达式。
  5. custom:指定自定义过滤器加入策略,expression 值过滤器类的 Class。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    <!-- 配置扫描包 -->
    <context:component-scan base-package="world.xuewei, world.zhangsan" use-default-filters="true">
        <context:exclude-filter type="assignable" expression="world.xuewei.entity.Account"/>
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
        <context:exclude-filter type="aspectj" expression="world.xuewei.service..*"/>
        <context:exclude-filter type="regex" expression=".*Test"/>
        <context:exclude-filter type="custom" expression="world.xuewei.filter.MyCustomFilter"/>
    </context:component-scan>
</beans>

包含方式

我们可以在 内通过 标签配置包含策略,配置包含策略需要我们关闭默认的扫描策略,即 use-default-filters="false"

可以通过为标签的 type 属性指定策略,expression 属性指定对应策略的表达式内容。Spring 提供了五种策略可以使用:

  1. assignable:指定某一类型加入策略。expression 需要指定为某个类的全限定类名。
  2. annotation:指定某一注解加入策略,标记此注解的类都进行策略决策。expression 需要指定为某个注解类的全限定类名。
  3. aspectj:指定切入点表达式加入策略(只包含包名和类名部分),expression 值为切入点表达式。
  4. regex:指定正则表达式加入策略,expression 值为正则表达式。
  5. custom:指定自定义过滤器加入策略,expression 值过滤器类的 Class。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    <!-- 配置扫描包 -->
    <context:component-scan base-package="world.xuewei, world.zhangsan" use-default-filters="false">
        <context:include-filter type="assignable" expression="world.xuewei.entity.Account"/>
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Service"/>
        <context:include-filter type="aspectj" expression="world.xuewei.service..*"/>
        <context:include-filter type="regex" expression=".*Test"/>
        <context:include-filter type="custom" expression="world.xuewei.filter.MyCustomFilter"/>
    </context:component-scan>
</beans>

包含方式与排除方式需要互斥使用

注解方式

@ComponentScan 注解是 Spring 提供的一种基于注解的配置方式,它可以在 Java 类上直接使用,也可以在配置类上使用。

@ComponentScan 注解包含几个重要的属性:basePackagesexcludeFiltersincludeFiltersuseDefaultFilters。作用和上述 XML 方式一样。

@ComponentScan(basePackages = "world.xuewei", excludeFilters = {
        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = Account.class),
        @ComponentScan.Filter(type = FilterType.ANNOTATION, value = Service.class),
        @ComponentScan.Filter(type = FilterType.REGEX, pattern = ".*Test"),
        @ComponentScan.Filter(type = FilterType.ASPECTJ, pattern = "world.xuewei.dao..*"),
        @ComponentScan.Filter(type = FilterType.CUSTOM, classes = MyCustomFilter.class),
})
@Component
public class AnnotationTest {
  // ...
}



相关文章
|
10月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
859 0
|
10月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1507 128
|
10月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
1095 1
使用Spring的@Retryable注解进行自动重试
|
9月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
779 2
|
10月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
651 12
|
10月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
540 0
探索Spring Boot的@Conditional注解的上下文配置
|
10月前
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
385 0
Spring中最大化@Lazy注解,实现资源高效利用
|
10月前
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
344 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
|
10月前
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
1824 0
|
10月前
|
XML Java 测试技术
使用 Spring 的 @Import 和 @ImportResource 注解构建模块化应用程序
本文介绍了Spring框架中的两个重要注解`@Import`和`@ImportResource`,它们在模块化开发中起着关键作用。文章详细分析了这两个注解的功能、使用场景及最佳实践,帮助开发者构建更清晰、可维护和可扩展的Java应用程序。
447 0