快捷導(dǎo)航

Java對(duì)象以Hash結(jié)構(gòu)存入Redis詳解

更新時(shí)間：2023年08月29日 08:51:19 作者：Abstracted

這篇文章主要介紹了Java對(duì)象以Hash結(jié)構(gòu)存入Redis詳解,和Java中的對(duì)象非常相似,卻不能按照J(rèn)ava對(duì)象的結(jié)構(gòu)直接存儲(chǔ)進(jìn)Redis的hash中,因?yàn)镴ava對(duì)象中的field是可以嵌套的,而Redis的Hash結(jié)構(gòu)不支持嵌套結(jié)構(gòu),需要的朋友可以參考下

Java對(duì)象以Hash結(jié)構(gòu)存入Redis

Redis中Hash存儲(chǔ)結(jié)構(gòu)：

Key:{
	filed: value,
	filed: value,
	filed: value,
	....
}

和Java中的對(duì)象非常相似，卻不能按照J(rèn)ava對(duì)象的結(jié)構(gòu)直接存儲(chǔ)進(jìn)Redis的hash中。因?yàn)镴ava對(duì)象中的field是可以嵌套的，而Redis的Hash結(jié)構(gòu)不支持嵌套結(jié)構(gòu)。（不允許套娃~）。

有的同學(xué)要問了，那我就是頭鐵，就要把帶嵌套屬性的對(duì)象存儲(chǔ)redis的hash中，應(yīng)該怎么辦？

Spring對(duì)所有的RedisClient進(jìn)行了封裝，提供了一個(gè)RedisTemplate。那我們看看RedisTemplate中對(duì)hash結(jié)構(gòu)的存儲(chǔ)都接受什么參數(shù)？

在這里插入圖片描述

從圖中可以看出:

一次存一個(gè)KV
一次性將Map中的所有KV都存入
如果不存在就存入

一次只存一個(gè)KV就不用說了。重點(diǎn)是第二個(gè)putAll方法。既然是Map，那我們不就是可以將帶有嵌套屬性的對(duì)象轉(zhuǎn)成Map就可以存進(jìn)Redis了嗎？

但經(jīng)過實(shí)踐最終拋出了異常。正如上面已經(jīng)說過的，Redis的Hash結(jié)構(gòu)不允許套娃。而不帶有嵌套屬性的對(duì)象轉(zhuǎn)成Map后可以正常存入。

對(duì)象轉(zhuǎn)Map可以使用commons的BeanUtils中的toMap方法。

難道真的就沒有解決辦法了嗎？其實(shí)Spring已經(jīng)為我們提供了嵌套屬性轉(zhuǎn)Map的3中實(shí)現(xiàn)方案，也就是 HashMapper 接口

在這里插入圖片描述

BeanUtilsHashMapper：內(nèi)部依賴commons的BeanUtils將對(duì)象轉(zhuǎn)Map，但是官方注釋中也說明了這個(gè)實(shí)現(xiàn)類不支持嵌套屬性。
ObjectHashMapper：內(nèi)部使用的是RedisMappingConverter將給定的Java對(duì)象提供一個(gè)平面的映射，即支持嵌套屬性。
Jackson2HashMapper：內(nèi)部使用的是Jackon的ObjectMapper將對(duì)象轉(zhuǎn)換成扁平的Map
DecoratingStringHashMapper：沒有什么特殊的，toHash方法實(shí)現(xiàn)了裝飾器（增強(qiáng)）設(shè)計(jì)模式，對(duì)delegate.toHash的結(jié)果Map中的KV都進(jìn)行String.valueOf()操作。

可以看出 ObjectHashMapper 和 Jackson2HashMapper 的效果相同，用那個(gè)都可以。

