SpringBoot 如何实现自定义扫描和注册类？

在《你真正了解 Spring @Import 注解吗？》文章中，我们学习了 Spring @Import 注解和使用。在本文中，我们将结合一个实际开发的案例，学习在实际开发中如何使用 @Import 注解导入 ImportBeanDefinitionRegistrar 接口的实现类。

案例背景说明

在项目中，通常会调用第三方服务商提供的服务，例如：短信、支付等。调用第三方服务通常也是采用 HTTP 的方式，这时就会有两种调用情况：

本次案例模拟第二种方式调用三方的服务。

第三方接口文档

第三方接口文档，通常会定义各个接口请求和响应的字段的数据类型、长度、描述、枚举值等，对于存在文件上传下载、加解密、加签验签等场景时，会提供调用说明。

本部分仅仅提供案例测试使用的请求接口文档，如下所示：

序号

字段名称

字段代码

数据类型

是否必须

备注

1

用户编号

userId

String(32)

Y


2

用户名称

userName

String(100)

Y


序号

字段名称

字段代码

数据类型

是否必须

备注

1

订单编号

orderId

String(32)

Y


2

订单类型

orderType

String(20)

Y

DOMESTIC - 国内

INTERNATIONAL - 国际

项目结构

本次示例类较多，如上图所示，下面我们分别解释各个类的作用。

UserQueryParamVO、OrderQueryParamVO 分别对应第三方接口文档的用户和订单信息，给第三方发送 HTTP 请求，就使用这两个 Bean。字段同上面表格，在此就不展示代码了。

ThirdPartyQueryService 定义了第三方要求的接口，本示例为查询用户信息和订单信息，如下所示：

@ThirdPartyService(handler = CommonThirdPartyServiceHandler.class)
public interface ThirdPartyQueryService {

    /**
     * 查询用户信息
     */
    void findUser(UserQueryParamVO paramVO);

    /**
     * 查询订单信息
     */
    void findOrder(OrderQueryParamVO paramVO);
}

接口的标注的 @ThirdPartyService 注解稍后解释

用于测试上面第三方接口调用，如下所示：

@RestController
public class InvokeThirdPartyController {

    @Autowired
    private ThirdPartyQueryService thirdPartyQueryService;

    @GetMapping("/invoke/third/party/{type}")
    public void invoke(@PathVariable String type) {
        switch (type) {
            case "user":
                UserQueryParamVO userParam = new UserQueryParamVO().setUserId("1001").setUserName("张三");
                thirdPartyQueryService.findUser(userParam);
                break;
            case "order":
                OrderQueryParamVO orderParam = new OrderQueryParamVO().setOrderId("TD_10010_0001")
                        .setOrderType(OrderQueryParamVO.OrderType.DOMESTIC);
                thirdPartyQueryService.findOrder(orderParam);
                break;
            default:
                throw new IllegalArgumentException("不支持类型：" + type);
        }
    }
}

在该 Controller 中主动注入 ThirdPartyQueryService 的实现类，因为代码我们就定义了接口，具体实现类如何生成，又如何注入到 IOC 容器中，在下面解释。

com.jub.proxy 包：重点、重点、重点

首先我们先介绍两个注解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ThirdPartyService {

    /**
     * 第三方服务处理器
     */
    Class<? extends ThirdPartyServiceHandler> handler();
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(ThirdPartyServiceRegistrar.class)
public @interface ThirdPartyServiceScan {

    /**
     * 用于配置扫描第三方服务的包路径，如果不配置默认扫描标注的类所在的包和子包
     */
    String[] value() default {};
}

下面是三个关键类和一个标识接口，具体如下：

public interface ThirdPartyServiceHandler extends InvocationHandler {
    // 该接口仅用于标识第三方服务处理器
}
@Slf4j
public class CommonThirdPartyServiceHandler implements ThirdPartyServiceHandler {

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        // 在此可以编写给第三方发送 HTTP 请求的业务逻辑
        log.info("===> 发送请求到第三方了：{}", proxy.getClass().getName());
        return null;
    }
}

