Spring 注解面面通之 @Indexed

本文主要是介绍Spring 注解面面通之 @Indexed，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Spring包org.springframework.stereotype下，除了@Component、@Controller、@Service、@Repository外，在5.0版本中新增了@Indexed注解。

应用中使用<context:component-scan />或@ComponentScan扫描的package包含的类越来越多的时候，Spring启动时模式注解解析时间就会变得越长。

@Indexed注解的引入正是为了解决这个问题，项目编译打包时，会在自动生成META-INF/spring.components文件，文件包含被@Indexed注释的类的模式解析结果。当Spring应用上下文进行组件扫描时，META-INF/spring.components会被org.springframework.context.index.CandidateComponentsIndexLoader读取并加载，转换为CandidateComponentsIndex对象，此时组件扫描会读取CandidateComponentsIndex，而不进行实际扫描，从而提高组件扫描效率，减少应用启动时间。

org.springframework.stereotype包下的注解@Component、@Controller、@Service、@Repository，除@Component外，@Controller、@Service、@Repository注解也同时标记有@Component注解，所以默认情况下，索引机制针对这四个注解。当然可以自定义注解，有两种途径：

① 使用@Indexed作为元注解声明注解。

② 使用@Component、@Controller、@Service、@Repository中任一个作为元注解声明注解。

注解示例

以《Spring 注解面面通之 @Component、@Controller、@Service、@Repository》中示例基础，进行改造，没有阅读的可以先简单阅读一下，很简单的结构。

1) 若要开启@Indexed索引功能，首先需要引入spring-context-indexer。

<dependency><groupId>org.springframework</groupId><artifactId>spring-context-indexer</artifactId><version>${spring.version}</version><optional>true</optional>
</dependency>

2) 若配置无误，此时编译打包或直接启动项目，会生成META-INF/spring.components文件，并且会跳过类路径扫描阶段。

#
#Mon Nov 23 15:11:25 CST 2020
com.arhorchin.securitit.business.controller.HelloController=org.springframework.stereotype.Component
com.arhorchin.securitit.stereotype.component.SecComponent=org.springframework.stereotype.Component
com.arhorchin.securitit.stereotype.controller.SecController=org.springframework.stereotype.Component
com.arhorchin.securitit.stereotype.service.impl.SecServiceImpl=org.springframework.stereotype.Component
com.arhorchin.securitit.stereotype.repository.impl.SecRepositoryImpl=org.springframework.stereotype.Component

3) 验证Spring启动时，是否使用索引而未进行类路径扫描。

① ClassPathScanningCandidateComponentProvider的findCandidateComponents决定是使用META-INF/spring.components索引，还是进行类路径扫描。

在这里插入图片描述

② CandidateComponentsIndexLoader的doLoadIndex加载了META-INF/spring.components文件，并CandidateComponentsIndex实例，用于进行索引查找。

在这里插入图片描述

4) CandidateComponentsIndexLoader.doLoadIndex(...)实现中出现了一个shouldIgnoreIndex变量，其值是Spring系统属性spring.index.ignore的值。通过这个Spring系统属性，可以关闭索引功能。

① 通过spring.properties设置spring.index.ignore禁用索引功能。

在这里插入图片描述

# 禁用索引功能.
spring.index.ignore=true

此时编译打包或直接启动项目，仍会生成META-INF/spring.components文件，但进行组件加载时，不会使用其作为缓存，而是进行类路径扫描加载组件。

② 除了使用spring.properties进行设置外，还可以通过编码方式设置spring.index.ignore来禁用索引功能。

参照《Spring 通篇源码之扩展点之 ApplicationContextInitializer原理与应用》，在web.xml中设置：

<context-param><param-name>contextInitializerClasses</param-name><param-value>com.arhorchin.securitit.extend.initializer.CustomerApplicationContextInitializer</param-value>
</context-param>

package com.arhorchin.securitit.extend.initializer;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.SpringProperties;/*** @author Securitit.* @note 自定义ApplicationContextInitializer.*/
public class CustomerApplicationContextInitializer implements ApplicationContextInitializer {/*** logger.*/private Logger logger = LoggerFactory.getLogger(CustomerApplicationContextInitializer.class);@Overridepublic void initialize(ConfigurableApplicationContext applicationContext) {logger.info("WebApplicationContext-id：" + applicationContext.getId());SpringProperties.setProperty("spring.index.ignore", "true");}}

此时，也可以达到和①中一样的效果。

5) 注意事项

① 使用<context:component-scan />或@ComponentScan声明时需注意要使用多层路径匹配。例如：

<context:component-scan base-package="com.arhorchin.securitit.stereotype.*"></context:component-scan>

和

<context:component-scan base-package="com.arhorchin.securitit.stereotype.**"></context:component-scan>

对于普通的Spring应用启动都是没有问题的，因为自动扫描匹配比较宽泛，但是索引匹配时确有点严格，如果使用第一种格式，会出现找不到Bean的情况。匹配见CandidateComponentsIndex.getCandidateTypes(...)。

② 使用@Indexed需注意，如果模块只有部分组件存在META-INF/spring.components文件中，那么其他部分不会进行扫描。为避免这种情况，使用@Indexed时，尽量进行全量使用，或者使用spring.index.ignore进行全量禁用，避免出现不可预料的问题。

③ @Indexed并非显示的注释才会起作用，任何注释了@Component、@Controller、@Service、@Repository这四个注解中的任意一个，都能达到效果。

④ 当多个jar包中存在META-INF/spring.components时，Spring程序可以全部加载，但是会存在覆盖的情况。

建两个jar包indexed-tester-1.0.0.1.jar和indexed-tester-1.0.0.2.jar，里面仅包含META-INF/spring.components。

在这里插入图片描述