SpringBoot高级篇Redis之String数据结构的读写

Redis目前常用的存储结构有五种，String字符串，List列表，Set集合，Hash散列，ZSet有序集合；本篇则主要集中在String这个数据结构的读写操作之上

对于String的操作，除了常见的get/set之外，还有一些比较有特色的功能，如用于实现redis分布式锁的setnx/getset方法；用于实现计数的incr/decr方法；位图算法的经典实用场景之bitmap的使用方法等也有必要了解一下

I. 使用方法

1. 基本配置

在项目中首先需要添加基本的依赖，然后我们使用默认的Redis配置进行操作，即本机启动redis服务，端口号为6379，密码没有

<dependencies>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-redis</artifactId>
  </dependency>
</dependencies>

2. Get/Set方法

直接使用默认的RedisTemplate进行redis的读写操作，因为我们没有指定序列化方式，所以本篇使用中，并没有使用更简单的opsForValue进行操作，具体原因可以参考博文

Spring之RedisTemplate配置与使用

@Component
public class KVBean {

    private final StringRedisTemplate redisTemplate;

    public KVBean(StringRedisTemplate redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    // kv数据结构的测试相关

    /**
     * 设置并获取之间的结果，要求key，value都不能为空；如果之前没有值，返回null
     *
     * @param key
     * @param value
     * @return
     */
    public byte[] setAndGetOldValue(String key, String value) {
        return redisTemplate.execute((RedisCallback<byte[]>) con -> con.getSet(key.getBytes(), value.getBytes()));
    }

    public Boolean setValue(String key, String value) {
        return redisTemplate
                .execute((RedisCallback<Boolean>) connection -> connection.set(key.getBytes(), value.getBytes()));
    }

    public byte[] getValue(String key) {
        return redisTemplate.execute((RedisCallback<byte[]>) connection -> connection.get(key.getBytes()));
    }

    public Boolean mSetValue(Map<String, String> values) {
        Map<byte[], byte[]> map = new HashMap<>(values.size());
        for (Map.Entry<String, String> entry : values.entrySet()) {
            map.put(entry.getKey().getBytes(), entry.getValue().getBytes());
        }

        return redisTemplate.execute((RedisCallback<Boolean>) con -> con.mSet(map));
    }

    public List<byte[]> mGetValue(List<String> keys) {
        return redisTemplate.execute((RedisCallback<List<byte[]>>) con -> {
            byte[][] bkeys = new byte[keys.size()][];
            for (int i = 0; i < keys.size(); i++) {
                bkeys[i] = keys.get(i).getBytes();
            }
            return con.mGet(bkeys);
        });
    }
}

上面演示了基本的get/set方法的使用，以及批量的读取和写入缓存值；也给出了getSet方法，基本上就是redis命令的一层浅封装；

对于getset方法，表示的是用新的值覆盖旧的值，并返回旧的值，如果旧的不存在，则返回null

3. 计数

统计计数，也算是一个比较常见的case了，虽然对于redis而言，存储的都是String，但是从我们的逻辑上来看，存在redis中的值，应该是数字型，然后就可以直接传入一个增量，实现存储数据的运算效果，并返回最终的结果

因为redis是单进程方式的，因此采用redis的计数方式，可以较简单的实现分布式的计数效果

