【Spring源码】- 07 扩展点之自定义标签

Spring中正逐渐采用注解方式取代XML配置方式，所以，使用XML配置的机会正越来越少。然后，如果你开发的工具模块可能会被很多系统使用，考虑到兼容性问题，就需要提供XML方式集成，这时就需要自定义标签；还有，你在看一些开源源码时，一般也是提供自定义标签方式集成。所以，还是可以去了解一下自定义标签实现。

(资料图片)

在Spring中使用自定义标签还是比较简单，下面我们就实现一个自定义标签，其功能类似标签：将指定包路径下带有指定注解的Bean扫描注册。

1、首先，在resources/META-INF目录下定义一个xsd文件，描述自定义标签属性：

2、自定义NamespaceHandler，注册使用CustomScannerBeanDefinitionParser解析器进行处理：

public class ScannerNameSpaceHandler extends NamespaceHandlerSupport { @Override public void init() {  registerBeanDefinitionParser("scan", new CustomScannerBeanDefinitionParser()); }}

3、自定义CustomScannerBeanDefinitionParser解析器：

public class CustomScannerBeanDefinitionParser extends AbstractBeanDefinitionParser { @Override protected AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) {  BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(CustomScannerConfigurer.class);  ClassLoader classLoader = ClassUtils.getDefaultClassLoader();  try {   String annotationClassName = element.getAttribute("annotation");   if (StringUtils.hasText(annotationClassName)) {    Class annotationClass = (Class) classLoader      .loadClass(annotationClassName);    builder.addPropertyValue("annotationClass", annotationClass);   }  } catch (Exception ex) {   XmlReaderContext readerContext = parserContext.getReaderContext();   readerContext.error(ex.getMessage(), readerContext.extractSource(element), ex.getCause());  }  builder.addPropertyValue("basePackage", element.getAttribute("base-package"));  return builder.getBeanDefinition(); }}

parseInternal()方法解析标签，然后生成一个BeanDefinition，Spring会自动将其注册到IoC容器中。如果标签只会注册单个Bean，这里是需要返回注册Bean对应的BeanDefinition即可；如果是多个情况，这里一般是注册一个配置类，将标签配置的属性注入到配置类中，然后由配置类统一处理。

4、自定义CustomScannerConfigurer配置类：

public class CustomScannerConfigurer  implements BeanDefinitionRegistryPostProcessor, InitializingBean { private String basePackage; private Class annotationClass; @Override public void afterPropertiesSet() throws Exception {  //参数校验  notNull(this.basePackage, "Property "basePackage" is required"); } @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) { } @Override public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {  ClassPathBeanDefinitionScanner scanner =    new ClassPathBeanDefinitionScanner(registry, false);  scanner.addIncludeFilter(new AnnotationTypeFilter(annotationClass));  scanner.setIncludeAnnotationConfig(false);  int beanCount = scanner.scan(basePackage);  registry.getBeanDefinitionNames(); } public String getBasePackage() {  return basePackage; } public void setBasePackage(String basePackage) {  this.basePackage = basePackage; } public Class getAnnotationClass() {  return annotationClass; } public void setAnnotationClass(Class annotationClass) {  this.annotationClass = annotationClass; }}

CustomScannerConfigurer实现了BeanDefinitionRegistryPostProcessor, InitializingBean两个接口，之前分析过这两个接口。重点在BeanDefinitionRegistryPostProcessor这个接口，其是一个BeanFactoryPostProcessor类型扩展，可以向IoC容器注册BeanDefinition。在postProcessBeanDefinitionRegistry()方法中创建一个ClassPathBeanDefinitionScanner对象，并将标签中配置设置进去，即可实现扫描指定包路径下带有指定注解的Bean。

5、xsd是标签描述文件，NamespaceHandler则是标签后台处理逻辑入口，现在需要将两者进行关联，在resources/META-INF目录下创建两个文件：Spring.schemas和Spring.handlers，分别指定xsd文件位置和NamespaceHandler位置，这样就实现了标签和后台逻辑关联，其内容见下：

Spring.schemashttp\://www.simon.org/schema/scan.xsd=META-INF/custom-scan.xsd

Spring.handlershttp\://www.simon.org/schema/scan=customschema.demo03.ScannerNameSpaceHandler

自定义标签描述以及对于的后台处理逻辑都配置完成，下面我们就开始进行测试。

1、首先，定义个注解，用于在扫描Bean时过滤使用：

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Indexedpublic @interface MyComponent { String value() default "";}

2、在customschema.demo03.bean包路径下定义三个类：TestService01、TestService02、TestService03，将后面两个类使用@MyComponent注解标注下；

3、编写Spring的Xml配置文件，这里就可以使用我们刚才自定义的标签：

4、测试用例：

@Testpublic void test01() { ApplicationContext context = new ClassPathXmlApplicationContext("custom-schema.xml"); Arrays.stream(context.getBeanDefinitionNames()).forEach(System.out::println);}

从输出结果就可以看到，TestService01由于没有带有@MyComponent注解，所以没有注册，TestService02和TestService03都会被注册到容器中。

关键词：