具体哪个第三方接口采用哪个处理器，通过 ThirdPartyService 注解 handler 属性指定

@Slf4j
public class ThirdPartyServiceRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {

    private ResourcePatternResolver resourcePatternResolver;

    private CachingMetadataReaderFactory metadataReaderFactory;

    private static final String PACKAGE_SEPARATOR = ".";

    private static final String PATH_SEPARATOR = "/";

    private static final String DEFAULT_RESOURCE_PATTERN = "**/*.class";

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        this.resourcePatternResolver = ResourcePatternUtils.getResourcePatternResolver(resourceLoader);
        this.metadataReaderFactory = new CachingMetadataReaderFactory(resourceLoader);
    }

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 1、获取 ThirdPartyServiceScan 注解属性 Map
        AnnotationAttributes attributes =
                AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(ThirdPartyServiceScan.class.getName()));
        if (attributes == null) {
            return;
        }

        log.info("================= 扫描标注 ThirdPartyService 注解的接口开始 =================");
        // 2、扫描并获取标注 ThirdPartyService 注解接口元信息
        Set thirdPartyServices = scanThirdPartyService(attributes, importingClassMetadata);
        for (MetadataReader thirdPartyService : thirdPartyServices) {
            // 3、将每个接口动态代理生成代理类，并将代理类注册到 IOC 容器中
            registerThirdPartyService(thirdPartyService, registry);
        }
        log.info("================= 扫描标注 ThirdPartyService 注解的接口结束 =================");
    }

    /**
     * 将扫描到的接口通过 FactoryBean 生成其实现类，并将实现类注入到 IOC 容器中
     *
     * @param thirdPartyService 接口元数据
     * @param registry          BeanDefinitionRegistry
     */
    private void registerThirdPartyService(MetadataReader thirdPartyService, BeanDefinitionRegistry registry) {
        String beanName = thirdPartyService.getClassMetadata().getClassName();
        // 3.1 通过 BeanDefinitionBuilder 构建一个 BeanDefinition，genericBeanDefinition 需要的入参为 Bean 的名称，
        // 此处使用接口名称
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(beanName);
        // 3.2 此处可以为构建 Bean 实例传递必要的参数，此处通过构造器传参，使用 addConstructorArgValue 方法，如果通过 Setter 
        // 方法传参，则使用 addPropertyValue 方法。
        builder.addConstructorArgValue(thirdPartyService);
        AbstractBeanDefinition beanDefinition = builder.getBeanDefinition();
        // 3.3 此处需要注意，如果添加的是普通的类，那么就直接创建该类的实例，但是如果传入的是 FactoryBean 接口的实例，那么就会
        // 调用 getObject 方法获取需要注入的实例对象。
        beanDefinition.setBeanClass(ThirdPartyServiceFactoryBean.class);
        // 3.4 将 BeanDefinition 添加到注册器中，Spring 会更加 BeanDefinition 构建 Bean 的实例，并添加到 IOC 容器中
        registry.registerBeanDefinition(beanName, beanDefinition);
    }

    /**
     * 扫描 {@link ThirdPartyService} 注解标注的接口
     *
     * @param attributes             {@link ThirdPartyServiceScan#value()}
     * @param importingClassMetadata {@link ThirdPartyServiceScan} 注解标注类的元信息
     * @return 接口类别
     */
    private Set scanThirdPartyService(AnnotationAttributes attributes,
                                                      AnnotationMetadata importingClassMetadata) {
        // 2.1 获取扫描的包路径，优先获取 ThirdPartyServiceScan 注解 value 的值，如果数组为空，则获取标注该注解的类的包路径
        final List scanPackages =
                getScanPackages(attributes, ClassUtils.getPackageName(importingClassMetadata.getClassName()));
        log.info("待扫描的包路径为：{}", scanPackages);
        final Set result = new LinkedHashSet<>();
        for (String scanPackage : scanPackages) {
            // 2.2 对每个包路径即子包路径下的类进行扫描，获取标注了 ThirdPartyService 数据的接口元信息
            result.addAll(scanThirdPartyService(scanPackage));
        }
        return result;
    }

    @SneakyThrows
    private Set scanThirdPartyService(String scanPackage) {
        final Set result = new LinkedHashSet<>();
        // 2.2.1 将包路径转换为：classpath*:com/jub/xxx/**/*.class，如果只需要配当前包下的类，那么吧 ** 去掉即可
        String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
                convertPackageToResourcePath(scanPackage) + '/' + DEFAULT_RESOURCE_PATTERN;
        // 2.2.2 获取包路径对应的资源信息，也就是对应的类文件信息
        Resource[] resources = resourcePatternResolver.getResources(packageSearchPath);
        for (Resource resource : resources) {
            // 2.2.3 将类文件流转换为类的元数据，方便获取类信息，如类的元数据、标注注解的元数据
            MetadataReader reader = metadataReaderFactory.getMetadataReader(resource);
            AnnotationMetadata annotationMetadata = reader.getAnnotationMetadata();
            ClassMetadata classMetadata = reader.getClassMetadata();
            // 2.2.4 判断当前类为接口，并且标注了注解 ThirdPartyService，添加到结果集中
            if (classMetadata.isInterface() && annotationMetadata.isAnnotated(ThirdPartyService.class.getName())) {
                log.info("扫描到接口：{}", classMetadata.getClassName());
                result.add(reader);
            }
        }
        return result;
    }

    /**
     * 获取扫描的包路径
     *
     * @param attributes     {@link ThirdPartyServiceScan#value()}
     * @param defaultPackage 默认扫描的包路径，即 {@link ThirdPartyServiceScan} 注解标注类的所在包
     * @return 待扫描包路径集合
     */
    private List getScanPackages(AnnotationAttributes attributes, String defaultPackage) {
        List scanPackages = Arrays.stream(attributes.getStringArray("value"))
                .filter(StrUtil::isNotBlank).distinct().collect(Collectors.toList());
        if (CollUtil.isEmpty(scanPackages)) {
            scanPackages.add(defaultPackage);
        }
        return scanPackages;
    }

    private static String convertPackageToResourcePath(String packageName) {
        return packageName.replace(PACKAGE_SEPARATOR, PATH_SEPARATOR);
    }
}
public class ThirdPartyServiceFactoryBean implements FactoryBean {

