rabbitmq组装成starter

最新推荐文章于 2024-07-08 09:23:09 发布

_0.78

最新推荐文章于 2024-07-08 09:23:09 发布

阅读量519

点赞数

分类专栏： SpringBoot 文章标签： rabbitmq java

本文链接：https://blog.csdn.net/weixin_51578439/article/details/129496956

版权

SpringBoot 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

rabbitmq组装成starter

如果只是简单的基于amqp-client进行mq操作是不大方便的。虽然官方已经封装好了starter，但是个人是希望手动封装简单封装一遍，能够更加深刻理解starter。

1、确认需求

rabbitmq需要的部分是

交换机
队列
绑定键

这三部分是我们需要创建好的，然后直接提供给开发者使用。故我们只需要在starter中创建好这三部分，然后封装好发送的方法即可。

2、开始封装

要引入对应的依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.7.8</version>
    </dependency>
    <dependency>
        <groupId>com.rabbitmq</groupId>
        <artifactId>amqp-client</artifactId>
        <version>5.8.0</version>
    </dependency>
    <!--操作文件流的一个依赖-->
    <dependency>
        <groupId>commons-io</groupId>
        <artifactId>commons-io</artifactId>
        <version>2.6</version>
    </dependency>
</dependencies>

2.1、建立获取参数的类

因为我们连接mq的时候需要host、port等参数，这些参数我们是希望从配置文件获取的，所以建立此类用来获取配置文件的数据。

@ConfigurationProperties(prefix = "mq")
public class MQProperties {

    private String host = "localhost";
    private Integer port = 5672;
    private String username = "guest";
    private String password = "guest";

    private String vHost = "/";

    private String[] queues;

    public String[] getQueues() {
        return queues;
    }

    public void setQueues(String[] queues) {
        this.queues = queues;
    }

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public Integer getPort() {
        return port;
    }

    public void setPort(Integer port) {
        this.port = port;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getvHost() {
        return vHost;
    }

    public void setvHost(String vHost) {
        this.vHost = vHost;
    }
}

2.2、创建配置文件

在该配置文件中，我们需要连接mq，然后设置交换机、设置队列和绑定键，连接mq的配置我们可以从上一步新建的配置类中获取。

@Configuration
public class MQClientConfig {

    private final MQProperties mqProperties;

    public MQClientConfig(MQProperties mqProperties) {
        this.mqProperties = mqProperties;
    }

    @Bean
    public Channel chanel() {
        // 1、连接
        ConnectionFactory factory = new ConnectionFactory();
        factory.setHost(mqProperties.getHost());
        factory.setUsername(mqProperties.getUsername());
        factory.setPassword(mqProperties.getPassword());
        Channel channel;
        try {
            Connection connection = factory.newConnection();
            channel = connection.createChannel();
        } catch (IOException | TimeoutException e) {
            throw new RuntimeException(e);
        }


        // 2、声明交换机
        try {
            channel.exchangeDeclare("exchange-s", BuiltinExchangeType.DIRECT);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }

        String[] queues = mqProperties.getQueues();
        Map<String, String> queueBindingMap = new HashMap<>(queues.length);
        for (String queue : queues) {
            String[] split = queue.split(";");
            queueBindingMap.put(split[0], split[1]);
        }

        for (Map.Entry<String, String> entry : queueBindingMap.entrySet()) {

            // 3、声明队列
            try {
                channel.queueDeclare(entry.getKey(), false, false, false, null);
                // 4、声明绑定
                channel.queueBind(entry.getKey(), "exchange-s", entry.getValue());
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }

        // 5、返回 chanel
        return channel;

    }

}

我这里直接将交换机的名称写死了，到时候改进的话可以改写成配置文件的即可。

配置的队列和路由键是成套的，格式为queueName;routingKey，也可以改写成自己的需要的格式。

然后通过for循环将队列和绑定键一一定义。

最后将channel返回。

2.3、封装发送方法

@Component
public class MQUtils {
    private final Channel channel;
    public MQUtils(Channel channel) {
        this.channel = channel;
    }

    public void send(String exchangeName, String routingKey, String message) {
        /*
             发送一个消息
             1.发送到那个交换机，如果不传入，默认传到Exchange: (AMQP default)里面
             2.路由的 key 是哪个
             3.其他的参数信息
             4.发送消息的消息体
         */
        try {
            channel.basicPublish(exchangeName, routingKey, null, message.getBytes());
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

}

获取channel然后调用其方法。

2.4、配置自动配置类

@Configuration
@EnableConfigurationProperties(MQProperties.class)
@ConditionalOnClass(MQProperties.class)
public class MQAutoconfig {

    @Resource
    private MQProperties mqProperties;
    @Resource
    private Channel channel;

    @Bean
    public MQClientConfig mqClientConfig() {
        return new MQClientConfig(mqProperties);
    }

    @Bean
    public MQUtils mqUtils() {
        return new MQUtils(channel);
    }

}

2.5、配置spring.factories

将自动配置类文件写入

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  pers.lgq.MQAutoconfig

2.6、引入

到2.5后，starter就可以封装好了，我们只需要在项目引入该starter即可。新建一个spring-boot项目，引入该starter

<dependency>
    <groupId>pers.lgq</groupId>
    <artifactId>rabbitmq-lgq-starter-autoconfig</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2.7、配置连接参数

在配置文件中配置mq的参数

mq.host=192.168.246.150
mq.port=5672
mq.virtual-host=/
mq.username=user
mq.password=password
mq.queues[0]=test-queue-03;test.key.03

2.8、发送消息

@RestController
@RequestMapping(value = "/mq")
public class MQController {

    @Resource
    MQUtils mqUtils;

    @GetMapping(value = "/send")
    public void send() {
        mqUtils.send("exchange-s", "test.key.03", "hello world 03");
    }

}