第 8 节 @ComponentScan注解与Java Bean对象自动注入

我不是女神ヾ 2022-11-05 06:30 133阅读 0赞

### 1 Spring 框架的 Java Bean 对象自动注入 ###

#### 1.1 @ComponentScan 注解与 <context:component-scan /> 标签的关系 ####

在前一小节中我们多次提到 @ComponentScan 注解，@ComponentScan 是 Spring 框架的一个重要注解，也是 SpringBoot 的 @SpringBootApplication 注解包含的其中一个注解，主要用于实现 Java bean 对象的自动扫描、加载与注入到 Spring 的 IOC 容器。

@ComponentScan 注解与 XML 文件中的 <context:component-scan /> 标签是等效的，在 Spring 3.x 引入基于 @Configuration 注解实现 Java 类配置时，提供了 @ComponentScan 注解来替代 XML 文件的 <context:component-scan /> 标签。

不过 @ComponentScan 注解虽然在语义上等价于 XML 的 <context:component-scan /> 标签，但是在作用上 <context:component-scan /> 标签还具备自动开启注解驱动，即同时具备 <context: annotation-config /> 标签的功能，所以在 XML 文件中不额外配置 <context:annotation-config /> 标签也是可以的，而这点 @ComponentScan 注解是没有的。

> tips：当使用 @ComponentScan 注解时，要么与 @Configuration 注解一起用在基于 AnnotationConfigApplicationContext（注解驱动的 IOC 容器实现） 及其子类作为 Spring IOC 容器的场景中，（其中 SpringBoot 框架内部就是基于这种方式来实现），要么需要在 XML 文件中额外配置 <context:annotation-config /> 标签来开启注解驱动，否则 @ComponentScan 注解无法生效。
> 
> 这点也是新手朋友很容易犯的一个错误，即明明正确配置了 @ComponentScan 注解，但是使用指定包下面的类时出现 null 异常 o(╥﹏╥)o。

#### 1.2 @ComponentScan 注解注入的目标类：@Component 注解 ####

@ComponentScan 注解在使用的时候通常需要在其 basePackages 属性中配置需要扫描的包，如下：

@Configuration // 相对于 <beans> 标签
    @ComponentScan(basePackages = "com.yzxie.demo.springdemo.context") // 相当于 <context:component-scan /> 标签
    public class ApplicationConfig { 
      // 省略其他代码
    }

然后 Spring 框架在初始化 IOC 容器并执行到 @ComponentScan 注解的处理时，会对 basePackages **指定的包及其子包**的所有类进行扫描，并将使用了 @Component 注解及其子注解的类自动加载和注入到 Spring 的 IOC 容器。

@Component 注解是在 Spring 2.5 版本引入的，使用 @Component 注解标注某个类，则表示该类可以被自动加载到 Spring IOC 容器。而 Spring 框架提供 @Component 注解体系的原因是：不管是基于 XML 配置文件，还是基于 @Configuration 注解的 Java 类配置，如果需要将 Java bean 对象交给 Spring 的 IOC 容器管理，默认都是需要通过在 XML 配置文件使用 标签配置，或者在 @Configuration 注解的 Java 配置类的内部方法上加上 @Bean 注解。

如果全部 Java bean 对象都需要这样一个个来进行配置，未免过于繁琐和需要耗费大量的工作，所以从 Spring 2.5 版本开始引入基于注解实现 Java bean 对象的自动注入，具体为通过在类上使用 @Component 注解标注和结合 XML 文件的 <context:component-scan /> 标签或者 Java 配置类的 @ComponentScan 注解来实现自动扫描和注入功能。

> 知识拓展：
> 
> 在 Spring 应用开发当中，我们通常会使用到 @Controller，@Service，@Repository 三个注解来分别标注 SpringMVC 框架的请求处理控制器，业务逻辑实现类和数据访问类。这三个注解其实是 @Component 注解的子注解，只是通过命名来更好地区分类的功能，所以也可以被 @ComponentScan 注解自动扫描和注入到 IOC 容器中。

#### 1.3 选择性注入代替全量注入 ####

在使用 @ComponentScan 注解时，一般情况下，我们只需要配置 basePackages 属性来指定需要扫描的包。但是在某些情况下，例如，对应功能不需要使用某个类，或者希望不同的 IOC 容器加载不同的类，此时我们并不希望这个包及其子包下面所有使用了 @Component 注解及其子注解，如 @Controller，@Service 等的类都被加载。所以针对这种情况， @ComponentScan 注解提供了 useDefaultFilters 属性来判断是否使用默认过滤规则，默认为 true。

