基于Spring Boot2.x使用Redis(Lettuce)详细教程---Redis数据类型哈希(Hash) (四)

Redis hash 是一个string类型的field和value的映射表，hash特别适合用于存储对象。 Redis 中每个 hash 可以存储 232 - 1 键值对（40多亿），可以看成具有KEY和VALUE的MAP容器，该类型非常适合于存储值对象的信息，
如：uname,upass,age等。该类型的数据仅占用很少的磁盘空间（相比于JSON）。

4.1 应用场景

保存纪录中的详细信息。比如用户的详细信息，用ID作为key，value则用一组field-value的形式保存。

4.2 代码示例

代码：com.javablog.redis.demo.service.impl.HashCacheServiceImpl

package com.javablog.redis.demo.service.impl;

import com.javablog.redis.demo.service.HashCacheService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.Cursor;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ScanOptions;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;

import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

@Service("hashCacheService")
public class HashCacheServiceImpl implements HashCacheService {
    private final static Logger log = LoggerFactory.getLogger(HashCacheServiceImpl.class);

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    /**
     * 获取MAP中的某个值
     * @param key  键
     * @param item 项
     * @return 值
     */
    public Object hget(String key, String item) {
        return redisTemplate.opsForHash().get(key, item);
    }

    /**
     * 获取hashKey对应的所有键值
     * @param key 键
     * @return 对应的多个键值
     */
    public Map <Object, Object> hmget(String key) {
        return redisTemplate.opsForHash().entries(key);
    }

    /**
     * 以map集合的形式添加键值对
     * @param key 键
     * @param map 对应多个键值
     * @return true 成功 false 失败
     */
    public boolean hmset(String key, Map <String, Object> map) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * HashSet 并设置时间
     * @param key  键
     * @param map  对应多个键值
     * @param time 时间(秒)
     * @return true成功 false失败
     */
    public boolean hmset(String key, Map <String, Object> map, long time) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     * @param key   键
     * @param item  项
     * @param value 值
     * @param time  时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value, long time) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 删除hash表中的值
     * @param key  键 不能为null
     * @param item 项 可以使多个 不能为null
     */
    public void hdel(String key, Object... item) {
        redisTemplate.opsForHash().delete(key, item);
    }

    /**
     * 判断hash表中是否有该项的值
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return true 存在 false不存在
     */
    public boolean hHasKey(String key, String item) {
        return redisTemplate.opsForHash().hasKey(key, item);
    }

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     * @param key  键
     * @param item 项
     * @param by   要增加几(大于0)
     * @return
     */
    public long hincr(String key, String item, long by) {
        return redisTemplate.opsForHash().increment(key, item, by);
    }

    /**
     * hash递减
     * @param key  键
     * @param item 项
     * @param by   要减少记(小于0)
     * @return
     */
    public long hdecr(String key, String item, long by) {
        return redisTemplate.opsForHash().increment(key, item, -by);
    }

    /**
     * 获取指定变量中的hashMap值。
     * @param key
     * @return 返回LIST对象
     */
    @Override
    public List<Object> values(String key) {
        return redisTemplate.opsForHash().values(key);
    }

    /**
     *  获取变量中的键。
     * @param key
     * @return 返回SET集合
     */
    @Override
    public Set<Object> keys(String key) {
        return  redisTemplate.opsForHash().keys(key);
    }

    /**
     * 获取变量的长度。
     * @param key 键
     * @return  返回长度
     */
    @Override
    public long size(String key) {
        return redisTemplate.opsForHash().size(key);
    }

    /**
     * 以集合的方式获取变量中的值。
     * @param key
     * @param list
     * @return 返回LIST集合值
     */
    @Override
    public List multiGet(String key, List list) {
        return redisTemplate.opsForHash().multiGet(key,list);
    }

    /**
     *  如果变量值存在，在变量中可以添加不存在的的键值对
     *  如果变量不存在，则新增一个变量，同时将键值对添加到该变量。
     * @param key
     * @param hashKey
     * @param value
     */
    @Override
    public void putIfAbsent(String key, String hashKey, Object value) {
        redisTemplate.opsForHash().putIfAbsent(key,hashKey,value);
    }

    /**
     * 匹配获取键值对，ScanOptions.NONE为获取全部键对，ScanOptions.scanOptions().match("map1").build()
     * 匹配获取键位map1的键值对,不能模糊匹配。
     * @param key
     * @param options
     * @return
     */
    @Override
    public Cursor<Map.Entry<Object, Object>> scan(String key, ScanOptions options) {
        return  redisTemplate.opsForHash().scan(key,options);
    }

    /**
     * 删除变量中的键值对，可以传入多个参数，删除多个键值对。
     * @param key 键
     * @param hashKeys MAP中的KEY
     */
    @Override
    public void delete(String key, String... hashKeys) {
        redisTemplate.opsForHash().delete(key,hashKeys);
    }

    public boolean expire(String key, long seconds) {
        return redisTemplate.expire(key,seconds,TimeUnit.SECONDS);
    }

    /**
     * 删除
     * @param keys
     */
    @Override
    public void del(String... keys) {
        if (keys != null && keys.length > 0) {
            if (keys.length == 1) {
                redisTemplate.delete(keys[0]);
            } else {
                redisTemplate.delete(CollectionUtils.arrayToList(keys));
            }
        }
    }

    @Override
    public long getExpire(String key) {
        return 0;
    }
}