注意：Jackson2HashMapper在為對(duì)象生成Map時(shí)，內(nèi)部對(duì)ObjectMapper配置了對(duì)Date類型的序列化規(guī)則，會(huì)將其換成時(shí)間戳Long類型。在執(zhí)行putAll時(shí)，內(nèi)部會(huì)報(bào)ClassCastException Long cast to String，Long無法直接轉(zhuǎn)換為String。此時(shí)可以使用DecoratingStringHashMapper對(duì)Jackson2HashMapper進(jìn)行增強(qiáng)。

下面是一部分的示例代碼和截圖

@Autowired
    private RedisTemplate redisTemplate;
    /**
     * 測(cè)試Redis存Hash結(jié)構(gòu)數(shù)據(jù)
     */
    @Test
    void testSaveRedisHash() throws JsonProcessingException {
        User user = new User();user.setUserId(111);user.setPassword("psw");user.setName("張三");user.setCreateTime(new Date());
        ObjectMapper objectMapper = new ObjectMapper();
        redisTemplate.setHashKeySerializer(RedisSerializer.string());
        redisTemplate.setHashValueSerializer(RedisSerializer.string());
        // key, filed, value
        redisTemplate.opsForHash().put("testHash", "hashKey", "hashValue");
        // 直接寫JSON，并沒有什么卵用
        redisTemplate.opsForHash().put("testHash", "user", objectMapper.writeValueAsString(user));
        TestRedisHashObject testObj = new TestRedisHashObject(1, "測(cè)試時(shí)", new Date(), user);
        // 依賴第三方commons.beanUtils包
        redisTemplate.opsForHash().putAll("BeanUtilsHashMapper實(shí)現(xiàn)對(duì)象轉(zhuǎn)hash",new BeanUtilsHashMapper<>(TestRedisHashObject.class).toHash(testObj));
        // flatmap為true，才開啟json屬性path扁平化。
        // jackson2HashMapper中默認(rèn)的ObjectMapper對(duì)時(shí)間序列化成了long，而putAll方法中對(duì)long無法直接強(qiáng)轉(zhuǎn)成string。會(huì)發(fā)生ClassCastException
        // decoratingStringHashMapper：將map中的所有kv都使用StringValueOf進(jìn)行了增強(qiáng)
        redisTemplate.opsForHash().putAll("Jackson2HashMapper實(shí)現(xiàn)對(duì)象轉(zhuǎn)hash",new DecoratingStringHashMapper<>(new Jackson2HashMapper(true)).toHash(testObj));
        // ObjectHashMapper返回的Map的泛型是Map<byte[], byte[]> 需要自己手動(dòng)轉(zhuǎn)換。不推薦使用
        // decoratingStringHashMapper：String.valueOf方法無法對(duì)byte[]進(jìn)行轉(zhuǎn)成字符串
        // redisTemplate.opsForHash().putAll("ObjectHashMapper實(shí)現(xiàn)對(duì)象轉(zhuǎn)hash",new ObjectHashMapper().toHash(testObj));
    }
    /**
     * 測(cè)試Redis取Hash結(jié)構(gòu)數(shù)據(jù)
     */
    @Test
    void testGetRedisHash(){
        redisTemplate.setHashKeySerializer(RedisSerializer.string());
        redisTemplate.setHashValueSerializer(RedisSerializer.string());
        String key = "Jackson2HashMapper實(shí)現(xiàn)對(duì)象轉(zhuǎn)hash";
        Object o = new Jackson2HashMapper(true).fromHash(redisTemplate.opsForHash().entries(key));
        TestRedisHashObject testObj = (TestRedisHashObject) o;
        System.out.println(testObj);
        Long newCount = redisTemplate.opsForHash().increment(key, "count", 10L);
        System.out.println("newCount = " + newCount);
        o = new Jackson2HashMapper(true).fromHash(redisTemplate.opsForHash().entries(key));
        testObj = (TestRedisHashObject) o;
        System.out.println(testObj);
		Object c = redisTemplate.opsForHash().get(key, "count");
        Long count = (Long) c;
        System.out.println("getCount = " + count);
    }

在這里插入圖片描述