AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Spring Boot注解学习之@SpringBootApplication(二)

2022-09-21 114
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Spring Boot注解学习之@SpringBootApplication(二)

@ComponentScan

在讲述 @Configuration 启动容器+@Component 注册 Bean 小节中简单介绍了@ComponentScan 注解的使用。


@ComponentScan 的功能其实就是自动扫描并加载符合条件的组件或 bean 定义，最终将这些 bean 定义加载到容器中。我们可以通过 backPackages 等属性指定@ComponentScan 自动扫描的范围，如果不指定，则默认 Spring 框架实现从声明@ComponentScan 所在类的 package 进行扫描，默认情况下是不指定的，所以 SpringBoot 的启动类最好在 root package 下。


首先看下@ComponentScan的源码：


@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
    @AliasFor("basePackages")
    String[] value() default {};
    @AliasFor("value")
    String[] basePackages() default {};
    Class<?>[] basePackageClasses() default {};
    Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
    Class<? extends ScopeMetadataResolver> scopeResolver() default AnnotationScopeMetadataResolver.class;
    ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT;
    String resourcePattern() default "**/*.class";
    boolean useDefaultFilters() default true;
    ComponentScan.Filter[] includeFilters() default {};
    ComponentScan.Filter[] excludeFilters() default {};
    boolean lazyInit() default false;
    @Retention(RetentionPolicy.RUNTIME)
    @Target({})
    public @interface Filter {
        FilterType type() default FilterType.ANNOTATION;
        @AliasFor("classes")
        Class<?>[] value() default {};
        @AliasFor("value")
        Class<?>[] classes() default {};
        String[] pattern() default {};
    }
}
复制代码


重点有以下几个属性：

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


属性

basePackages 与 value


@ComponentScan(basePackages = “”)     //单个
@ComponentScan(basePackages = {“com.example.dao”，“aaa”,“…”})   //多个
//value 同理
复制代码


注意：可以省略 “ basePackages = ”。


@Configuration
@ComponentScan("com.example.dao")
public class MyConfig {}
@Configuration
@ComponentScan("com.example.dao","com.example.service")
public class MyConfig {}
@Configuration
@ComponentScan("com.example.*")   //通配符匹配所有的包
public class MyConfig {}
复制代码


basePackageClasses


@ComponentScan(basePackageClasses = “”)   //单个
@ComponentScan(basePackageClasses = {“HelloController.class”，“bbb”,“…”})  //多个
复制代码


注意：不可以省略“basePackageClasses =” 


@Configuration
@ComponentScan(basePackageClasses = HelloController.class)
public class MyConfig {
}
复制代码


includeFilters


接下来我们用以下代码进行测试。


Repository 的注解类：


package com.example.dao;
@Repository
public class BusinessDAO {
    public void update(){
        System.out.println("调用了 dao 层的 update 方法....");
    }
}
复制代码


Service 的注解类：


package com.example.service;
@Service
public class BusinessService {
    @Autowired
    private BusinessDAO businessDAO;
    public void service(){
        System.out.println("调用了 service 层的 service() 方法 .....");
        businessDAO.update();
    }
}
复制代码


Controller 的注解类：


package com.example.controller;
@Controller
public class BusinessController {
    @Autowired
    private BusinessService service;
    public void request() {
        System.out.println(" 调用了 Controller 的 request() 方法...");
        service.service();
    }
}
复制代码


Configuration 配置类：


package com.example.configuration;
@Configuration
//@ComponentScan(basePackages = {"com.example.dao","com.example.service","com.example.controller"})
@ComponentScan(value = {"com.example.dao","com.example.service","com.example.controller"},
        includeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION,classes = Repository.class)},
        useDefaultFilters = false)
public class ScanConfig {
}
复制代码


测试类代码：


public class ScanConfigTest {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ScanConfig.class);
        String[] definitionNames = context.getBeanDefinitionNames();
        for(String name:definitionNames){
            System.out.println(name);
        }
    }
}
复制代码


执行结果为：


19:22:48.157 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'scanConfig'
19:22:48.162 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'businessDAO'
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
scanConfig
businessDAO
复制代码


根据结果分析： 除了 spring 本身注册的一些 bean 之外，可以看到最后一行，已经将 ScanConfig 这个类和 BusinessDAO 注册进容器中了。


