spring 组件 扫描

于 2023-03-27 12:50:39 发布
阅读量292 收藏
点赞数
文章标签： spring java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44745938/article/details/119062689
版权

@ComponentScan(basePackages = {“com”})

组件扫描
@ComponentScan等价于
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
context.scan("com");


模拟包扫描

获取项目真实路径
File file =new File(RealPath)
String[] files= file.list()
clazz = files.for(file.split(.class)[0])
class.forname(clazz)

扫描当前包及其子包

在这里插入图片描述

在这里插入图片描述

根据spring的包表达式进行扫描 classpath*:/com/**/*.class

  • Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath);

由源码可见Spring提供了一个资源扫描的类 可以根据spring的包表达式进行扫描


  PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        try {
            Resource[] resource = resolver.getResources("classpath*:/com/atsun/**/*.class");
            for (int i = 0; i < resource.length; i++) {
                
                System.out.println(resource[i].getFilename()+"---------------");
            }
        } catch (IOException e) {
            e.printStackTrace();
        }



或者

PathMatchingResourcePatternResolver resolver = (PathMatchingResourcePatternResolver)ResourcePatternUtils.getResourcePatternResolver(null);
 try {
     Resource[] resource = resolver.getResources("classpath*:/com/atsun/**/*.class");
     for (int i = 0; i < resource.length; i++) {

         System.out.println(resource[i].getFilename()+"---------------");
     }
 } catch (IOException e) {
     e.printStackTrace();
 }

在这里插入图片描述
TypeFilter

在这里插入图片描述
这里添加的typefilter
org.springframework.context.annotation.ComponentScanAnnotationParser#parse
在这里插入图片描述
确定加了@Compent注解后

  • ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);

在这里插入图片描述
再判断是否有资格成为候选类，由就添加进候选集合
这也就是为什么接口上加了@Component注解还是无法扫描进容器的原因
在这里插入图片描述+ 添加进候选集合
在这里插入图片描述

由源码可以看出，我们也可以借助spring的扫描器来自定义扫描路径，需要将判断条件修改成我们自己的就行了

添加自定义扫描


public class MyScanner extends ClassPathScanningCandidateComponentProvider {


    public MyScanner(){
        this.addIncludeFilter(new TypeFilter() {
            @Override
            public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
                return true;
            }
        });

    }

    protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
        AnnotationMetadata metadata = beanDefinition.getMetadata();
//	判断类是否有资格作为候选  有可能时内部类 ,接口或者抽象类,有没有加lookup
        return metadata.isInterface();
    }

}

第二种方法添加自定义扫描


@Retention(RetentionPolicy.RUNTIME)
public @interface Sunxxx {
}

public class A extends ClassPathBeanDefinitionScanner {
    public A(BeanDefinitionRegistry registry) {
        super(registry);
    }

    @Override
    protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
        AnnotationMetadata metadata = beanDefinition.getMetadata();
		只要是接口就可以
        return metadata.isInterface();

    }

}

A a = new A(context);


//private final List<TypeFilter> includeFilters = new ArrayList<>();


注册	includeFilters 
a.addIncludeFilter(new AnnotationTypeFilter(Sunxxx.class));

int com = a.scan("com");


System.out.println(com);

在这里插入图片描述
mybatis
在这里插入图片描述

  • 自定义就是改变isCandidateComponent方法的判断

再看一下是何时添加的TypeFilter --》 自定义过滤规则 CUSTOM @MapperScanner注解时就有使用
由 new AnnotationConfigApplicationContextnew —> ClassPathBeanDefinitionScanner() 一步步调用过来
在这里插入图片描述

在spring-mybatis中扫描的拓展
在这里插入图片描述
在这里插入图片描述

扫描在哪里执行的？

扫描是在执行BeanDefinitionRegistryPostProcess时执行的，进行扫描的类是他的一个子类ConfigurationClassProcess中

在创建spring应用时，先会调用父类实例化bean工厂

AnnotationConfigApplicationContext extend   GenericApplicationContext
public AnnotationConfigApplicationContext() {
	注册默认bd 
	this.reader = new AnnotatedBeanDefinitionReader(this);
	this.scanner = new ClassPathBeanDefinitionScanner(this);
}

在这里插入图片描述

这里注册默认的5个bd
在这里插入图片描述

在这里插入图片描述

