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

首页>资讯 > 正文
2023-03-29 11:48:02

来源:腾讯云

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()方法解析标签,然后生成一个BeanDefinitionSpring会自动将其注册到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.schemasSpring.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包路径下定义三个类:TestService01TestService02TestService03,将后面两个类使用@MyComponent注解标注下;

3、编写SpringXml配置文件,这里就可以使用我们刚才自定义的标签:

 

4、测试用例:

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

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

标签:

THE END
免责声明:本文系转载,版权归原作者所有;旨在传递信息,不代表热讯制鞋网的观点和立场。

相关热点

新华社电 上海市文化和旅游局近日发布《上海市密室剧本杀内容备案管理规定(征求意见稿)》,并截至12月8日面向社会公众广泛征求意见。这
2021-11-19 13:46:03
《中国证券报》17日刊发文章《备战2022 基金经理调仓换股布新局》。文章称,距离2021年结束仅剩一个多月,基金业绩分化明显。部分排名靠前
2021-11-19 13:46:03
交通运输部办公厅 中国人民银行办公厅 中国银行保险监督管理委员会办公厅关于进一步做好货车ETC发行服务有关工作的通知各省、自治区、直
2021-11-19 13:45:58
新华社北京11月17日电 题:从10月份市场供需积极变化看中国经济韧性新华社记者魏玉坤、丁乐读懂中国经济,一个直观的视角就是市场供需两端
2021-11-19 13:45:58
全国教育财务工作会议披露的消息称,2020年,中国国家财政性教育经费投入达4 29万亿元,占GDP总量的4 206%,我国国家财政性教育经费支出占G
2021-11-19 13:45:48
如果你也热爱“种草”,前方高能预警!让你心心念念、“浏览”忘返的网络平台,可能早已成为一块块“韭菜地”。近日,据《半月谈》报道,有...
2021-11-19 13:45:48
日前,工业和信息化部印发《“十四五”信息通信行业发展规划》(以下简称《规划》),描绘了未来5年信息通信行业的发展趋势。《规划》指出...
2021-11-19 13:45:40
本报讯(中青报·中青网记者 周围围)2021年快递业务旺季正式拉开帷幕。国家邮政局监测数据显示,仅11月1日当日,全国共揽收快递包裹5 69
2021-11-19 13:45:40
人民网曼谷11月17日电 (记者赵益普)17日上午,中国援柬埔寨第七批200万剂科兴新冠疫苗抵达金边国际机场。当天,柬埔寨政府在机场举行了
2021-11-19 13:45:35
金坛压缩空气储能国家试验示范项目主体工程一角受访者供图依托清华大学非补燃压缩空气储能技术,金坛压缩空气储能项目申请专利百余项,建立
2021-11-19 13:45:35
视觉中国供图42亿立方米据有关部门预计,今年山西煤炭产量有望突破12亿吨,12月份山西外送电能力将超过900万千瓦,今冬明春煤层气产量将达4
2021-11-19 13:44:34
14省份相继发布2021年企业工资指导线——引导企业合理提高职工工资今年以来,天津、新疆、内蒙古、陕西、西藏、山东、江西、山西、福建、四
2021-11-19 13:44:34
中新网客户端北京11月18日电 (记者 谢艺观)“一条路海角天涯,两颗心相依相伴,风吹不走誓言,雨打不湿浪漫,意济苍生苦与痛,情牵天下喜
2021-11-19 13:44:31
近日,交通运输部等三部门发布《关于进一步做好货车ETC发行服务有关工作的通知》。通知提到,对不具备授信条件的用户,商业银行可在依法合
2021-11-19 13:44:31
欧莱雅面膜陷优惠“年度最大”风波 涉及该事件集体投诉超6000人次美妆大牌双十一促销翻车?近日,因预售价格比双十一现货贵出66%,欧莱雅
2021-11-19 13:44:13
43 6%受访者会在工作两三年后考虑跳槽54 3%受访者认为跳槽对个人职业发展有利有弊如今对不少年轻人来说,想对一份工作“从一而终”不太容易
2021-11-19 13:44:13
超八成受访青年表示如有机会愿意开展副业 规划能力最重要64 4%受访青年指出做副业跟风心态最要不得如今,“身兼数职”已成为年轻人当中的
2021-11-19 13:44:01
发展氢能正当其时【科学随笔】氢能是一种二次能源,它通过一定的方法利用其他能源制取,具有清洁无污染、可储存、与多种能源便捷转换等优点
2021-11-19 13:44:01
“千杯不醉”的解酒“神药”能信吗?专家:网红“解酒药” 其实不算药俗话说,“酒逢知己千杯少”,酒一直是国人饭桌上至关重要的存在。尽...
2021-11-19 13:43:57
最新文章

相关推荐