Springboot中使用redisson + 自定义注解优雅的实现消息的发布订阅

简介: Springboot中使用redisson + 自定义注解优雅的实现消息的发布订阅

前言

在一些小型场景下,使用mq中间件可能会为原有项目增加不少维护成本,使用redisson实现消息的收发是个不错的选择


什么是redisson?

官网:Redisson: Easy Redis Java client with features of In-Memory Data Grid


Redisson是一个基于Redis的Java驻留内存数据网格(In-Memory Data Grid)和分布式锁框架。它提供了一系列的分布式Java对象和服务,可以帮助开发者更方便地使用Redis作为数据存储和分布式锁的解决方案。

Redisson的主要功能包括:

分布式集合:Redisson提供了分布式的Set、List、Queue、Deque等集合,可以在分布式环境下进行操作,实现数据共享和协作。


分布式映射:Redisson提供了分布式的Map、Multimap、ConcurrentMap等映射结构,可以在分布式环境下进行操作,实现数据的存储和共享。


分布式锁:Redisson提供了可重入锁、公平锁、读写锁等分布式锁,可以在分布式环境下实现资源的互斥访问,保证数据的一致性和并发安全。


分布式对象:Redisson提供了分布式的AtomicLong、CountDownLatch、Semaphore等对象,可以在分布式环境下实现共享状态和协作操作。

Redisson的使用场景包括但不限于:


分布式缓存:Redisson可以作为分布式缓存的解决方案,将数据存储在Redis中,提高数据的读取速度和系统的性能。


分布式锁:Redisson可以用于实现分布式锁,保证在分布式环境下对共享资源的互斥访问,避免数据的并发冲突。


分布式任务调度:Redisson可以用于实现分布式任务调度,将任务分发到不同的节点上执行,提高系统的并发处理能力。

Redisson的优点包括:

  1. 简单易用:Redisson提供了简洁的API和丰富的文档,使得使用者可以快速上手。
  2. 高性能:Redisson利用Redis的高性能特性,可以实现快速的数据读写和并发操作。
  3. 可靠性:Redisson提供了分布式锁和数据持久化等机制,保证数据的一致性和可靠性。

Redisson的缺点包括:

  1. 依赖于Redis:Redisson需要依赖Redis作为数据存储和分布式锁的后端,需要确保Redis的可用性和性能。
  2. 部署复杂性


redisson发布订阅的基本使用

// 创建Redisson客户端
RedissonClient redisson = Redisson.create();
 
// 获取RTopic对象
RTopic<String> topic = redisson.getTopic("myTopic");
 
// 发布消息
topic.publish("Hello, Redisson!");
 
// 添加监听器
topic.addListener(String.class, (channel, msg) -> {
    System.out.println("Received message: " + msg);
});
 
// 关闭Redisson客户端
redisson.shutdown();

发布和订阅,是我们需要对同一个 Topic 进行发布和监听操作。但这个操作的代码是一种手动编码,但在我们实际使用中,如果所有的都是手动编码,一个是非常麻烦,再有一个是非常累人。

通过自定义注解,来完成动态监听和将对象动态注入到 Spring 容器中,让需要注入的属性,可以被动态注入。

结合自定义注解优雅实现

导入依赖

        <dependency>
            <groupId>org.redisson</groupId>
            <artifactId>redisson-spring-boot-starter</artifactId>
            <version>3.14.1</version>
        </dependency>


编写redisson初始化配置

redis:
  sdk:
    config:
      host: localhost
      port: 6379
      pool-size: 10
      min-idle-size: 5
      idle-timeout: 30000
      connect-timeout: 5000
      retry-attempts: 3
      retry-interval: 1000
      ping-interval: 60000
      keep-alive: true


编写redisson配置类

/**
 * @description redis连接配置
 * @create 2023/12/17 20:48:13
 */
@Data
@ConfigurationProperties(prefix = "redis.sdk.config", ignoreInvalidFields = true)
public class RedissonCientConfigProperties {
    /** host:ip */
    private String host;
    /** 端口 */
    private int port;
    /** 账密 */
    private String password;
    /** 设置连接池的大小,默认为64 */
    private int poolSize = 64;
    /** 设置连接池的最小空闲连接数,默认为10 */
    private int minIdleSize = 10;
    /** 设置连接的最大空闲时间(单位:毫秒),超过该时间的空闲连接将被关闭,默认为10000 */
    private int idleTimeout = 10000;
    /** 设置连接超时时间(单位:毫秒),默认为10000 */
    private int connectTimeout = 10000;
    /** 设置连接重试次数,默认为3 */
    private int retryAttempts = 3;
    /** 设置连接重试的间隔时间(单位:毫秒),默认为1000 */
    private int retryInterval = 1000;
    /** 设置定期检查连接是否可用的时间间隔(单位:毫秒),默认为0,表示不进行定期检查 */
    private int pingInterval = 0;
    /** 设置是否保持长连接,默认为true */
    private boolean keepAlive = true;
}