    private final MetadataReader thirdPartyService;

    public ThirdPartyServiceFactoryBean(MetadataReader thirdPartyService) {
        this.thirdPartyService = thirdPartyService;
    }

    @Override
    public Object getObject() throws Exception {
        AnnotationAttributes attributes = AnnotationAttributes.fromMap(thirdPartyService.getAnnotationMetadata()
                .getAnnotationAttributes(ThirdPartyService.class.getName()));
        if (attributes == null) {
            throw new IllegalArgumentException("未找到 ThirdPartyService 注解");
        }
        Class handler = (Class) attributes.getClass("handler");
        Class<?> interfaceClass = Class.forName(thirdPartyService.getClassMetadata().getClassName());
        return Proxy.newProxyInstance(ThirdPartyServiceFactoryBean.class.getClassLoader(), new Class[]{interfaceClass},
                handler.getDeclaredConstructor().newInstance());
    }

    @SneakyThrows
    @Override
    public Class<?> getObjectType() {
        return Class.forName(thirdPartyService.getClassMetadata().getClassName());
    }
}
总结
调用第三方的接口业务逻辑基本一致，都是获取到参数发送 HTTP 请求，通过上面的方式可以减少很多相同的代码，方便维护。
处理上面的使用场景，在 MyBatis 中也是使用这种方式生成 Mapper 实现类，并注入到 IOC 容器的，有兴趣的小伙伴可以研究一下。








展开阅读全文



页面更新：2024-04-22



标签：注解   字段   容器   路径   处理器   接口   订单   文档   方法   信息