includeFilters  的参数是一个 Filter[] 数组，然后指定 FilterType 的类型为 ANNOTATION，也就是通过注解来过滤，最后的 value 则是 Repository 注解类。配置之后，在 spring 扫描的时候，就会筛选 com.example 下的三个包中，所有被 @Repository 注解标注的类。


注意：需要设置  useDefaultFilters  为 false，否则@ComponentScan 注解会将 被 @Component、@Repository、@Service 和 @Controller 标注的类都注册进容器中。同时因为我们在 Controller 和 Service 注解的类中关联了其他的类(@Autowired)，所以最好在 includeFilters  的 Filter 属性中不要设置为 Controller.class 或 Service.class。


excludeFilters


修改配置类：


@Configuration
//@ComponentScan(basePackages = {"com.example.dao","com.example.service","com.example.controller"})
@ComponentScan(value = {"com.example.dao","com.example.service","com.example.controller"},
        excludeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION,classes = Controller.class)})
public class ScanConfig {
}
复制代码


同 excludeFilters 属性类似， 配置之后，在 spring 扫描的时候，就会跳过 com.example 下的三个包中，所有被 @Controller 注解标注的类。


执行结果为：


19:44:39.191 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'scanConfig'
19:44:39.195 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'businessDAO'
19:44:39.195 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'businessService'
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
scanConfig
businessDAO
businessService
复制代码


添加自定义过滤规则

在前面使用过 @Filter 注解，里面的 type 属性是一个 FilterType 的枚举类型： 


public enum FilterType {
    ANNOTATION,
    ASSIGNABLE_TYPE,
    ASPECTJ,
    REGEX,
    CUSTOM
}
复制代码


使用 CUSTOM 类型，就可以实现自定义过滤规则。 


package com.example.filter;
public class CustomTypeFilter implements TypeFilter {
    @Override
    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
        // 获取当前扫描到的类的注解元数据
        AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
        // 获取当前扫描到的类的元数据
        ClassMetadata classMetadata = metadataReader.getClassMetadata();
        // 获取当前扫描到的类的资源信息
        Resource resource = metadataReader.getResource();
        if (classMetadata.getClassName().contains("Business")){
            return true;
        }
        return false;
    }
}
复制代码


增加 Service 注解修饰的类：


package com.example.service;
@Service
public class UserService {
}
复制代码


修改配置类：


@Configuration
@ComponentScan(value = {"com.example.dao","com.example.service","com.example.controller"},
        excludeFilters = {@ComponentScan.Filter(type = FilterType.CUSTOM,classes = CustomTypeFilter.class)})
public class ScanConfig {
}
复制代码


执行测试类代码，结果为：


19:56:25.419 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'scanConfig'
19:56:25.424 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'userService'
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
scanConfig
userService
复制代码


这里简单对扫描到的类名进行判断，如果类名包含”Business“的就符合条件，就会被剔除，不会注入到容器中。


@Component

1、不指定 bean 的名称，默认为类名首字母小写 university


@Component
public class BeanWithComponent {
    public void sayHello(){
        System.out.println("BeanWithComponent sayHello...");
    }
    public void start(){
        System.out.println("BeanWithComponent 初始化。。。");
    }
    public void cleanUp(){
        System.out.println("BeanWithComponent 销毁。。。");
    }
}
复制代码


获取 bean 方式：


@Autowired
BeanWithComponent beanWithComponent;
复制代码


或


ApplicationContext context = new AnnotationConfigApplicationContext(ComfigureWithScan.class);
BeanWithComponent bean = (BeanWithComponent) context.getBean("beanWithComponent");
复制代码


2、指定 bean 的名称


@Component("bean2")
public class BeanWithComponent {
}
复制代码


获取 bean 方式：


@Autowired
BeanWithComponent bean2;
复制代码


或


ApplicationContext context = new AnnotationConfigApplicationContext(ComfigureWithScan.class);
BeanWithComponent bean = (BeanWithComponent) context.getBean("bean2");
复制代码


总结


@ComponentScan 注解有以下特性：

  • 自定义扫描路径下边带有@Controller，@Service，@Repository，@Component 注解加入 spring 容器
  • 通过 includeFilters 加入扫描路径下没有以上注解的类加入 spring 容器
  • 通过 excludeFilters 过滤出不用加入 spring 容器的类
  • 自定义增加了@Component 注解的注解方式

接下来讲述一下关于@ComponentScan 注解的两个扩展。


@ComponentScans

源码如下：