编写自定义主题注解,用来指定主题

/**
 * @description redisson 消息主题注解
 * @create 2023/12/17 21:56:10
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
public @interface RedisTopic {
 
    // 主题名称
    String topic() default "";
 
}

初始化Redisson客户端,注册主题监听

/**
 * @description redis客户端
 * @create 2023/12/17 20:49:41
 */
@Configuration
@EnableConfigurationProperties(RedisCientConfigProperties.class)
public class RedisClientConfig {
 
     public RedissonClient redissonClient(ConfigurableApplicationContext applicationContext, RedisCientConfigProperties properties) {
        Config config = new Config();
 
 
        config.useSingleServer()
                .setAddress("redis://" + properties.getHost() + ":" + properties.getPort())
               .setPassword(properties.getPassword())
                .setConnectionPoolSize(properties.getPoolSize())
                .setConnectionMinimumIdleSize(properties.getMinIdleSize())
                .setIdleConnectionTimeout(properties.getIdleTimeout())
                .setConnectTimeout(properties.getConnectTimeout())
                .setRetryAttempts(properties.getRetryAttempts())
                .setRetryInterval(properties.getRetryInterval())
                .setPingConnectionInterval(properties.getPingInterval())
                .setKeepAlive(properties.isKeepAlive())
        ;
 
        RedissonClient redissonClient = Redisson.create(config);
 
        // 注册消息发布订阅主题Topic
        // 找到所有实现了Redisson中MessageListener接口的bean名字
        String[] beanNamesForType = applicationContext.getBeanNamesForType(MessageListener.class);
        for (String beanName : beanNamesForType) {
            // 通过bean名字获取到监听bean
            MessageListener bean = applicationContext.getBean(beanName, MessageListener.class);
 
            Class<? extends MessageListener> beanClass = bean.getClass();
 
            // 如果bean的注解里包含我们的自定义注解RedisTopic.class,则以RedisTopic注解的值作为name将该bean注册到bean工厂,方便在别处注入
            if (beanClass.isAnnotationPresent(RedisTopic.class)) {
                RedisTopic redisTopic = beanClass.getAnnotation(RedisTopic.class);
 
                RTopic topic = redissonClient.getTopic(redisTopic.topic());
                topic.addListener(String.class, bean);
 
                ConfigurableListableBeanFactory beanFactory = applicationContext.getBeanFactory();
                beanFactory.registerSingleton(redisTopic.topic(), topic);
            }
        }
 
        return redissonClient;
    }
 
 
 
}

在监听器上声明注解,如下服务即订阅了testRedisTopic02主题

@Slf4j
@Service
@RedisTopic(topic = "testRedisTopic02")
public class RedisTopicListener02 implements MessageListener<String> {
 
    @Override
    public void onMessage(CharSequence channel, String msg) {
        log.info("02-监听消息(Redis 发布/订阅): {}", msg);
    }
 
}

使用,发布消息

@Slf4j
@Repository
public class OrderRepository implements IOrderRepository {
 
 
 
    @Resource(name = "testRedisTopic02")
    private RTopic testRedisTopic02;
 
    @Resource(name = "testRedisTopic03")
    private RTopic testRedisTopic03;
 
 
    @Override
    public String createOrder(OrderAggregate orderAggregate) {
    
        // 向  testRedisTopic02 发布消息
        testRedisTopic02.publish(JSON.toJSONString(orderEntity));
        // 向  testRedisTopic03 发布消息
        testRedisTopic03.publish(JSON.toJSONString(orderEntity));
 
        return orderId;
    }    
}    
相关文章
|
6月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
965 128
|
6月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
673 0
|
6月前
|
Java 测试技术 API
将 Spring 的 @Embedded 和 @Embeddable 注解与 JPA 结合使用的指南
Spring的@Embedded和@Embeddable注解简化了JPA中复杂对象的管理,允许将对象直接嵌入实体,减少冗余表与连接操作,提升数据库设计效率。本文详解其用法、优势及适用场景。
386 126
|
5月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
619 2
|
6月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
760 1
使用Spring的@Retryable注解进行自动重试
|
6月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
448 12
|
6月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
339 0
探索Spring Boot的@Conditional注解的上下文配置
|
6月前
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
264 0
Spring中最大化@Lazy注解,实现资源高效利用
|
6月前
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
230 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码

热门文章

最新文章