在这个方法中会实例化实现了BeanDefinitionRegistryPostProcessor的类，而ConfigurationClassPostProcess就实现了这个类

org.springframework.context.support.PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors(org.springframework.beans.factory.config.ConfigurableListableBeanFactory, java.util.List<org.springframework.beans.factory.config.BeanFactoryPostProcessor>)

在这里插入图片描述

此时已经有了bd，但是还没在容器中，如果getBean的话就会去创建它
在这里插入图片描述

bean工厂后置处理器


//			ConfigurationClassPostProcessor 是唯一一个实现了BeanDefinitionRegistryPostProcessor的类
//			执行 ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry
//			这个类中完成扫描 解析注解 当解析到import时 mybatis中执行import的类的 一个方法
扫描bd {
	普通注解，
	配置类
}
invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);


先获取所有的bd candidateNames  默认5个+自己注册的配置类一个


else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {
候选类是一个 ImportBeanDefinitionRegistrar -> 委托给它注册额外的 bean 定义
	Class<?> candidateClass = candidate.loadClass();

如果import的类 实现了ImportBeanDefinitionRegistrar接口, 主要是实例化它, 拓展点
	ImportBeanDefinitionRegistrar registrar =
			ParserStrategyUtils.instantiateClass(candidateClass, ImportBeanDefinitionRegistrar.class,
					this.environment, this.resourceLoader, this.registry);

把实例好的ImportBeanDefinitionRegistrar 放入map中  后面会循环执行
	configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata());
}

mybatis  就是在执行
ImportBeanDefinitionRegistrar.registerBeanDefinitions方法时，给bd中添加了一个
MapperScannerConfigurer的bd 他实现了 BeanDefinitionRegistryPostProcessor
等spring自己执行到BeanDefinitionRegistryPostProcessor的postProcessBeanDefinitionRegistry时再来完成扫描

新版中多了一个方式 可以不用@MapperScan注解了
因为MapperScannerConfigurer也实现了 BeanDefinitionRegistryPostProcessor
所以spring就会去执行他的方法
在这里插入图片描述


/**
 * customeimport.properties配置文件中的内容：
 * 		custome.importselector.expression= com.itheima.service.impl.*
 * @author 黑马程序员
 * @Company http://www.itheima.com
 */
public class CustomeImportSelector implements ImportSelector {

    private String expression;

    public CustomeImportSelector(){
        try {
            Properties loadAllProperties = PropertiesLoaderUtils.loadAllProperties("customeimport.properties");
            expression = loadAllProperties.getProperty("custome.importselector.expression");
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

    /**
     * 生成要导入的bean全限定类名数组
     * @param importingClassMetadata
     * @return
     */
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        //1.定义扫描包的名称
        String[] basePackages = null;
        //2.判断有@Import注解的类上是否有@ComponentScan注解
        if (importingClassMetadata.hasAnnotation(ComponentScan.class.getName())) {
            //3.取出@ComponentScan注解的属性
            Map<String, Object> annotationAttributes = importingClassMetadata.getAnnotationAttributes(ComponentScan.class.getName());
            //4.取出属性名称为basePackages属性的值
            basePackages = (String[]) annotationAttributes.get("basePackages");
        }
        //5.判断是否有此属性（如果没有ComponentScan注解则属性值为null，如果有ComponentScan注解，则basePackages默认为空数组）
        if (basePackages == null || basePackages.length == 0) {
            String basePackage = null;
            try {
                //6.取出包含@Import注解类的包名
                basePackage = Class.forName(importingClassMetadata.getClassName()).getPackage().getName();
            } catch (ClassNotFoundException e) {
                e.printStackTrace();
            }
            //7.存入数组中
            basePackages = new String[] {basePackage};
        }
        //8.创建类路径扫描器
        ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false);
        //9.创建类型过滤器(此处使用切入点表达式类型过滤器)
        TypeFilter typeFilter = new AspectJTypeFilter(expression,this.getClass().getClassLoader());
        //10.给扫描器加入类型过滤器
        scanner.addIncludeFilter(typeFilter);
        //11.创建存放全限定类名的集合
        Set<String> classes = new HashSet<>();
        //12.填充集合数据
        for (String basePackage : basePackages) {
            scanner.findCandidateComponents(basePackage).forEach(beanDefinition -> classes.add(beanDefinition.getBeanClassName()));
        }
        //13.按照规则返回
        return classes.toArray(new String[classes.size()]);
    }
}