1
2
3
4
5







	

		

		
		

		

			

			
到底什么是智慧农业认养小程序？能够给农场带来哪些帮助和好处？

			

			

			 最近几年非常流行的线上的认养方式和认养的平台一定要属智慧农场认养小程序了，那么为什么智慧农业小程序这几年如此火爆得到了非常高的关注和认可度？智慧农业认养小程序到底又是怎样的一种新型模式？智慧农业认养小程序
			

		

	

	

		

		
		

		

			

			
电影推荐：《监视资本主义：智能陷阱》你的个人信息，别人的利益

			

			

			 The Social Dilemma（监视资本主义：智能陷阱）豆瓣评分8.7，是一部由美国导演杰夫·奥洛夫执导的纪录片电影，于2020年9月9日在Netflix上首播。该电影以纪录片的形式呈现，共分为九个章节。每个章节都涉及了不同的主题，包括算法
			

		

	

	

		

		
		

		

			

			
3月安卓手机好评榜出炉：realme千元机夺冠 小米第二

			

			

			4月6日晚，安兔兔公布3月安卓手机好评榜，数据来源安兔兔评测，收集时间2023年3月1日至3月31日，仅限国内市场。根据榜单，realme真我10 Pro+以好评率95.65%夺冠，小米12S Ultra（好评率95.06%）第二、OPPO Find X6 Pro（好评率95%）第三
			

		

	

	

		

		
		

		

			

			
云战场上大显身手，天翼混合云战斗值拉满

			

			

			来源：【通信信息报社】（记者 林碧涓）近日，天翼云携手中国信通院云计算与大数据研究所共同成立了混合云联合实验室，将共建行业领先的混合云综合研究平台，共促产业进步。事实上，早在2015年，中国电信天翼混合云就正式投入商用。
			

		

	

	

		

		
		

		

			

			
“饿了么”撞上“美团”，当抢时间遇上了抢单 - 一线微观

			

			

			如果在用餐高峰时段你一定会看到身穿鲜亮服装的外卖小哥穿梭在街头巷尾及时的送餐服务受到了大家的好评但是！有些外卖小哥为了赶时间练就了边骑车边打电话边看订单甚至闯红灯、随意变道、逆行等违反交通规则的“本领”
			

		

	

	

		

		
		

		

			

			
报告：ChatGPT带动AIGC领域相关岗位同比增长15%

			

			

			4月6日，拉勾招聘发布的《中国数字科技人才流动报告(2023第一季度)》显示，在传统产业和中小企业加快数字化转型的大背景下，企业服务/数据服务行业也在积极扩招人才，今年一季度发布职位量同比增长5%；人工智能等行业成为数字
			

		

	

	

		

		
		

		

			

			
物理天才高华健，放弃国籍加入美国，30年后带回20位博士坑惨美国

			

			

			阅读文章前辛苦您点个“关注”，方便讨论和分享。我们每天为您更新精彩的内容！文|木易编辑|布咔历史«——【前言】——»高华健，一名曾经拥有中国和美国双重国籍的华人科学家，宣布放弃中国国籍，加入美国国籍，引起了不少争议
			

		

	

	

		

		
		

		

			

			
未来科技：走向变革的前沿

			

			

			在迎接2030年的时候，我们不仅迎来了一场技术革命，更是人类历史上最具标志性的变化之一。未来的科技带来的变革范围存在于各个方面，从医疗、能源、教育到交通等等。下面，我们将对一些最具突破性的技术进行介绍。 1. 量子计
			

		

	

	

		

		
		

		

			

			
ChatGPT到底是搜索助手还是人工智能看它这几个问题回答给你答案

			

			

			 首先，我们需要知道ChatGPT是OpenAI推出的一个大型语言模型。它被设计用于理解和回答人类语言的各种问题，并作为一个辅助工具，通过阅读和学习大量的自然语言数据来不断提高自身技能和知识体系。目前，它可以回答各种主题的
			

		

	

	

		

		
		

		

			

			
