全球今头条!【Spring源码】- 07 扩展点之自定义标签

2023-03-29 10:31:27     来源:腾讯云     编辑:bj001    

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都会被注册到容器中。

关键词:

相关新闻
相关新闻
v 推荐福彩3D第2023178期晒票 激发我们更加勇敢地追求幸福生活 2023-07-07
v 珠江水运关键指标快速增长 2023-07-07
v 真相 | “经济胁迫”是美国手中杀人的“刀” 2023-07-07
v 微单相机推荐2013_微单相机推荐2013 2023-07-07
v 多样化种植技术模式助甘肃河西区域保障粮食安全_微头条 2023-07-07
v 教育部部署做好2023年中小学暑期安全工作 世界球精选 2023-07-07
v 泽连斯基将访问土耳其会见埃尔多安,克宫:密切关注会谈结果 2023-07-07
v 1至6月四川公路水路交通建设完成投资1445亿元,同比增长27% 2023-07-07
v 蚂蚁基金被罚7368万元,总经理林思思被罚15万元 2023-07-07
v 主城都市区仍是主阵地!重庆市新增1366家“专精特新”企业  2023-07-07
v 好消息!西南地区首个百兆瓦级电网侧独立储能电站正式并网运行 2023-07-07
v 首批确定20所!重庆市全面启动市级清廉学校试点示范建设工作 2023-07-07
v 江苏:无锡开出“百万价码”引育宣传文化人才 2023-07-07
v 点赞!湘江新区高校毕业生就业工作在全国作典型交流 2023-07-07
v 两市主力资金净流出230亿元 非银金融等行业实现净流入 2023-07-07
v 同比增长8% 长安1-6月销量超120万辆 2023-07-07
v 【风口解读】红蜻蜓上半年净利预增超66%,去年同期基数低下滑超19% 2023-07-07
v 因违规参与银行保险机构业务活动等 蚂蚁集团被罚没超37亿元 2023-07-07
v 金融管理部门对蚂蚁集团罚没71.23亿元,要求关停“相互宝”业务 2023-07-07
v 中国中免上半年实现营收358.58亿元 净利润38.64亿元 2023-07-07
v 头条焦点:用心守护群众生命安全——重庆市万州区群众避险转移一线见闻 2023-07-07
v 上汽集团:第二季度整车销量环比增长32.5% 2023-07-07
v 横店东磁预计上半年实现归母净利11.8亿元至12.6亿元 光伏产业盈利同比实现翻番以上增长 2023-07-07
v 证监会同意碳酸锂期货及期权注册 2023-07-07
v 国家卫健委:提升职业健康检查和职业病诊断结论的准确性 2023-07-07
v 昨天天津局地有小冰雹!高温持续至……要凉快了! 2023-07-07
v “心友会”吐“心”生 2023-07-07
v 华为张平安:盘古大模型不写诗 只做事 2023-07-07
v 宁夏第一个公布2023年养老金调整细则,具体有哪些变化呢? 2023-07-07
v 第19届亚运会杭州西湖赛区场馆有哪些 2023-07-07
分享到:
更多

网站运营:财经头条

财经头条 版权所有©1997-2016 未经书面授权禁止复制或建立镜像
京ICP备12018864号-11
联系我们:291 32 36@qq.com

营业执照公示信息