/**
 * @author 黑马程序员
 * @Company http://www.itheima.com
 */
@Configuration
@ComponentScan("com.itheima")
@Import(CustomeImportDefinitionRegistrar.class)
public class SpringConfiguration {
}

/**
 * 自定义bean导入注册器
 * @author 黑马程序员
 * @Company http://www.itheima.com
 */
public class CustomeImportDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

    private String expression;

    public CustomeImportDefinitionRegistrar(){
        try {
            Properties loadAllProperties = PropertiesLoaderUtils.loadAllProperties("customeimport.properties");
            expression = loadAllProperties.getProperty("custome.importselector.expression");
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }


    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        //1.定义扫描包的名称
        String[] basePackages = null;
        //2.判断有@Import注解的类上是否有@ComponentScan注解
        if (importingClassMetadata.hasAnnotation(ComponentScan.class.getName())) {
            //3.取出@ComponentScan注解的属性
            Map<String, Object> annotationAttributes = importingClassMetadata.getAnnotationAttributes(ComponentScan.class.getName());
            //4.取出属性名称为basePackages属性的值
            basePackages = (String[]) annotationAttributes.get("basePackages");
        }
        //5.判断是否有此属性（如果没有ComponentScan注解则属性值为null，如果有ComponentScan注解，则basePackages默认为空数组）
        if (basePackages == null || basePackages.length == 0) {
            String basePackage = null;
            try {
                //6.取出包含@Import注解类的包名
                basePackage = Class.forName(importingClassMetadata.getClassName()).getPackage().getName();
            } catch (ClassNotFoundException e) {
                e.printStackTrace();
            }
            //7.存入数组中
            basePackages = new String[] {basePackage};
        }
        //8.创建类路径扫描器
        ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(registry, false);
        //9.创建类型过滤器(此处使用切入点表达式类型过滤器)
        TypeFilter typeFilter = new AspectJTypeFilter(expression,this.getClass().getClassLoader());
        //10.给扫描器加入类型过滤器
        scanner.addIncludeFilter(typeFilter);
        //11.扫描指定包
        scanner.scan(basePackages);
    }
}
simple/
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring扫描器—spring组件扫描使用详解
04-05
NULL 博文链接：https://gaozzsoft.iteye.com/blog/1523898
Spring自动扫描组件
weixin_33898233的博客
02-05 211
通常情况下，声明所有的Bean类或组件的XML bean配置文件，这样Spring容器可以检测并注册Bean类或组件。 其实，Spring是能够自动扫描，检测和预定义的项目包并实例化bean，不再有繁琐的Bean类声明在XML文件中。 下面是一个简单的Spring项目，包括客户服务和DAO层。让我们来探讨手动申明组件和自动扫描组件之间的不同。 1、手动声明组件 看到在 Sprin...
Spring_组件扫描
cai_ing的博客
11-27 514
扫描组件 组件被上述注解标识后还需要通过Spring进行扫描才能够侦测到。 ①指定被扫描的package <context:component-scan base-package=“com.atguigu.component”/> ②详细说明 [1]base-package属性指定一个需要扫描的基类包，Spring容器将会扫描这个基类包及其子包中的所有类。 [2]当需要扫描多个包时可以使用逗号分隔。 [3]如果仅希望扫描特定的类而非基包下的所有类，可使用resource-pattern属性过滤特
Spring组件自动扫描
岁月静好
03-30 2786
问题描述 一个系统往往有成千上万的组件，如果需要手动将所有组件都纳入Spring容器中管理，是一个浩大的工程。 解决方案 Spring 提供组件扫描（component scanning）功能。它能从classpath里自动扫描、侦测和实例化具有特定注解的组件。基本的注解是@Component，它标识一个受Spring管理的组件。其他特定的注解有@Repository、@Service和@C
Spring核心技术（九）——Spring管理的组件和Classpath扫描
weixin_30787531的博客
07-10 113
Spring管理的组件和Classpath的扫描 在前文描述中使用到的Spring中的Bean的定义，都是通过指定的XML来配置的。而前文中描述的注解的解析则是在源代码级别来提供配置元数据的。在那些例子中，Bean的定义还是在XML中明确的定义的，注解的作用只不过是提供依赖注入。本文将描述Spring通过扫描classpath来自动注册组件。候选的组建就是指一些类能够匹配一些...
spring组件扫描contextcomponent-scan使用详解.pdf
最新发布
11-17
spring组件扫描contextcomponent-scan使用详解.pdf
Spring注解开发组件扫描器.zip
04-19
Spring注解开发组件扫描器.zip
浅谈Spring装配Bean之组件扫描和自动装配
08-29
本篇文章主要介绍了浅谈Spring装配Bean之组件扫描和自动装配，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Spring组件自动扫描详解及实例代码
10-20
主要介绍了Spring组件自动扫描详解及实例代码的相关资料,需要的朋友可以参考下
Spring的组件扫描
MFD920798892的博客
03-07 536
Spring的组件扫描通过组件扫描，可以不必在Spring的配置文件中配置各个`&lt;bean&gt;`，只需要配置好扫描哪些包（package），这些包下的类都将被Spring进行管理，等效于在Spring的配置文件中为这些包下的类都配置了`&lt;bean id=?? class=??&gt;`。开启组件扫描只需要在Spring的配置文件中添加： &lt;context:component-...
Spring的组件自动扫描机制
goodhappy8的专栏
08-22 123
来源：http://blog.163.com/qqabc20082006@126/blog/static/2292852520091128103316534/   Spring的组件自动扫描机制 2009-12-2810:33:16|分类：Spring|字号订阅 Spring将所有的bean都纳入到IOC中创建、管理和维护。对于大型的项目而言，项目中会有成百上千个bean，如果我们都在配...
Spring5参考指南:组件扫描
热门推荐
程序那些事
08-11 1万+
文章目录组件扫描@Component元注解和组合注解组件内部定义Bean元数据为自动检测组件命名为自动检测的组件提供作用域生成候选组件的索引 组件扫描 上一篇文章我们讲到了annotation-config配置，它主要用于bean内部的属性注入。而bean本身则需要通过配置的方式来定义。如果想使用配置的方式来定义bean，则可以使用component-scan，如下： <context:co...
Spring| Spring 组件扫描和自动装配5
YvesHe的专栏
06-13 1042
Spring是从两个角度来实现自动化装配： 组件扫描（component scanning） ： Spring会自动发现应用上下文中所创建的bean 自动装配（autowiring） ： Spring自动满足bean之间的依赖 1.组件扫描 1.1Java配置类方式-配置组件扫描 问题: 这个类Spring是如何发现该类的?--> 参考使用Java配置类创建Spring容器(上下文) @C...
Spring 自动扫描组件
Angelia Zheng
09-18 285
前面 Spring 文章都是使用 XML bean 配置文件实现 Spring 容器检测并注册Bean类或组件。其实，Spring是能够自动扫描，检测和预定义的项目包并实例化bean，不再有繁琐的Bean类声明在XML文件中。 现在，启用Spring组件扫描功能。使用@Component注释来表示这是类是一个自动扫描组件。 @Component public class ArticleSer...
Spring之组件扫描
weixin_45688449的博客
07-04 847
组件扫描(component scanning): Spring能够从指定的classpath下自动扫描，侦测和实例化具有特定注解的bean。 Spring提供了一下几个注解来标注需要被扫描到的bean： @Component:标注一个普 通的Spring Bean类 @Controller:标注一个控制器组件类 @Service:标注一个业务逻辑组件类 @Repository:标注一个DAO组件类 以前实例化一个bean要在配置文件中写bean标签，like this： <bean id="a"
Spring注解详解：@ComponentScan自动扫描组件使用
m0_67392182的博客
07-28 797
PersonConfig修改**
Spring组件扫描<context:component-scan/>使用详解
weixin_33892359的博客
01-15 62
&lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springfra
spring组件扫描
m18500961204的博客
09-13 192
spring可以自动去扫描base-pack下面或者子包下面的java文件，如果扫描到有@Component @Controller@Service等这些注解的类，则把这些类注册为bean。注意没有注解是不会被注入为bean 的 http://blog.csdn.net/zmx729618/article/details/51074530
Spring中组件扫描
03-14
Spring中的组件扫描是一种自动化配置的方式，它可以自动扫描指定包及其子包下的所有类，并将其注册为Spring容器中的Bean。这样，我们就可以通过注解的方式来声明Bean，而不需要手动在配置文件中进行配置。在Spring中...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值