如果需要实现选择性注入，则首先需要将该属性设置为 false，不过此时需要扫描和注入哪些类呢？此时我们需要通过 @ComponentScan 注解提供的另外两个属性来实现类的过滤功能，这两个属性分别为：includeFilters 和 excludeFilters，其中 includeFilters 过滤需要注入的类，excludeFilters 过滤不需要注入的类。如下为这两个属性在 @ComponentScan 注解内部的定义：

// 包含过滤集合
    Filter[] includeFilters() default { };
    // 排除过滤器集合
    Filter[] excludeFilters() default { };

Filter 接口也是在 @Component 注解内部定义，如下：

@Retention(RetentionPolicy.RUNTIME)
    @Target({ })
    @interface Filter { 
    
       // 基于注解的过滤
       FilterType type() default FilterType.ANNOTATION;
    
       // 基于类的过滤
       @AliasFor("classes")
       Class<?>[] value() default { };
    
       // 基于类的过滤，与value等效
       @AliasFor("value")
       Class<?>[] classes() default { };
    
       // 基于正则表达式的过滤
       String[] pattern() default { };
    
    }

由 Filter 接口定义可知，我们可以**注解、类以及正则表达式**三种方式指定过滤规则。如下我们演示基于注解的过滤实现，使用 includeFilters 属性指定只加载使用了 @Service 注解的所有类：

@Configuration // 相对于 <beans> 标签
    @ComponentScan(basePackages = "com.yzxie.demo.springdemo.context", useDefaultFilters = false,
        includeFilters = { 
            @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = { Service.class})
        }) // 相当于 <context:component-scan /> 标签
    public class ApplicationConfig { 
    	// 省略其他代码
    }

> 拓展知识：
> 
> 在 <contenxt:component-scan /> 注解当中也包含 use-default-filters 属性，也可以修改为 true 或 false，includeFilters 和 excludeFilters 则是分别对应 <context:include-filter /> 子标签和 <context:exclude-filter /> 子标签。

#### 1.4 @SpringBootApplication 位于项目根目录的原因 ####

默认情况下，SpringBoot 框架会在项目的根目录包含 @SpringApplicationBoot 注解。由于这个注解内部包含 @ComponentScan 注解，所以我们不能直接通过 @SpringApplicationBoot 注解来指定 @ComponentScan 注解需要扫描的包。既然无法指定 basePackages 属性，那么 SpringBoot 怎么知道需要扫描和自动注入哪些包的类呢？

这里主要是利用了 @ComponentScan 注解的扫描规则：如果不通过 basePackages 属性指定需要扫描的包，则默认情况下会扫描和自动注入 @ComponentScan 注解当前标注的类所在的包及其子包的所有使用了 @Component 注解及其子注解的类。

由于 @SpringBootApplication 注解标注的项目启动类 Application 是位于项目根目录，故 @ComponentScan 注解可以扫描和自动注入整个项目所有包的对应类。

> tips：将 @SpringBootApplication 注解放在项目根目录来一股脑地加载所有使用了 @Component 注解及其子注解的类在某些情况下是不合适的。所以在 SpringBoot 应用中，我们可以不使用 @SpringBootApplication 注解，而是在项目启动类 Application 中分别指定其内部的三个注解，即 @SpringBootConfiguration，@ComponentScan 和 @EnableAutoConfiguration，这样就可以在 ComponentScan 注解中指定 basePackages 属性的值来指定需要扫描的包。

### 2 总结 ###

在本小节中我们首先对比了 @ComponentScan 注解与 XML 的 <context:component-scan /> 标签，以便对 XML 配置熟悉的朋友能够快速理解 @ComponentScan 注解的作用。

其次是介绍了 @ComponentScan 注解的相关用法，包括通过 basePackages 属性配置需要扫描的包，通过 useDefaultFilters，includeFilters 或 excludeFilters 属性实现对指定的包内的类的过滤，实现选择性注入，具体可以通过注解，类和正则表达式三种方式设定过滤规则。

最后是讲解了 @Component 注解体系的相关注解，如 @Controller，@Service，@Repository 与 @ComponentScan 注解的关系。即 @ComponentScan 注解主要是对使用了这些注解的类进行扫描和自动注入。除此之外，分析了 SpringBoot 的 @SpringBootApplication 注解包含 @ComponentScan 注解的作用和默认唯一项目根目录的原因。