Redisson批量操作类RBuckets和管道利器RBatch

1. 《Spring Boot 整合Redisson配置篇》
2. 《Spring Boot 整合Redisson操作Redis基础篇》
3. 《Redisson批量操作类RBuckets和管道利器RBatch》

摘要：使用Redisson的类RBuckets和RBatch批量操作Redis，减少网络请求次数。

综述

  Redis的部署方式有单节点部署、哨兵方式部署、集群方式部署3种方式，这3中方式都使用的是原生的redis。本文基于单节点部署，使用的Spring Boot版本为2.5.x。

RBuckets批量操作

  在Spring Boot项目中，通过RBuckets接口实现批量操作多个RBucket对象，官方示例如下：

RBuckets buckets = redisson.getBuckets();
Map<String, V> loadedBuckets = buckets.get("myBucket1", "myBucket2", "myBucket3");
Map<String, Object> map = new HashMap<>();
map.put("myBucket1", new MyObject());
map.put("myBucket2", new MyObject());
// 利用Redis的事务特性，同时保存所有的通用对象桶，如果任意一个通用对象桶已经存在则放弃保存其他所有数据。
buckets.trySet(map);
// 同时保存全部通用对象桶。
buckets.set(map);

  方法介绍：

• Map<String,V> get(String... keys)：返回桶的key-value对。
• boolean trySet(Map<String,?> buckets)：利用Redis的事务特性，同时保存所有的通用对象桶，如果任意一个通用对象桶已经存在则放弃保存其他所有数据。
• void set(Map<String,?> buckets)：同时保存全部通用对象桶。

RBatch 批量操作

  多个连续命令可以通过RBatch对象在一次网络会话请求里合并发送，这样省去了产生多个请求消耗的时间和资源。这在Redis中叫做管道。

  RBatch管道功能就是REDIS的批量发送，实际上是客户端的功能，与服务端无关。相当于把多个请求的命令放在一个数据包通过TCP发送到服务端，然后客户端再一次性读取所有的命令回应。管道技术最显著的优势是提高了 redis 服务的性能。

   /**
     * 批量操作
     */
    private void batchDemo() throws ExecutionException, InterruptedException {
        Map<String, String> map = new HashMap<>();
        map.put("abc", "testStr");
        map.put("abcDemo", "redis");
        redisUtils.setMassStrings(map);

        log.info("String 测试数据：{}", redisUtils.getStr("abc") + " "
                + redisUtils.getStr("abcDemo"));

        RBatch batch = redisUtils.createBatch();
        // 模拟购物车场景，真实场景中请替换店铺ID shopId 和商品ID commodityId
        String field = "shopId:commodityId";
        // 把即将执⾏的命令放进 RBatch
        RMapAsync testMap = batch.getMap("customerId:"+ 32L);
        // 更新value，并返回上一次的值
        String commodityNum = "mapValue" + String.valueOf((int)(Math.random()*9 + 100));
        log.info("当前商品数量commodityNum是：{}", commodityNum);
        testMap.putAsync(field, commodityNum);
        testMap.putAsync("test2", "mapValue3");
        testMap.putAsync("test2", "mapValue5");
        testMap.putAsync("test："+ String.valueOf((int)(Math.random()*900 + 100)), String.valueOf((int)(Math.random()*900 + 100)));

        RAtomicLongAsync counter = batch.getAtomicLong("counter");

        RFuture<Long> num = counter.incrementAndGetAsync();

        // 执行RBatch中的全部命令，并返回执行结果
        BatchResult result = batch.execute();
        List list = result.getResponses();
        log.info("Map Batch 执行结果：{}", list);
        log.info("计数器当前值：{}", num.get());
    }

  执行batchDemo()后，控制台打印结果如下：

StudyRedissonController - String 测试数据：testStr redis
StudyRedissonController - 当前商品数量commodityNum是：mapValue106
StudyRedissonController - Map Batch 执行结果：[mapValue101, mapValue5, mapValue3, null, 8]
StudyRedissonController - 计数器当前值：8

  测试用例主要介绍了Hash，顺便介绍一下它的使用场景：

• 存储结构化的数据，比如 Java 中的对象。其实 Java 中的对象也可以用 string 进行存储，只需要将对象序列化成 json 字符串就可以，但是如果这个对象的某个属性更新比较频繁的话，那么每次就需要重新将整个对象序列化存储，这样消耗开销比较大。可如果用 hash 来存储对象的每个属性，那么每次只需要更新要更新的属性就可以。
• 购物车场景。以业务线+用户id作为key，以店铺编号+商品的id作为存储的field，以选购商品数量作为键值对的value，这样就构成了购物车的三个要素。

  在集群模式下，所有的命令会按各个槽所在的节点，筛选分配到各个节点并同时发送。每个节点返回的结果将会汇总到最终的结果列表里。上述demo中用到的工具类如下：

@Component
public class RedisUtils {

    private RedisUtils() {
    }

    /**
     * 默认缓存时间
     */
    private static final Long DEFAULT_EXPIRED = 32000L;

    /**
     * 自动装配redisson client对象
     */
    @Resource
    private RedissonClient redissonClient;
    /**
     * 获取getBuckets 对象
     *
     * @return RBuckets 对象
     */
    public RBuckets getBuckets() {
        return redissonClient.getBuckets();
    }
    /**
     * 读取缓存中的字符串，永久有效
     *
     * @param key 缓存key
     * @return 字符串
     */
    public String getStr(String key) {
        RBucket<String> bucket = redissonClient.getBucket(key);
        return bucket.get();
    }

   // ---------------- 批量操作 ------------------------
    /**
     * 获取RBatch
     *
     * @return RBatch
     */
    public RBatch createBatch() {
        return redissonClient.createBatch();
    }

    /**
     * 批量移除缓存
     *
     * @param keys key 对象
     */
    public void deleteBatch(String... keys) {
        if (null == keys) {
            return;
        }
        this.getKeys().delete(keys);
    }

    /**
     * 批量缓存字符串，缺点：不可以设置过期时间
     *
     * @param map 缓存key-value
     */
    public void setMassStrings(Map<String, String> map) {
        if (MapUtils.isEmpty(map)) {
            return;
        }
        RBuckets buckets = redissonClient.getBuckets();
        // 同时保存全部通用对象桶。
        buckets.set(map);
    }

    /**
     * 批量缓存字符串，支持过期
     *
     * @param map 缓存key-value
     * @param leaseTime 缓存有效期，必传
     */
    public void setMassStrings(Map<String, String> map, long leaseTime) {
        if (MapUtils.isEmpty(map)) {
            return;
        }
        final long expireTime = leaseTime <= 0L ? DEFAULT_EXPIRED : leaseTime;
        RBatch batch = redissonClient.createBatch();
        map.forEach(new BiConsumer<String, String>() {
            public void accept(String key, String value) {
                batch.getBucket(key).setAsync(value, expireTime, TimeUnit.SECONDS);
            }
        });
        batch.execute();
    }

}

结束语

  关于redisson中如何使用批量操作类RBuckets和管道利器RBatch就分享到这里，希望本文对大家的学习或者工作具有一定的参考和学习价值；如果有疑问，大家可以在评论区留言交流，也希望大家多多点赞关注。谢谢大家对楼兰胡杨的支持！

Reference

• https://www.bookstack.cn/read/redisson-wiki-zh/spilt.4.2.-配置方法.md