欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

使用Spring-boot-starter标准改造项目内的RocketMQ客户端组件

程序员文章站 2024-03-30 19:32:51
用Spring Boot Starter标准封装自己的RocketMQ客户端组件 ......

一、背景介绍

我们在使用spring cloud全家桶构建微服务应用时,经常能看到spring-boot-xxx-starter的依赖,像spring-boot-starter-web、spring-cloud-starter-feign、spring-boot-starter-test、mybatis-spring-boot-starter,仿佛只要带上starter的东西,你就拥有了这个组件的一切,包括所有的配置,引用类都搞定了,这样一个神奇的拿来就用的东西,是怎么实现的呢?我们自己能不能把自己的工具包做成一个starter?

二、spring boot starter组件规范

  • 命名规范

groupid:这个标签的命名没做太多要求,基本上使用公司域名+项目名方式,如官方一般使用org.springframework.cloud,第三方一般用自己公司域名,如org.mybatis.spring.boot。
artifactid:这个标签的命名spring官方给了建议命名方式,spring官方自己发布的组件,命名方式是spring-boot-starter-xxx,xxx表示组件名称,像上文提及的spring-boot-starter-web和spring-cloud-starter-feign;第三方开发的组件,命名方式是xxx-spring-boot-starter,如mybatis-spring-boot-starter。

  • 工程规范

以maven工程为例,spring boot starter用多模块方式建立工程,工程内有autoconfigure模块和starter模块。
autoconfigure模块为自动配置模块,里面包含配置加载,全部的功能代码实现及需要引用的jar包,负责对内功能实现,所有的代码开发都在这个模块中完成。
starter模块提供自动配置模块的依赖,里面没有代码,是个空jar包,只有对autoconfigure模块的所有引用,是一个依赖集,它的目的是简化使用该组件时的依赖,只要添加starter模块,就能使用整个starter组件。

三、案例实战

我们以常用的rocketmq客户端组件为例,搭建一个自己定义的starter,rocketmq是由阿里巴巴团队开发并捐赠给apache团队的优秀消息中间件,承受过历年双十一大促的考验。

  1. 创建一个maven工程,增加两个模块rocketmq-spring-boot-autoconfigure和rocketmq-spring-boot-starter,这里使用的rocketmq版本为4.5.2,主pom.xml节选如下:
<groupid>com.hy.demo</groupid>
<artifactid>rocketmq</artifactid>
<packaging>pom</packaging>
<version>1.0-snapshot</version>

<modules>
    <module>rocketmq-spring-boot-autoconfigure</module>
    <module>rocketmq-spring-boot-starter</module>
</modules>

<dependencies>
    <dependency>
        <groupid>org.apache.commons</groupid>
        <artifactid>commons-lang3</artifactid>
        <version>3.3.2</version>
    </dependency>
    <dependency>
        <groupid>org.apache.rocketmq</groupid>
        <artifactid>rocketmq-client</artifactid>
        <version>4.5.2</version>
    </dependency>
    <dependency>
        <groupid>org.projectlombok</groupid>
        <artifactid>lombok</artifactid>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupid>org.springframework</groupid>
        <artifactid>spring-context</artifactid>
        <version>5.1.8.release</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupid>org.slf4j</groupid>
        <artifactid>slf4j-api</artifactid>
    </dependency>
</dependencies>
  1. autoconfigure模块开发
    src目录下添加相应的工具类,如注解,配置类,接口等,略
    添加定位配置侯选类,在meta-inf/目录下新建spring.factories文件:
org.springframework.boot.autoconfigure.enableautoconfiguration=com.hy.demo.rocketmq.mqconfig

spring boot会检查你发布的jar中是否存在meta-inf/spring.factories文件,自动配置类只能通过这种方式加载

  1. starter模块开发
    只需要修改pom.xml文件即可:
<parent>
    <artifactid>rocketmq</artifactid>
    <groupid>com.hy.demo</groupid>
    <version>1.0-snapshot</version>
</parent>
<modelversion>4.0.0</modelversion>

<artifactid>rocketmq-spring-boot-starter</artifactid>

<dependencymanagement>
    <dependencies>
        <dependency>
            <groupid>com.hy.demo</groupid>
            <artifactid>rocketmq</artifactid>
            <version>1.0-snapshot</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencymanagement>

<dependencies>
    <dependency>
        <groupid>com.hy.demo</groupid>
        <artifactid>rocketmq-spring-boot-autoconfigure</artifactid>
        <version>1.0-snapshot</version>
    </dependency>
</dependencies>

在idea上对该工程进行编译,打包,命令:

clean install -dskiptests=true

4、打包部署完成后,在应用模块里添加该starter的依赖即可

<dependency>
   <groupid>com.hy.demo</groupid>
   <artifactid>rocketmq-spring-boot-starter</artifactid>
   <version>1.0-snapshot</version>
</dependency>

注:因为rocketmq组件较为通用,目前提供基本的几种发送和接收消息的方式,支持事务消息,文章内就不一一解释代码功能,附上此次源码地址:

rocketmq-spring-boot-starter源码示例

四、知识点梳理

  1. spring的几个注解:
    @import用来整合所有在@configuration注解中定义的bean配置;
    @eventlistener 事件监听,里面写的contextstartedevent,表示监听spring上下文启动完成后的事件;
    @configuration相当于xml的beans标签;
    @bean标注在方法上,等同于xml的bean;

  2. 自定义注解@mqconsumer和注解@mqtransactionproducer是如何起作用的?
    工程里定义了com.hy.demo.rocketmq.config.rocketmqannotationscan类对这两个注解进行扫描,利用注解@eventlistener(contextstartedevent.class),监听spring上下文初始化事件,然后从spring容器内读取所有带这两个注解的类,把rocketmq相关的配置信息加载进去,由于事务消息生产者类org.apache.rocketmq.client.producer.transactionmqproducer的特殊性(它需要在初始化时注入transactionlistener监听类,与应用模块有一定耦合性),所以增加了一个map集合存储应用模块内所有使用了@mqtransactionproducer注解的实例。
    专注java高并发、分布式架构,更多技术干货分享与心得,请关注公众号:java架构社区
    使用Spring-boot-starter标准改造项目内的RocketMQ客户端组件