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

 更新时间:2021年11月08日 10:09:31   作者:三毛村滴雪鱼粉  
这篇文章主要介绍了SpringBoot默认包扫描机制及@ComponentScan指定扫描路径详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

SpringBoot默认包扫描机制

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

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

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

在这里插入图片描述

访问结果正常

在这里插入图片描述

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

在这里插入图片描述

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

在这里插入图片描述

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

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

@ComponentScan的使用

常用参数含义

  • basePackagesvalue: 用于指定包的路径,进行扫描(默认参数)
  • 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");
    }
}

目录结构如下:

在这里插入图片描述

启动类上加@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

在这里插入图片描述

@Component与@ComponentScan

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Struts2实现文件上传时显示进度条功能

    Struts2实现文件上传时显示进度条功能

    这篇文章主要为大家详细介绍了Struts2实现文件上传时显示进度条功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-05-05
  • Java线程之线程同步synchronized和volatile详解

    Java线程之线程同步synchronized和volatile详解

    这篇文章主要介绍了Java线程之线程同步synchronized和volatile详解,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • Java 数据结构与算法系列精讲之汉诺塔

    Java 数据结构与算法系列精讲之汉诺塔

    汉诺塔是源于印度一个古老传说的益智玩具。大梵天创造世界时做了三根石柱,在一根柱子上从下往上按大小顺序摞着64片黄金圆盘。大梵天命令婆罗门把圆盘从下面开始按大小顺序重新摆放在另一根柱子上。并且规定,在小圆盘上不能放大圆盘,三根柱子之间一次只能移动一个圆盘
    2022-02-02
  • 使用Idea或Datagrip导入excel数据的方法

    使用Idea或Datagrip导入excel数据的方法

    这篇文章主要介绍了使用Idea或Datagrip导入excel数据的方法,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • Java的Hibernate框架中复合主键映射的创建和使用教程

    Java的Hibernate框架中复合主键映射的创建和使用教程

    复合主键映射用起来比普通的增加主键字段要复杂,这里我们就来共同学习Java的Hibernate框架中复合主键映射的创建和使用教程,需要的朋友可以参考下
    2016-07-07
  • Java模拟qq软件的详细过程

    Java模拟qq软件的详细过程

    这篇文章主要为大家详细介绍了用Java实现模拟QQ,实现了消息通信+登陆界面美化,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • 使用Java和SpringBoot实现服务器发送事件(Server-Sent Events)

    使用Java和SpringBoot实现服务器发送事件(Server-Sent Events)

    使用Java开发web应用,大多数时候我们提供的接口返回数据都是一次性完整返回,有些时候,我们也需要提供流式接口持续写出数据,以下提供一种简单的方式,本文给大家介绍了如何在Java web中实现服务器发送事件,需要的朋友可以参考下
    2024-02-02
  • 什么情况下会出现java.io.IOException : Broken pipe这个错误以及解决办法

    什么情况下会出现java.io.IOException : Broken pipe这个错误以及解决办法

    这篇文章主要介绍了什么情况下会出现java.io.IOException : Broken pipe这个错误以及解决办法的相关资料,这个错误表示通信另一端已关闭连接,常发生在客户端关闭连接、网络超时或资源不足等情况,文中将解决办法介绍的非常详细,需要的朋友可以参考下
    2024-10-10
  • java spring validation 自动、手动校验

    java spring validation 自动、手动校验

    HibernateValidator简化了Java开发中的参数校验过程,提供自动和手动两种校验方式,通过引入相关依赖并使用@Validated注解,可以实现自动校验,手动校验则需要使用ValidatorUtils类,此方法有效减少代码重复,提高开发效率
    2024-09-09
  • Spring boot如何基于拦截器实现访问权限限制

    Spring boot如何基于拦截器实现访问权限限制

    这篇文章主要介绍了Spring boot如何基于拦截器实现访问权限限制,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10

最新评论