@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
public @interface ComponentScans {
    ComponentScan[] value();
}
复制代码


配置类：


@Configuration
@ComponentScans(value = @ComponentScan("com.example.dao"))
public class ScanConfig {
}
复制代码


执行结果为：


20:07:45.908 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'scanConfig'
20:07:45.914 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'businessDAO'
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
scanConfig
businessDAO
复制代码


context:component-scan

上述代码我们是通过@Configuration + @ComponentScan 注解来实现 spring 加载，当然也可以在配置文件中加上扫描的配置。


spring-context.xml


<?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
           http://www.springframework.org/schema/context/spring-context-3.0.xsd">
    <!--<context:component-scan base-package="com.example.dao" annotation-config="false">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Repository"/>
    </context:component-scan>-->
    <context:component-scan base-package="com.example.dao" />
    <context:component-scan base-package="com.example.controller" />
    <context:component-scan base-package="com.example.service" />
</beans>
复制代码


修改测试类代码：


public class ScanConfigTest {
    public static void main(String[] args) {
        ApplicationContext  context = new ClassPathXmlApplicationContext("spring-context.xml");
        String[] definitionNames = context.getBeanDefinitionNames();
        for(String name:definitionNames){
            System.out.println(name);
        }
    }
}
复制代码


运行得到以下结果：


14:59:12.773 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'businessDAO'
14:59:12.778 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'businessController'
14:59:12.789 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'businessService'
14:59:12.789 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'userService'
businessDAO
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
businessController
businessService
userService
复制代码


关于  的使用，关于属性的详细讲解可以参考：详解


注意： 中有一个  annotation-config 属性，该属性主要是隐式地向 Spring 容器注册 internalConfigurationAnnotationProcessor、internalAutowiredAnnotationProcessor、internalCommonAnnotationProcessor、internalEventListenerProcessor 以及 internalEventListenerFactory 这五个 bean 类。


当 annotation-config 属性值设为 false 时，即不会注册这五个类。但是@ComponentScan 注解没有该属性。 这是因为在几乎所有情况下，使用@ComponentScan 时，都假定使用默认的注释配置处理（例如，处理@Autowired 和 friends ）。 此外，在使用AnnotationConfigApplicationContext 时，注释配置处理器始终会被注册，这意味着在@ComponentScan 级别禁用它们的任何尝试都将被忽略。


SpringBootApplication 注解中4个方法

@SpringBootApplication不仅包括上面的三个重要注解，还包含有4个方法:


image.png


  • Class[] exclude() default {}; 根据 Class 来排除特定的类加入 Spring 容器，传入参数是 class 类型；
  • String[] excludeName() default {}; 根据 Class Name 排除特定的类加入 Spring 容器，传入参数是 class 的全类名字字符串数组；
  • String[] scanBasePackages() default {}; 指定扫描包，参数是包名的字符串数组；
  • Class[] scanBasePackageClasses() default {}; 指定扫描包，参数是 Class 类型数组。


小结

这里总结下@SpringBootApplication 中的三个重要注解的特征：

  • @Configuration


定义 Spring Ioc 容器的配置类。


  • @EnableAutoConfiguration

从 classpath 中搜寻所有 META/spring.factories 配置文件，并将其中org.springframework.boot.autoconfigure.EnableAutoConfiguration 对应的配置项，也就是一个自动配置类列表加载到 Ioc 容器中。 简单说，就是@EnawebleAutoConfiguration 让 Spring Boot 根据类路径下的 jar 包依赖为当前项目进行自动配置，例如，添加了 spring-boot-starter-web 依赖，会自动添加 Tomcat 和 Spring MVC 的依赖。而对于所有标注@Configuration 的配置类，统一使用ConfigurationClassParser解析的。


  • @ComponentScan

自动扫描并加载符合条件的组件或者 bean 定义。



