SpringBoot默认包扫描机制及@ComponentScan指定扫描路径详解

妖狐艹你老母 2023-10-01 09:53 35阅读 0赞

## SpringBoot默认包扫描机制及@ComponentScan指定扫描路径详解 ##

### SpringBoot默认包扫描机制 ###

标注了@Component和@Component的衍生注解如@Controller,@Service,@Repository就可以把当前的Bean加入到IOC容器中。那么SpringBoot是如何知道要去扫描@Component注解的呢。**@ComponentScan做的事情就是告诉Spring从哪里找到bean**

**SpringBoot默认包扫描机制：** 从启动类所在包开始，扫描当前包及其子级包下的所有文件。我们可以通过以下的测试来验证一下。

启动应用并访问BannerController这个控制器，目录结构如图

![在这里插入图片描述][53711d451d2eb01a5c9bbb400d03154b.png]

访问结果正常

![在这里插入图片描述][dd580e3489296fdf754be516b4e08ce0.png]

当把BannerController移动到上一级目录，应用可以正常启动

![在这里插入图片描述][fdc0ba69e95f37c54c25c5c7ce56f0dd.png]

但是再次访问刚才的路径时却出现了如下错误，代码是没有变动的，是Controller扫描 不到了。

![在这里插入图片描述][66e1393d3af6e2d37f7e854b4bd11f4d.png]

实际上SpringBoot是通过@ComponentScan进行扫描。默认情况下，入口类上面的@SpringBootApplication里面有一个@ComponentScan,也就相当于@ComponentScan标注在入口类上。

所以默认情况下，扫描入口类同级及其子级包下的所有文件。当我们想自己制定包扫描路径就需要加一个@ComponentScan

### @ComponentScan的使用 ###

#### 常用参数含义 ####

*  `basePackages`与`value`: 用于指定包的路径，进行扫描(默认参数)
 *  `basePackageClasses`: 用于指定某个类的包的路径进行扫描
 *  `includeFilters`: 包含的过滤条件
 *  `FilterType.ANNOTATION`：按照注解过滤
 *  `FilterType.ASSIGNABLE_TYPE`：按照给定的类型
 *  `FilterType.ASPECTJ`：使用ASPECTJ表达式
 *  `FilterType.REGEX`：正则
 *  `FilterType.CUSTOM`：自定义规则
 *  `excludeFilters`: 排除的过滤条件，用法和includeFilters一样
 *  `nameGenerator`: bean的名称的生成器
 *  `useDefaultFilters`: 是否开启对@Component，@Repository，@Service，@Controller的类进行检测

**指定要扫描的包**

上述例子，如果想扫描启动类上一级包，使用@ComponentScan指定包扫描路径,即可将BannerController加入到容器

@SpringBootApplication
    @ComponentScan("com.lin")
    public class MissyouApplication {
        
        public static void main(String[] args) {
        
            SpringApplication.run(MissyouApplication.class, args);
        }
    }

**excludeFilters 排除某些包的扫描**

测试类准备：

@Controller
    public class BannerController {
        
        BannerController(){
        
            System.out.println("Hello BannerController");
        }
    }
    --------------------------------------------------------------------
    @Service
    public class TestService {
        
        TestService(){
        
            System.out.println("Hello TestService");
        }
    }

目录结构如下：

![在这里插入图片描述][a0e3bf770118095a2e441679f971053d.png]

启动类上加@ComponentScan指定扫描lin这个包并排除@Controller这个注解标注的类

@SpringBootApplication
    @ComponentScan(value = "com.lin",
            excludeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION,value = {
        Controller.class})})
    public class MissyouApplication {
        
        public static void main(String[] args) {
        
            SpringApplication.run(MissyouApplication.class, args);
        }
    }

启动应用，控制台打印出了TestService而没有BannerController

![在这里插入图片描述][c7b3793e16865002fce8def17bf621d3.png]

#### @Component与@ComponentScan ####

在某个类上使用@Component注解，表明当需要创建类时，这个被注解标注的类是一个候选类。就像是有同学在举手。 @ComponentScan 用于扫描指定包下的类。就像看都有哪些举手了。

--------------------

## springboot多模块包扫描问题的解决方法 ##

**问题描述：**

springboot建立多个模块，当一个模块需要使用另一个模块的服务时，需要注入另一个模块的组件，如下面图中例子：

![在这里插入图片描述][460dfbb0645dc0e7166223e86377deeb.png]

![在这里插入图片描述][5729abf249f298c70ff8d16ceacc9d18.png]

memberservice模块中的MemberServiceApiImpl类需要注入common模块中的RedisService组件，该怎么注入呢？

**解决：**

在memberservice模块的启动类上加上RedisService类所在包的全路径的组件扫描，就像这样：

![在这里插入图片描述][6e68cc92792a16bb6ad994b9a14f448d.png]

注意启动类上方的注解@ComponentScan(basePackages=\{“com.whu.commom.redis”\})，这一句实际上就已经加上了RedisService的组件扫描，但是这样做是有问题的，我发现启动后服务不能正常访问。查找资料后发现是因为@ComponentScan 和@SpringBootApplication注解的包扫描有冲突，@ComponentScan注解包扫描会覆盖掉@SpringBootApplication的包扫描。解决办法就是在@ComponentScan(basePackages=\{“com.whu.commom.redis”\})的基础上加上@SpringBootApplication扫描的包，那么@SpringBootApplication扫描了哪些包呢？实际上，它默认扫描的是启动类所在的包及其子包，所以我的例子上需要改成@ComponentScan(basePackages=\{“com.whu.commom.redis”,“com.whu.memberservice”\}). OK ，结束！！

[53711d451d2eb01a5c9bbb400d03154b.png]: https://img-blog.csdnimg.cn/img_convert/53711d451d2eb01a5c9bbb400d03154b.png
[dd580e3489296fdf754be516b4e08ce0.png]: https://img-blog.csdnimg.cn/img_convert/dd580e3489296fdf754be516b4e08ce0.png
[fdc0ba69e95f37c54c25c5c7ce56f0dd.png]: https://img-blog.csdnimg.cn/img_convert/fdc0ba69e95f37c54c25c5c7ce56f0dd.png
[66e1393d3af6e2d37f7e854b4bd11f4d.png]: https://img-blog.csdnimg.cn/img_convert/66e1393d3af6e2d37f7e854b4bd11f4d.png
[a0e3bf770118095a2e441679f971053d.png]: https://img-blog.csdnimg.cn/img_convert/a0e3bf770118095a2e441679f971053d.png
[c7b3793e16865002fce8def17bf621d3.png]: https://img-blog.csdnimg.cn/img_convert/c7b3793e16865002fce8def17bf621d3.png
[460dfbb0645dc0e7166223e86377deeb.png]: https://img-blog.csdnimg.cn/img_convert/460dfbb0645dc0e7166223e86377deeb.png
[5729abf249f298c70ff8d16ceacc9d18.png]: https://img-blog.csdnimg.cn/img_convert/5729abf249f298c70ff8d16ceacc9d18.png
[6e68cc92792a16bb6ad994b9a14f448d.png]: https://img-blog.csdnimg.cn/img_convert/6e68cc92792a16bb6ad994b9a14f448d.png