项目总结-一-springboot整合redis

---

title: 项目总结(一)springboot整合redis
date: 2021-07-19 21:44:07
tags:

通过阅读若依开源项目的源码对springboot整合redis进行笔记整理

首先得新建一个springboot项目

一、导入依赖

<!--整合redis-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

<!--pool对象池-->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
</dependency>

二、在application.yml文件中配置redis

spring:
  #redis配置
  redis:
    #端口
    port: 6379
    #地址
    host: localhost
    #连接超时时间
    timeout: 10s
    #数据库索引
    database: 0
    #密码
    password:
    #连接池配置
    lettuce:     
      pool:
        #连接池最小空闲连接
        min-idle: 0
        #连接池最大空闲链接
        max-idle: 8
        #连接池最大数据库连接数（使用负值表示没有限制）
        max-active: 8
        #连接池最大阻塞等待时间（负值表示没有限制）
        max-wait: -1ms

三、编写redis工具类

编写工具类是为了对redisTemplate中的方法进行封装，之后方便使用。当然也可以不写此类，见后面测试

package com.heu.common.core.redis;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.BoundSetOperations;
import org.springframework.data.redis.core.HashOperations;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Component;
import java.util.*;
import java.util.concurrent.TimeUnit;

/**
 * redis工具类
 */
@Component
public class RedisCache {

    @Autowired
    private RedisTemplate redisTemplate;

    /**
     * 缓存基本对象，Integer、String、实体类等
     *
     * @param key   缓存的键值
     * @param value 缓存的值
     * @param <T>   缓存值得类型
     */
    public <T> void setCacheObject(final String key, final T value) {
        //opsForValue 对基本类型值操作
        redisTemplate.opsForValue().set(key, value);
    }

    /**
     * 缓存基本对象，Integer、String、实体类等
     *
     * @param key      缓存的键值
     * @param value    缓存的值
     * @param timeout  超时时间
     * @param timeUnit 时间颗粒度
     * @param <T>
     */
    public <T> void setCacheObject(final String key, final T value, final long timeout, final TimeUnit timeUnit) {
        redisTemplate.opsForValue().set(key, value, timeout, timeUnit);
    }

    /**
     * 设置有效时间
     *
     * @param key     缓存的键值
     * @param timeout 超时时间
     * @return true=设置成功，  false=设置失败
     */
    public boolean expire(final String key, final long timeout) {
        return expire(key, timeout, TimeUnit.SECONDS);
    }

    /**
     * 设置有效时间
     *
     * @param key      缓存的键值
     * @param timeout  超时时间
     * @param timeUnit 时间颗粒度
     * @return
     */
    public boolean expire(final String key, final long timeout, final TimeUnit timeUnit) {
        return redisTemplate.expire(key, timeout, timeUnit);
    }

    /**
     * 获取缓存的基本对象
     *
     * @param key 缓存的键值
     * @param <T> 缓存值得类型
     * @return
     */
    public <T> T getCacheObject(final String key) {
        ValueOperations<String, T> operation = redisTemplate.opsForValue();
        return operation.get(key);
    }

    /**
     * 删除单个对象
     *
     * @param key 缓存的键值
     * @return true=删除成功，  false=删除失败
     */
    public boolean deleteObject(final String key) {
        return redisTemplate.delete(key);
    }

    /**
     * 删除多个对象
     *
     * @param collection 多个对象
     * @return
     */
    public long deleteObject(final Collection collection) {
        return redisTemplate.delete(collection);
    }

    /**
     * 缓存list数据(从右插入)
     *
     * @param key      键值
     * @param dataList list数据集合
     * @param <T>
     * @return
     */
    public <T> long setCacheList(final String key, final List<T> dataList) {

        return redisTemplate.opsForList().rightPushAll(key, dataList);
    }

    /**
     * 获取所有缓存的list对象
     *
     * @param key 键值
     * @param <T>
     * @return
     */
    public <T> List<T> getCacheList(final String key) {
        return redisTemplate.opsForList().range(key, 0, -1);
    }

    /**
     * 缓存set数据
     *
     * @param key     键值
     * @param dataSet set集合
     * @param <T>
     * @return
     */
    public <T> BoundSetOperations<String, T> setCacheSet(final String key, final Set<T> dataSet) {
        BoundSetOperations<String, T> setOperations = redisTemplate.boundSetOps(key);
        Iterator<T> iterator = dataSet.iterator();
        while (iterator.hasNext()) {
            setOperations.add(iterator.next());
        }
        return setOperations;
    }

    /**
     * 获取所有缓存的set对象
     *
     * @param key 键值
     * @param <T>
     * @return
     */
    public <T> Set<T> getCacheSet(final String key) {
        return redisTemplate.opsForSet().members(key);
    }

    /**
     * 缓存hash数据
     *
     * @param key     键值
     * @param dataMap hash数据集合
     * @param <T>
     */
    public <T> void setCacheHash(final String key, final Map<String, T> dataMap) {
        if (dataMap != null) {
            redisTemplate.opsForHash().putAll(key, dataMap);
        }
    }

    /**
     * 获取所有hash数据
     *
     * @param key 键值
     * @param <T>
     * @return
     */
    public <T> Map<String, T> getCacheHash(final String key) {
        return redisTemplate.opsForHash().entries(key);
    }

    /**
     * 往hash中存值
     *
     * @param key   redis键值
     * @param hKey  map 键值
     * @param value map值
     * @param <T>
     */
    public <T> void setCacheHashValue(final String key, final String hKey, final T value) {
        redisTemplate.opsForHash().put(key, hKey, value);
    }

    /**
     * 获取hash中的值
     *
     * @param key
     * @param hKey
     * @param <T>
     * @return
     */
    public <T> T getCacheHashValue(final String key, final String hKey) {
        HashOperations<String, String, T> hashOperations = redisTemplate.opsForHash();
        return hashOperations.get(key, hKey);
    }

    /**
     *获取多个hash中的数据
     * @param key redis键值
     * @param hKeys map键值
     * @param <T>
     * @return
     */
    public <T> List<T> getMultiCacheMapValue(final String key, final Collection<Object> hKeys) {
        return redisTemplate.opsForHash().multiGet(key, hKeys);
    }

    /**
     * 获得缓存的基本对象列表
     *
     * @param pattern 字符串前缀
     * @return 对象列表
     */
    public Collection<String> keys(final String pattern)
    {
        return redisTemplate.keys(pattern);
    }

}

四、测试

1. 使用redis工具类

@RunWith(SpringRunner.class)
@SpringBootTest(classes = ManangerApplication.class)
public class ManagerTest {
    @Autowired
    private RedisCache redisCache;
    @Test
    public void redisTest(){
        redisCache.setCacheObject("name", "张三");
        String name = redisCache.getCacheObject("name");
        System.out.println(name);
    }
}

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-mVp0QaXz-1629602618599)(C:\Users\ASUS\AppData\Roaming\Typora\typora-user-images\image-20210719220523451.png)]

2. 不使用redis工具类

@RunWith(SpringRunner.class)
@SpringBootTest(classes = ManangerApplication.class)
public class ManagerTest {
    @Autowired
    private RedisTemplate redisTemplate;
    @Test
    public void redisTest2(){
        redisTemplate.opsForValue().set("name", "张三");
        String name = (String) redisTemplate.opsForValue().get("name");
        System.out.println(name);
    }
}