diScan()如下:
protected Set<BeanDefinitionHolder> doScan(String... basePackages) { Assert.notEmpty(basePackages, "At least one base package must be specified"); Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>(); for (String basePackage : basePackages) { // 这里面findCandidateComponents是核心。这边就不再详解了,因为上面贴出的那篇博文已经有详解了 // 总之就是找到候选的Bean定义们 //findCandidateComponents这个方法需要注意,Spring5以后走的可能会从索引上走 addCandidateComponentsFromIndex() // 如果不是Spring5 会走原来的逻辑scanCandidateComponents() Set<BeanDefinition> candidates = findCandidateComponents(basePackage); for (BeanDefinition candidate : candidates) { ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); candidate.setScope(scopeMetadata.getScopeName()); String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); // 给刚扫描出来的Bean定义设置一些默认值 if (candidate instanceof AbstractBeanDefinition) { postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName); } //解析@Primary、@Lazy...等等基础注解 if (candidate instanceof AnnotatedBeanDefinition) { AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate); } // 检查一些Bean定义,若之前已经存在了,看看采用什么策略吧(覆盖or不管?) // 原则:在同意文件内,覆盖吧 在不同文件内 不管吧~~~~ if (checkCandidate(beanName, candidate)) { BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName); definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); beanDefinitions.add(definitionHolder); // 内部就已经把该Bean定义注册进去了,所以外部可以不用再重复注册了 registerBeanDefinition(definitionHolder, this.registry); } } } return beanDefinitions; } public Set<BeanDefinition> findCandidateComponents(String basePackage) { // 如果是Spring5 会走这里(当然需要你手动开启~~~) if (this.componentsIndex != null && indexSupportsIncludeFilters()) { return addCandidateComponentsFromIndex(this.componentsIndex, basePackage); } else { // 老方式,简单的说,就是从从磁盘里找。利用了`ResourceLoader`的子接口ResourcePatternResolver return scanCandidateComponents(basePackage); } } // 私有方法,根据基础包名,去扫描所有的符合条件的类~~~ private Set<BeanDefinition> scanCandidateComponents(String basePackage) { ... // 这个构建出来的 是基础包路径,形如:classpath*:com/fsx/demo1/**/*.class // 从这里可以看出:首先它会去扫描Jar包(因为他是classpath*),所以如果我们路径是这样的: // "classpath*:org/springframework/**/*.class":它会把所有的Spring里面的类都拿出来~~~~ 所以这个是需要注意的 // 小技巧:classpath*:**/*.class相当于拿到你所有的所有的类。可以借助这个看看你工程里面一共多少个类。Spring项目大约1万个往上走~~~~ String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + resolveBasePackage(basePackage) + '/' + this.resourcePattern; // 调用ResourcePatternResolver来处理 // 注意:此处使用的实例默认为:PathMatchingResourcePatternResolver 当然你可以自己set来指定 但是一般都没有必要~~~~ Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath); ... // 然后一个个遍历,看看哪个是@Component组件,然后就注册进去 }
至此,整个@ComponentScan扫描完成,并且符合条件的组件也都注册进去了
从上源码分析我们发现:若我们想要扫描到Jar包里面的@Component进容器,(@Import当然是阔仪),也可以这么来做,也是能够实现我们的扫描需求的(如果jar包内非常多,可以考虑这种方式~~~)只是一般都不建议这么来使用
另外,若你想使用Spring5提供的新特性去加速项目的启动,你是需要额外导入这个Jar的(SpringBoot中不用指定版本号):
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-indexer</artifactId> <scope>provided</scope> </dependency>
所以下面例子是可行的:Jar包内(注意是jar包内 )有一个类:
@Component public class DemoComponent { }
显然我们另外一个服务项目导入这个jar:
<dependency> <groupId>com.fsx.clients</groupId> <artifactId>solog-service-api</artifactId> <version>demo-SNAPSHOT</version> </dependency>
然后我们这个项目想把这个Jar里面的DemoComponent怎么办呢???可以按照如下做法(此处不介绍@Import的方式~):
//@ComponentScan(basePackageClasses = DemoComponent.class) //若类不多,使用这种方式也是可行的 @ComponentScan(basePackages = "com.fsx.solog.demo") // 若包内类很多,推荐使用此种方式 @Configuration public class Scan { }
这样测试一下,我们发现这个bean是被扫描进容器了的。
System.out.println(applicationContext.getBean(DemoComponent.class)); //com.fsx.solog.demo.DemoComponent@238b521e
Tips
既然知道了@ComponentScan如此的强大,所以使用的时候也务必务必要注意,不要无缘无故多扫描进Bean来的情况。
典型案例:比如我们现在大都使用SpringBoot构建微服务,依赖内置的@SpringBootApplication进行默认的包扫描:默认扫描Application主类所在的包以及所有的子包。
所以使用的时候,请务必务必确保如果你的jar需要提供给别人引入,不要被别人默认给扫描进去了,那就别人项目造成了非常强的依赖性。
一般情况下,我们自定的所有文件夹都放在一个以服务名命名的子包内,而主类Application在外层~
形如:jar包里类所在包为:com.fsx.solog(然后你所有的类都是solog下面或者子包内)
别人的项目包为:com.fsx.room,然后它所有的类都在这下面或者其子包内
这样就完成了隔离,最大可能的避免了侵入性。各位使用起来的时候请务必注意可能被重复扫描的可能,特别特别是你的jar可能会被提供给别人使用的情况~~~~
最后,若真的出现了此种情况,原理源码已经分析了,请务必知道怎么去排查和解决问题~这才是最重要的
总结
Scan扫描的思想,是一种批量处理的思想。它在设计模式中是具有非常好的通用性的。
本文以Spring内部的处理做源码分析为例,我们可以在自己设计框架的时候,也借鉴此些思想,达到更灵活配置,更通用,更能扩展的效果。