 // 自增、自减方式实现计数

/**
 * 实现计数的加/减（ value为负数表示减）
 *
 * @param key
 * @param value
 * @return 返回redis中的值
 */
public Long incr(String key, long value) {
    return redisTemplate.execute((RedisCallback<Long>) con -> con.incrBy(key.getBytes(), value));
}

public Long decr(String key, long value) {
    return redisTemplate.execute((RedisCallback<Long>) con -> con.decrBy(key.getBytes(), value));
}

4. bitmap操作

位图操作，什么地方用得比较多呢？一个经典的case就是统计网站的日活，用户首次登陆时，根据用户id，设置位图中下标为userId的值为1，表示这个用户激活了；然后一天结束之后，只需要统计这个位图中为1的个数就可以知道每日的日活；也可以借此来统计每个用户的活跃状况

下面给出几个常用的位图方法

// bitmap的测试相关

public Boolean setBit(String key, Integer index, Boolean tag) {
    return redisTemplate.execute((RedisCallback<Boolean>) con -> con.setBit(key.getBytes(), index, tag));
}

public Boolean getBit(String key, Integer index) {
    return redisTemplate.execute((RedisCallback<Boolean>) con -> con.getBit(key.getBytes(), index));
}

/**
 * 统计bitmap中，value为1的个数，非常适用于统计网站的每日活跃用户数等类似的场景
 *
 * @param key
 * @return
 */
public Long bitCount(String key) {
    return redisTemplate.execute((RedisCallback<Long>) con -> con.bitCount(key.getBytes()));
}

public Long bitCount(String key, int start, int end) {
    return redisTemplate.execute((RedisCallback<Long>) con -> con.bitCount(key.getBytes(), start, end));
}

public Long bitOp(RedisStringCommands.BitOperation op, String saveKey, String... desKey) {
    byte[][] bytes = new byte[desKey.length][];
    for (int i = 0; i < desKey.length; i++) {
        bytes[i] = desKey[i].getBytes();
    }
    return redisTemplate.execute((RedisCallback<Long>) con -> con.bitOp(op, saveKey.getBytes(), bytes));
}

前面的setBit和getBit就比较简单了，设置或获取位图中某个小标的值；bitCount主要就是统计为1的个数；下面主要说一下最后一个方法bitOp

BITOP 命令支持 AND 、 OR 、 NOT 、 XOR 这四种操作中的任意一种参数：

BITOP AND destkey srckey1 … srckeyN ，对一个或多个 key 求逻辑与，并将结果保存到 destkey
BITOP OR destkey srckey1 … srckeyN，对一个或多个 key 求逻辑或，并将结果保存到 destkey
BITOP XOR destkey srckey1 … srckeyN，对一个或多个 key 求逻辑异或，并将结果保存到 destkey
BITOP NOT destkey srckey，对给定 key 求逻辑非，并将结果保存到 destkey

除了 NOT 操作之外，其他操作都可以接受一个或多个 key 作为输入，执行结果将始终保持到destkey里面。

5. 其他

上面的几个操作都是持久化的写入到redis，如果希望写入待失效时间的，可以使用setex，在写入值的同时加上失效时间；也可以调用额外的设置key的失效时间的方式；使用姿势比较简单，不单独列出

至于另外一个setnx的使用，则将放在后面的应用篇中，实现一个redis的分布式锁的时候，一并加以说明；而bitmap的更多使用，在也会放在后面的借助bitmap实现某个特殊业务场景的应用篇中详细说明

II. 简单测试

简单演示下基本的使用姿势

@RestController
@RequestMapping(path = "rest")
public class DemoRest {

    @Autowired
    private KVBean kvBean;

    @GetMapping(path = "show")
    public String showKv(String key) {
        Map<String, String> result = new HashMap<>(16);

        // kv test
        String kvKey = "kvKey";
        String kvVal = UUID.randomUUID().toString();
        kvBean.setValue(kvKey, kvVal);
        String kvRes = new String(kvBean.getValue(kvKey));
        result.put("kv get set", kvRes + "==>" + kvVal.equals(kvRes));


        // kv getSet

        // 如果原始数据存在时
        String kvOldRes = new String(kvBean.setAndGetOldValue(kvKey, kvVal + "==>new"));
        result.put("kv setAndGet", kvOldRes + " # " + new String(kvBean.getValue(kvKey)));

        // 如果原始数据不存在时
        byte[] kvOldResNull = kvBean.setAndGetOldValue("not exists", "...");
        result.put("kv setAndGet not exists", kvOldResNull == null ? "null" : new String(kvOldResNull));


        // 自增
        String cntKey = "kvIncrKey";
        long val = 10L;
        long incrRet = kvBean.incr(cntKey, val);
        String incrRes = new String(kvBean.getValue(cntKey));
        result.put("kv incr", incrRet + "#" + incrRes);


        // bitmap 测试
        String bitMapKey = "bitmapKey";
        kvBean.setBit(bitMapKey, 100, true);
        boolean bitRes = kvBean.getBit(bitMapKey, 100);
        boolean bitRes2 = kvBean.getBit(bitMapKey, 101);
        result.put("bitMap", bitRes + ">> true | " + bitRes2 + ">> false");
        return JSONObject.toJSONString(result);
    }
}

演示结果如下

show

II. 其他

0. 项目

工程：spring-boot-demo

1. 一灰灰Blog

一灰灰Blog个人博客 https://blog.hhui.top
一灰灰Blog-Spring专题博客 http://spring.hhui.top

一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

2. 声明

尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

微博地址: 小灰灰Blog
QQ：一灰灰/3302797840

3. 扫描关注

一灰灰blog

QrCode

知识星球

goals