国美回应员工贷款上班、公司报销利息传闻：为虚假消息

			

			

			Tech星球4月7日消息，近日，有媒体报道称，一名认证为国美零售员工的网友在职场应用平台上爆料，国美开启了新型上班模式：贷款上班，公司报销部分利息。对此，国美公关部回应称：“国美CTO李一冰本人表示：此为虚假信息。”此前网传截
			

		

	

	

		

		
		

		

			

			
「PAD」首款骁龙8Gen2平板？袖扣设计 最大14.6英寸屏幕

			

			

			最近OPPO、拯救者先后发布了搭载天玑9000的平板新品，本月将要发布的vivo Pad 2爆料也是天玑9000，而小米平板6系列爆料是骁龙870/骁龙8+处理器，一直有小伙伴问为什么没骁龙8 Gen2的平板，现在爆料来了。 据了解，三星将在今年
			

		

	

	

		

		
		

		

			

			
上海硬核科技企业TOP100，榜首！

			

			

			近日，在上海市产业技术创新大会上，上海市产业技术创新促进会联合市科协等单位发布《2023上海硬核科技企业TOP100榜单》。嘉定企业上海联影医疗科技股份有限公司位列榜首。上榜企业主要集中在“3+6”产业体系，属于三大先
			

		

	

	

		

		
		

		

			

			
IDEA版Postman来了！功能齐全，好用到爆！

			

			

			1 Restful Fast Request简介Restful Fast Request 是IDEA版Postman。它是一个强大的Restful API工具包插件，可以根据已有的接口方法快速生成接口调试用例。Restful Fast Request 有非常优美的界面来帮助我们完成请求、
			

		

	

	

		

		
		

		

			

			
永清县：数字化智能化赋能实体经济发展

			

			

			图为霍尔茨门业有限公司工作人员正在打印板件标签。通讯员 刘欣羽 记者 刘磊 摄图为圆通速递北方总部基地的自动化分拣设备正在分拣快件。 通讯员 庞趁友 记者 刘磊 摄近日，走进位于永清经济开发区的圆通速递北方总部
			

		

	

	

		

		
		

		

			

			
联想小新首款mini主机官宣：1L体积、内置电源、13代酷睿标压

			

			

			IT之家 4 月 7 日消息，联想小新首款 mini 高性能主机宣布将于 4 月 28 日发布，体积约 1L，搭载英特尔 13 代酷睿标压处理器。从图中可以看到，这款主机采用了斜条纹顶盖，正面配有 USB-A、USB-C、3.5mm 音频接口，支持最多四屏
			

		

	


上滑加载更多 ↓






	

	
推荐阅读：


	

		

			

			
电影推荐：《监视资本主义：智能陷阱》你的个人信息，别人的

			

		

	


	

		

			

			
只有手机号码怎么查快递？这里有3种方法，第3种最准确！

			

		

	


	

		

			

			
史上最大单笔箱船订单！中船获法国达飞海运16艘订单：金额

			

		

	


	

		

			

			
空客赢麻了，一年狂揽近5千亿；波音哭麻了，2022年获中国0订

			

		

	


	

		

			

			
推荐一个word docx文档在线渲染库：docxjs

			

		

	


	

		

			

			
在经济学中，“金融地理学信息流理论”的涵义主要有哪些

			

		

	


	

		

			

			
有没有可以拍照计数的软件？拍照计数的好方法

			

		

	


	

		

			

			
魅族Flyme10携手合合信息扫描全能王，用智能文字识别技

			

		

	


	

		

			

			
JPS:紫外激光辅助刻划氟化石墨烯薄膜制备高速微超级电

			

		

	


	

		

			

			
16艘超大型集装箱船，金额超210亿元人民币！中国造船史上

			

		

	


	

	
	

	
友情链接：

	

		
	

	


	

	
更多：

	

		
本站资料均由网友自行发布提供，仅用于学习交流。如有版权问题，请与我联系，QQ：4156828  

		
© CopyRight 2008-2024 All Rights Reserved. Powered By bs178.com  闽ICP备11008920号-3
闽公网安备35020302034844号

	

	

	




Top