4.3 测试用例

代码：com.javablog.redis.demo.HashCacheServiceImplTest

package com.javablog.redis.demo;

import com.javablog.redis.demo.service.HashCacheService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.Cursor;
import org.springframework.data.redis.core.ScanOptions;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;

import java.util.*;


@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = CacheServiceApplication.class)
@WebAppConfiguration
public class HashCacheServiceImplTest {
    private final static Logger log = LoggerFactory.getLogger(HashCacheServiceImplTest.class);

    @Autowired
    private HashCacheService redisService;

    @Test
    public void testSetGetString(){
        HashMap<String, Object> map =new HashMap<String, Object>();
        map.put("appkey","343kksfsdfsdfsdf");
        map.put("pv",10l);
        map.put("appName","千锋");
        String key = "appid:1234567";

        //hmset
        redisService.hmset(key, map);

        //hmget 获取变量中的键值对。
        HashMap<Object, Object> map1 = (HashMap<Object, Object>) redisService.hmget(key);
        System.out.println("查询结果:" + map1);

        //hset  新增hashMap值
        redisService.hset(key,"addr","北京");

        //hmget 获取变量中的键值对。
        map1 = (HashMap<Object, Object>) redisService.hmget(key);
        System.out.println("查询结果:" + map1);

        //values 获取指定变量中的hashMap值。
        List<Object> hashList = redisService.values(key);
        System.out.println("通过values(H key)方法获取变量中的hashMap值:" + hashList);

        //hget 获取变量中的指定map键是否有值,如果存在该map键则获取值，没有则返回null。
        String appName = (String)redisService.hget(key,"appName");
        System.out.println("通过get(H key, Object hashKey)方法获取map键的值:" + appName);

        //hasKey 判断变量中是否有指定的map键。
        boolean hashKeyBoolean = redisService.hHasKey(key,"appName");
        System.out.println("通过hasKey(H key, Object hashKey)方法判断变量中是否存在map键:" + hashKeyBoolean);

        //key 获取变量中的键。
        Set<Object> keySet = redisService.keys(key);
        System.out.println("通过keys(H key)方法获取变量中的键:" + keySet);

        //size  获取变量的长度。
        long hashLength = redisService.size(key);
        System.out.println("通过size(H key)方法获取变量的长度:" + hashLength);

        //hincr 使变量中的键以double值的大小进行自增长。
        redisService.hincr(key, "pv" , 100l);
        Integer pv = (Integer)redisService.hget(key,"pv");
        System.out.println("查询pv:" + pv);

        //hdecr
        redisService.hdecr(key, "pv" , 100l);
        pv = (Integer)redisService.hget(key,"pv");
        System.out.println("查询减少后的pv:" + pv);

        //multiGet 以集合的方式获取变量中的值。
        List<Object> list = new ArrayList<Object>();
        list.add("pv");
        list.add("addr");
        List mapValueList = redisService.multiGet(key,list);
        System.out.println("通过multiGet(H key, Collection<HK> hashKeys)方法以集合的方式获取变量中的值:"+mapValueList);

        //putIfAbsent 如果变量值存在，在变量中可以添加不存在的的键值对，
        // 如果变量不存在，则新增一个变量，同时将键值对添加到该变量。
        redisService.putIfAbsent(key,"tel","8855222");
        map1 = (HashMap<Object, Object>) redisService.hmget(key);
        System.out.println("通过putIfAbsent(H key, HK hashKey, HV value)方法添加不存在于变量中的键值对:" + map1);

        //scan 匹配获取键值对，ScanOptions.NONE为获取全部键对，ScanOptions.scanOptions().match("map1").build()
        // 匹配获取键位map1的键值对,不能模糊匹配。
//        Cursor<Map.Entry<Object,Object>> cursor = redisService.scan(key, ScanOptions.scanOptions().match("pv").build());
        Cursor<Map.Entry<Object,Object>> cursor = redisService.scan(key,ScanOptions.NONE);
        while (cursor.hasNext()) {
            Map.Entry<Object, Object> entry = cursor.next();
            System.out.println("通过scan(H key, ScanOptions options)方法获取匹配键值对:" + entry.getKey() + "---->" + entry.getValue());
        }

        //hdel 使变量中的键以double值的大小进行自减少。
        redisService.hdel(key,"pv","addr");
        HashMap<Object, Object> map2 = (HashMap<Object, Object>) redisService.hmget(key);
        System.out.println("查询删除部分KEY后的结果:" + map2);

        //del 删除
        redisService.del(key);
        map2 = (HashMap<Object, Object>) redisService.hmget(key);
        System.out.println("查询删除缓存的结果:" + map2);
    }

}

github源码地址