文章标签：
Java
前端开发
容器
应用服务中间件
Spring
关键词：
Spring注解
Spring boot注解
Spring boot
Spring学习
Spring boot学习
hresh
目录
相关文章
三三是该溜子
|
2天前
|
Java Spring
【Spring】方法注解@Bean，配置类扫描路径
@Bean方法注解，如何在同一个类下面定义多个Bean对象，配置扫描路径
三三是该溜子
110 73
三三是该溜子
|
2天前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration，关于Bean对象的五个常用注解
三三是该溜子
37 12
三三是该溜子
|
2天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一：对于同一个项目，我们在使用idea的过程中，使用汉字注解完后，再打开该项目，汉字变成乱码问题二：本来a项目中，汉字注解调试好了，没有乱码了，但是创建出来的新的项目，写的注解又成乱码了。
三三是该溜子
26 6
最好zzz
|
29天前
|
前端开发 Java 开发者
Spring MVC中的请求映射：@RequestMapping注解深度解析
在Spring MVC框架中，`@RequestMapping`注解是实现请求映射的关键，它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践，为开发者提供一份详尽的技术干货。
最好zzz
110 2
最好zzz
|
29天前
|
前端开发 Java Spring
探索Spring MVC：@Controller注解的全面解析
在Spring MVC框架中，`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义，还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解，包括其定义、用法、以及在Spring MVC中的作用。
最好zzz
50 2
愿天堂没有BUG（公众号同名）
|
7月前
|
XML 安全 Java
深入实践springboot实战 蓄势待发 我不是雷锋 我是知识搬运工
springboot，说白了就是一个集合了功能的大类库，包括springMVC，spring，spring data，spring security等等，并且提供了很多和可以和其他常用框架，插件完美整合的接口（只能说是一些常用框架，基本在github上能排上名次的都有完美整合，但如果是自己写的一个框架就无法实现快速整合）。
愿天堂没有BUG（公众号同名）
71 0
萝卜丝丸子
|
4月前
|
缓存 Java Maven
Java本地高性能缓存实践问题之SpringBoot中引入Caffeine作为缓存库的问题如何解决
Java本地高性能缓存实践问题之SpringBoot中引入Caffeine作为缓存库的问题如何解决
萝卜丝丸子
125 1
yuanzhengme
|
7月前
|
Java 数据安全/隐私保护
Neo4j【付诸实践 01】SpringBoot集成报错org.neo4j.driver.exceptions.ClientException:服务器不支持此驱动程序支持的任何协议版本（解决+源代码）
Neo4j【付诸实践 01】SpringBoot集成报错org.neo4j.driver.exceptions.ClientException:服务器不支持此驱动程序支持的任何协议版本（解决+源代码）
yuanzhengme
369 1
小周sir
|
3月前
|
Java 应用服务中间件 开发者
深入探索并实践Spring Boot框架
深入探索并实践Spring Boot框架
小周sir
63 2
萝卜丝丸子
|
4月前
|
缓存 Java Spring
Java本地高性能缓存实践问题之在Spring Boot中启用缓存支持的问题如何解决
Java本地高性能缓存实践问题之在Spring Boot中启用缓存支持的问题如何解决
萝卜丝丸子
71 0

热门文章

最新文章

  • 1
    Spring Cloud Alibaba：一站式微服务解决方案
  • 2
    从单体到微服务：如何借助 Spring Cloud 实现架构转型
  • 3
    深入 Spring Cloud Gateway 过滤器
  • 4
    Spring MVC中的请求映射：@RequestMapping注解深度解析
  • 5
    【SpringFramework】Spring初体验
  • 6
    利用Spring Cloud Gateway Predicate优化微服务路由策略
  • 7
    京东面试：聊聊Spring事务？Spring事务的10种失效场景？加入型传播和嵌套型传播有什么区别？
  • 8
    详解Spring Profiles：在Spring Boot中实现环境配置管理
  • 9
    Spring MVC中的控制器：@Controller注解全解析
  • 10
    使用lock4j-redis-template-spring-boot-starter实现redis分布式锁
  • 1
    springboot 启动原理、启动过程、启动机制的介绍
    523
  • 2
    springboot实现文件防盗链设计
    129
  • 3
    Spring Boot中一般如何使用线程池？
    768
  • 4
    Spring Boot 源码面试知识点
    103
  • 5
    【MongoDB 专栏】MongoDB 与 Spring Boot 的集成实践
    256
  • 6
    深入探索Spring Boot Web应用源码及实战应用
    111
  • 7
    ruoyi-nbcio从spring2.7.18升级springboot到3.1.7，java从java8升级到17（二）
    361
  • 8
    springboot数据库回滚失败原因
    64
  • 9
    springboot全局自定义异常
    44
  • 10
    springBoot+rabbit消息获取和消息确认
    129

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第二阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库

    • 相关实验场景

    更多
  • Spring-cloud-bus-rocketmq入门与实践
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    手把手教你白嫖阿里云服务器(免费领服务器)