齐活！Spring工程整合Redis实战汇总
更新太慢了，最近工作也多，写这个也蛮耗时间的，继续咱redis专题，前面讲了redis的单机部署和redis的基础命令实战，说实话命令太多了，记住常用的就好，用到复杂的查一下也就会用了，更多的是理解其中的原理和解决咱实际的业务需求，脱离需求空谈技术都是不现实的，因此本篇就谈一下在实际开发中如何使用redis，通过springboot工程整合redis，实现对redis的灵活运用。
背景
前两篇总结了redis的命令操作，这篇开始在项目工程中整合redis，首先说明一下普通的maven项目或者是传统spring项目如何使用redis，然后介绍springboot如何整合redis，并给出比较常用的redis整合API工具类。
其实我们使用redis的场景无非就是当做缓存，在分布式的时候可以做分布式锁，其实它还可以实现消息中间件的发布订阅功能。在做缓存时，我们一般都是将一些数据量比较大且不频繁更新的数据，存入缓存里，避免数据库的IO操作，适用于读多写少的场景，还有就是像一些对一致性要求不严格的数据，比如商品列表数据等，同时对存入的数据进行时间设置，保障缓存数据与数据库数据的一致性。这里就不得不提一下在实际业务场景中大名鼎鼎的“延迟双删”策略。一讲就讲多了，这里咱先说一下如何整合redis，整合完咱就讲一下延迟双删到底是个啥。
SSM整合Redis
SSM项目整合Redis实战，这里我就不介绍SSM工程怎么搭建了，老生常谈，首先SSM工程要满足MVC结构，然后创建spring-config.xml（applicationContext.xml）配置文件、jdbc.properties（数据源）配置文件、mybatis-config.xml（mybatis配置类）配置文件、spring-mvc.xml（springMVC前端控制器配置类）配置文件、web.xml（web项目配置类）配置文件，足见得SSM工程是不是太麻烦了，还得写业务逻辑层，引入pom.xml依赖包等等，SSM项目现在用的不多了，搭建和维护起来还是很麻烦的。工程目录如下所示：
言归正传，使用Redis少不了操作Redis的客户端工具，这里我们采用Jedis。Jedis是java开发的操作redis的工具包，是Java语言开发的Redis客户端工具包，用于Java语言与Redis数据进行交互。
主要步骤如下：
1、添加 Jedis 的依赖：在项目的构建文件（如 Maven 的 pom.xml）中，添加 Jedis 的依赖项和redis的依赖项，以便在项目中引入 Jedis 库。
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.8.1</version>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-redis</artifactId>
<version>1.7.5.RELEASE</version>
</dependency>2、配置 Redis 服务器连接信息：在 Spring 的配置文件applicationContext-redis.xml中，配置 Redis 服务器的连接信息，如主机名、端口号等。这些信息将用于建立与 Redis 服务器的连接。
#[REDIS]
#######开发环境#######
#redis服务器地址(需自己根据实际情况设置)
redis.master.ip=xxx
redis.master.port=6379
redis.master.password=xxxx
# JEDIS_BorrowPool:maxActive
redis.pool.maxActive=1024
# JEDIS_BorrowPool:maxIdle
redis.pool.maxIdle=200
# JEDIS_BorrowPool:maxTotal
redis.pool.maxTotal=200
# JEDIS_BorrowPool:maxWaitMillis
redis.pool.maxWaitMillis=7200
# JEDIS_BorrowPool:testOnBorrow
redis.pool.testOnBorrow=false
# JEDIS_BorrowPool:testOnReturn
redis.pool.testOnReturn=false
# JEDIS_Connection:timeout
redis.master.timeout=10000<context:property-placeholder location="classpath:redis.properties"/>
<!-- redis服务器中心 -->
<bean id="connectionFactory"
class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
<property name="poolConfig" ref="poolConfig"/>
<property name="port" value="${redis.master.port}"/>
<property name="hostName" value="${redis.master.ip}"/>
<property name="password" value="${redis.master.password}"/>
<property name="timeout" value="${redis.master.timeout}"/>
</bean>3、创建 Jedis 连接池：Redis在流水线技术下能够支持每秒十万次的操作，对于系统的性能有显著的提升，其实在一般的配置使用中会采用连接池的方式管理它。Jedis提供了连接池JedisPool用来创建Redis连接池对象，使用连接池需要使用JedisPoolConfig对链接池进行配置，通过配置 Jedis 连接池，我们可以重用连接对象，减少资源消耗和性能开销。
<!-- redis数据源 -->
<bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig">
<!-- 最大空闲数 -->
<property name="maxIdle" value="${redis.pool.maxIdle}"/>
<!-- 最大空连接数 -->
<property name="maxTotal" value="${redis.pool.maxTotal}"/>
<!-- 最大等待时间 -->
<property name="maxWaitMillis" value="${redis.pool.maxWaitMillis}"/>
<!-- 返回连接时，检测连接是否成功 -->
<property name="testOnBorrow" value="${redis.pool.testOnBorrow}"/>
<!-- 返回数据时，检测连接是否成功 -->
<property name="testOnReturn" value="${redis.pool.testOnReturn}"/>
</bean>
<!-- redis操作模板，面向对象的模板 -->
<bean id="redisTemplate" class="org.springframework.data.redis.core.StringRedisTemplate">
<property name="connectionFactory" ref="connectionFactory"/>
<!-- 如果不配置Serializer，那么存储的时候只能使用String，如果用对象类型存储，那么会提示错误 -->
<property name="keySerializer">
<bean class="org.springframework.data.redis.serializer.StringRedisSerializer"/>
</property>
<property name="valueSerializer">
<bean class="org.springframework.data.redis.serializer.JdkSerializationRedisSerializer"/>
</property>
<property name="enableTransactionSupport" value="true"/>
</bean>4、使用 Jedis 执行 Redis 操作：在应用程序中，通过获取 Jedis 连接对象，我们可以使用 Jedis 提供的 API 执行各种 Redis 操作，如设置键值对、获取数据、发布订阅等。
@Controller
@RequestMapping("/redis/")
public class RedisDemoController {
@Autowired
RedisUtils redisUtils;
// 查询数据
@GetMapping("list")
public String list() {
String re = redisUtils.hget("student", "test");
System.out.println(re);
return "success";
}
// 添加数据
@GetMapping("add")
public String add() {
redisUtils.hset("student", "test", "小明");
return "success";
}以上就是SSM项目整合Redis实战操作，接下来看一下SpringBoot如何整合Redis实现数据的存储和查询。
SpringBoot整合Redis
首先还是引入redis和jedis的坐标依赖，这里的依赖和SSM有所不同，因为SpringBoot是“约定大于配置”的，它已经帮咱约定好了一些中间件依赖的版本，这里只需直接引入即可。前面咱引入的是spring-data-redis坐标，版本为1.7.5，采用Jedis作为Redis客户端驱动，我这里使用的SpringBoot版本为2.7.5，引入如下坐标，其内部采用lettuce作为客户端驱动。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>${jedis.version}</version>
</dependency>配置application.xml文件
spring:
redis:
host: xxxxxx
port: 6379
database: 3
password: xxxxxx
#连接超时时间
timeout: 50000配置好之后就可以使用了，超级方便，诚然有人会问，那我想设置jedis链接池，redis的cache，最大连接数啥的在哪里设置呢？看下图：
在Spring Boot中，Jedis的配置通常通过application.properties或application.yml文件进行。可能没有显式地看到Jedis的配置，是因为Spring Boot的自动配置特性在起作用。
当你在Spring Boot项目的依赖中添加Jedis后，并且在application.properties或application.yml文件中提供了Redis服务器的连接信息，Spring Boot会自动配置Jedis连接池。进入到RedisProperties类中，能够发现一些定义好的Redis配置。
private int database = 0;
private String url;
private String host = "localhost";
private String username;
private String password;
private int port = 6379;
...
...
public static class Jedis {
private final Pool pool = new Pool();
public Jedis() {
}
public Pool getPool() {
return this.pool;
}
}
...
...
public static class Pool {
private Boolean enabled;
private int maxIdle = 8;
private int minIdle = 0;
private int maxActive = 8;
private Duration maxWait = Duration.ofMillis(-1L);
private Duration timeBetweenEvictionRuns;
public Pool() {
}
SpringBoot默认配置的Jedis连接池大小是8，如果不需要特殊定制Jedis连接池的配置，那么Spring Boot的自动配置应该已经足够满足大多数使用情况。如果想要修改可以直接在application.yml中增加就可以。如下图所示：
那为啥在配置文件中修改值，就可以替换实体类中的配置信息了呢？是因为RedisProperties.class类中设置了如下代码，默认读取一下配置开头的redis信息，然后通过调用属性的Setter方法注入属性值。
@ConfigurationProperties(
prefix = "spring.redis"
)RedisConfig配置类
/**
* Redis配置
* 关注公众号【可为编程】回复【面试】领取年度最新面试题大全!!!
* @author zjc 2692369712@qq.com
*/
@Configuration
public class RedisConfig {
@Resource
private RedisConnectionFactory factory;
@Bean
public Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer() {
Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
return jackson2JsonRedisSerializer;
}
@Bean
public RedisTemplate<String, Object> redisTemplate() {
RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
redisTemplate.setKeySerializer(new StringRedisSerializer());
redisTemplate.setValueSerializer(jackson2JsonRedisSerializer());
redisTemplate.setHashKeySerializer(new StringRedisSerializer());
redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer());
redisTemplate.setConnectionFactory(factory);
return redisTemplate;
}
}RedisUtils工具类
import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import javax.annotation.Resource;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
/**
* @author 可为编程
* @description: 基于spring和redis的redisTemplate工具类
* 针对所有的hash 都是以h开头的方法
* 针对所有的Set 都是以s开头的方法 不含通用方法
* 针对所有的List 都是以l开头的方法
* @date 2023/11/23 10:52
*/
@Component
@Slf4j
public class RedisUtil {
@Resource
private RedisTemplate<String, Object> redisTemplate;
// =============================1-common============================
/**
* 指定缓存失效时间
*
* @param key 键
* @param time 时间(秒)
* @return
*/
public boolean expire(String key, long time) {
try {
if (time > 0) {
redisTemplate.expire(key, time, TimeUnit.SECONDS);
}
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 根据key 获取过期时间
*
* @param key 键 不能为null
* @return 时间(秒) 返回0代表为永久有效
*/
public long getExpire(String key) {
return redisTemplate.getExpire(key, TimeUnit.SECONDS);
}
关注公众号【可为编程】回复【面试】领取年度最新面试题大全!!!
/**
* 判断key是否存在
*
* @param key 键
* @return true 存在 false不存在
*/
public boolean hasKey(String key) {
try {
return redisTemplate.hasKey(key);
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 删除缓存
*
* @param key 可以传一个值 或多个
*/
@SuppressWarnings("unchecked")
public void del(String... key) {
if (key != null && key.length > 0) {
if (key.length == 1) {
redisTemplate.delete(key[0]);
} else {
redisTemplate.delete(CollectionUtils.arrayToList(key));
}
}
}
// ============================2-String=============================
/**
* 普通缓存获取
*
* @param key 键
* @return 值
*/
public Object get(String key) {
return key == null ? null : redisTemplate.opsForValue().get(key);
}
//获取java对象类型
public <T> T getBean(String key, Class<T> tClass) {
String string = (String) redisTemplate.opsForValue().get(key);
JSONObject jsonObject = JSONObject.parseObject(string);
return JSONObject.toJavaObject(jsonObject, tClass);
}
/**
* 普通缓存放入
*
* @param key 键
* @param value 值
* @return true成功 false失败
*/
public boolean set(String key, Object value) {
try {
redisTemplate.opsForValue().set(key, value);
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 普通缓存放入并设置时间
*
* @param key 键
* @param value 值
* @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期
* @return true成功 false 失败
*/
public boolean set(String key, Object value, long time) {
try {
if (time > 0) {
redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
} else {
set(key, value);
}
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 递增 适用场景： https://blog.csdn.net/y_y_y_k_k_k_k/article/details/79218254 高并发生成订单号，秒杀类的业务逻辑等。。
*
* @param key 键
* @param delta 要增加几(大于0)
* @return
*/
public long incr(String key, long delta) {
if (delta < 0) {
throw new RuntimeException("递增因子必须大于0");
}
return redisTemplate.opsForValue().increment(key, delta);
}
/**
* 递减
*
* @param key 键
* @param delta 要减少几(小于0)
* @return
*/
public long decr(String key, long delta) {
if (delta < 0) {
throw new RuntimeException("递减因子必须大于0");
}
return redisTemplate.opsForValue().increment(key, -delta);
}
// ================================3-Map=================================
/**
* HashGet
*
* @param key 键 不能为null
* @param item 项 不能为null
* @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);
}
/**
* HashSet
*
* @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) {
log.error(key, e);
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) {
log.error(key, e);
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) {
log.error(key, e);
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) {
log.error(key, e);
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 double hincr(String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, by);
}
/**
* hash递减
*
* @param key 键
* @param item 项
* @param by 要减少记(小于0)
* @return
*/
public double hdecr(String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, -by);
}
// ============================4-set=============================
/**
* 根据key获取Set中的所有值
*
* @param key 键
* @return
*/
public Set<Object> sGet(String key) {
try {
return redisTemplate.opsForSet().members(key);
} catch (Exception e) {
log.error(key, e);
return null;
}
}
/**
* 根据value从一个set中查询,是否存在
*
* @param key 键
* @param value 值
* @return true 存在 false不存在
*/
public boolean sHasKey(String key, Object value) {
try {
return redisTemplate.opsForSet().isMember(key, value);
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 将数据放入set缓存
*
* @param key 键
* @param values 值 可以是多个
* @return 成功个数
*/
public long sSet(String key, Object... values) {
try {
return redisTemplate.opsForSet().add(key, values);
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
/**
* 将set数据放入缓存
*
* @param key 键
* @param time 时间(秒)
* @param values 值 可以是多个
* @return 成功个数
*/
public long sSetAndTime(String key, long time, Object... values) {
try {
Long count = redisTemplate.opsForSet().add(key, values);
if (time > 0)
expire(key, time);
return count;
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
/**
* 获取set缓存的长度
*
* @param key 键
* @return
*/
public long sGetSetSize(String key) {
try {
return redisTemplate.opsForSet().size(key);
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
/**
* 移除值为value的
*
* @param key 键
* @param values 值 可以是多个
* @return 移除的个数
*/
public long setRemove(String key, Object... values) {
try {
Long count = redisTemplate.opsForSet().remove(key, values);
return count;
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
// ============================5-zset=============================
/**
* 根据key获取Set中的所有值
*
* @param key 键
* @return
*/
public Set<Object> zSGet(String key) {
try {
return redisTemplate.opsForSet().members(key);
} catch (Exception e) {
log.error(key, e);
return null;
}
}
/**
* 根据value从一个set中查询,是否存在
*
* @param key 键
* @param value 值
* @return true 存在 false不存在
*/
public boolean zSHasKey(String key, Object value) {
try {
return redisTemplate.opsForSet().isMember(key, value);
} catch (Exception e) {
log.error(key, e);
return false;
}
}
public Boolean zSSet(String key, Object value, double score) {
try {
return redisTemplate.opsForZSet().add(key, value, 2);
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 将set数据放入缓存
*
* @param key 键
* @param time 时间(秒)
* @param values 值 可以是多个
* @return 成功个数
*/
public long zSSetAndTime(String key, long time, Object... values) {
try {
Long count = redisTemplate.opsForSet().add(key, values);
if (time > 0)
expire(key, time);
return count;
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
/**
* 获取set缓存的长度
*
* @param key 键
* @return
*/
public long zSGetSetSize(String key) {
try {
return redisTemplate.opsForSet().size(key);
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
/**
* 移除值为value的
*
* @param key 键
* @param values 值 可以是多个
* @return 移除的个数
*/
public long zSetRemove(String key, Object... values) {
try {
Long count = redisTemplate.opsForSet().remove(key, values);
return count;
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
// ===============================6-list=================================
/**
* 获取list缓存的内容
*
* @param key 键
* @param start 开始 0 是第一个元素
* @param end 结束 -1代表所有值
* @return
* @取出来的元素 总数 end-start+1
*/
public List<Object> lGet(String key, long start, long end) {
try {
return redisTemplate.opsForList().range(key, start, end);
} catch (Exception e) {
log.error(key, e);
return null;
}
}
/**
* 获取list缓存的长度
*
* @param key 键
* @return
*/
public long lGetListSize(String key) {
try {
return redisTemplate.opsForList().size(key);
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
/**
* 通过索引 获取list中的值
*
* @param key 键
* @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
* @return
*/
public Object lGetIndex(String key, long index) {
try {
return redisTemplate.opsForList().index(key, index);
} catch (Exception e) {
log.error(key, e);
return null;
}
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @return
*/
public boolean lSet(String key, Object value) {
try {
redisTemplate.opsForList().rightPush(key, value);
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @param time 时间(秒)
* @return
*/
public boolean lSet(String key, Object value, long time) {
try {
redisTemplate.opsForList().rightPush(key, value);
if (time > 0)
expire(key, time);
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @return
*/
public boolean lSet(String key, List<Object> value) {
try {
redisTemplate.opsForList().rightPushAll(key, value);
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
* @param time 时间(秒)
* @return
*/
public boolean lSet(String key, List<Object> value, long time) {
try {
redisTemplate.opsForList().rightPushAll(key, value);
if (time > 0)
expire(key, time);
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 根据索引修改list中的某条数据
*
* @param key 键
* @param index 索引
* @param value 值
* @return
*/
public boolean lUpdateIndex(String key, long index, Object value) {
try {
redisTemplate.opsForList().set(key, index, value);
return true;
} catch (Exception e) {
log.error(key, e);
return false;
}
}
/**
* 移除N个值为value
*
* @param key 键
* @param count 移除多少个
* @param value 值
* @return 移除的个数
*/
public long lRemove(String key, long count, Object value) {
try {
Long remove = redisTemplate.opsForList().remove(key, count, value);
return remove;
} catch (Exception e) {
log.error(key, e);
return 0;
}
}
}
SpringCloud就是将配置换了一个地方，交给配置中心nacos去维护，其实本质上还是属于SpringBoot方式进行配置。
总结
后面会通过介绍Redis缓存的三种常见问题，通过缓存的常见问题逐步走向redis缓存和数据库的数据一致性问题，欢迎大家对缓存的常见问题和场景进行留言评论。
本文参与 腾讯云自媒体分享计划，分享自微信公众号。
原始发表：2023-11-23，如有侵权请联系 cloudcommunity@tencent.com 删除
评论
登录后参与评论
推荐阅读
相关产品与服务
云数据库 Redis
腾讯云数据库 Redis（TencentDB for Redis）是腾讯云打造的兼容 Redis 协议的缓存和存储服务。丰富的数据结构能帮助您完成不同类型的业务场景开发。支持主从热备，提供自动容灾切换、数据备份、故障迁移、实例监控、在线扩容、数据回档等全套的数据库服务。