一、简介

补习系列(A3)-springboot redis 与发布订阅 一文中,我们介绍了使用 Redis 实现消息订阅发布的机制,并且给出了一个真实用例。

然而,绝大多数场景下 Redis 是作为缓存被使用的(这是其主要优势)。除此之外,由于Redis 提供了 AOF以及RDB两种持久化机制,某些情况下也可以作为临时数据库使用。

本次将介绍 SpringBoot 中如何使用 Redis 进行缓存读写。

Redis 的基本命令

在学习之前,需要先了解一些Redis 的基本命令,可以参考这里

http://www.redis.cn/

二、SpringBoot Redis 读写

A. 引入 spring-data-redis

添加依赖

 <!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
<version>${spring-boot.version}</version>
</dependency>

spring-boot-starter-redis在1.4版本已经废弃

配置redis连接

application.properties

# redis 连接配置
spring.redis.database=0
spring.redis.host=127.0.0.1
spring.redis.password=
spring.redis.port=6379
spring.redis.ssl=false # 连接池最大数
spring.redis.pool.max-active=10
# 空闲连接最大数
spring.redis.pool.max-idle=10
# 获取连接最大等待时间(s)
spring.redis.pool.max-wait=600000

B. 序列化

同样,我们需要指定 JSON作为 Key/HashKey/Value的主要方式:

    /**
* 序列化定制
*
* @return
*/
@Bean
public Jackson2JsonRedisSerializer<Object> jackson2JsonSerializer() {
Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(
Object.class); // 初始化objectmapper
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_NULL);
mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(mapper);
return jackson2JsonRedisSerializer;
} /**
* 操作模板
*
* @param connectionFactory
* @param jackson2JsonRedisSerializer
* @return
*/
@Bean
public RedisTemplate<String, Object> redisTemplate(JedisConnectionFactory connectionFactory,
Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer) { RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
template.setConnectionFactory(connectionFactory); // 设置key/hashkey序列化
RedisSerializer<String> stringSerializer = new StringRedisSerializer();
template.setKeySerializer(stringSerializer);
template.setHashKeySerializer(stringSerializer); // 设置值序列化
template.setValueSerializer(jackson2JsonRedisSerializer);
template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet(); // template.setValueSerializer(new
// GenericToStringSerializer<Object>(Object.class));
return template;
}

Jackson2JsonRedisSerializer是Jackson转换的桥接器;

RedisTemplate是用于读写的主要操作类;

C. 读写样例

首先定义一个Pet实体类

public class RedisPet {

    private String name;
private String type;
... ignore get set

利用RedisTemplate封装一层Repository,如下:

    @Repository
public static class PetRepository { private static final String KEY = "Pets"; @Autowired
private RedisTemplate<String, Object> redisTemplate;
private HashOperations<String, String, Object> hashOperations; @PostConstruct
private void init() {
hashOperations = redisTemplate.opsForHash();
} public void add(RedisPet pet) {
hashOperations.put(KEY, pet.getName(), pet);
} public RedisPet find(String name) {
return (RedisPet) hashOperations.get(KEY, name);
} public Map<String, Object> findAll() {
return hashOperations.entries(KEY);
} public void clear() {
hashOperations.getOperations().delete(KEY);
}
}

在**PetRepository **的实现中,我们利用Hash结构来存储 Pet信息(Pet.name是key)

分别实现了添加(add)/查找(get)/清除(clear)等方法。

最后,实现读写调用:


@Service
public class RedisDataOperation { private static final Logger logger = LoggerFactory.getLogger(RedisDataOperation.class); @Autowired
private PetRepository petRepo; @PostConstruct
public void start() { RedisPet pet1 = new RedisPet("Polly", "Bird");
RedisPet pet2 = new RedisPet("Tom", "Cat"); //写入宠物信息
petRepo.add(pet1);
petRepo.add(pet2); //打印宠物信息
logger.info("polly {}", JsonUtil.toJson(petRepo.find("Polly")));
logger.info("pets {}", JsonUtil.toJson(petRepo.findAll())); //清空
petRepo.clear();
}

上面的代码在应用启动时,会写入两个Pet信息,之后完成清理,控制台输出如下:

RedisDataOperation : polly {"name":"Polly","type":"Bird"}
RedisDataOperation : pets {"Tom":{"name":"Tom","type":"Cat"},"Polly":{"name":"Polly","type":"Bird"}}

三、方法级缓存

除了上面的RedisTemplate,spring-data-redis还提供了方法级缓存,

就是将业务方法的执行结果缓存起来,后面再次调用直接从缓存中取得结果返回。

这种方式可以简化缓存逻辑的代码,比如配置类数据的读取,通过方法注解就可以实现,

下面是一个样例:

/**
* 方法级缓存样例
*
* @author atp
*
*/
@Service
public class RedisCacheOperation { private static final Logger logger = LoggerFactory.getLogger(RedisCacheOperation.class); public static final String PREFIX = "pets:";
public static final String WRAP_PREFIX = "'pets:'"; /**
* 当结果不为空时缓存
*
* @param name
* @return
*/
@Cacheable(value = "petCache", key = WRAP_PREFIX + "+#name", unless = "#result==null")
public RedisPet getPet(String name) {
logger.info("get pet {}", name);
return new RedisPet(name, "Bird");
} /**
* 当结果不为空时淘汰缓存
*
* @param pet
* @return
*/
@CacheEvict(value = "petCache", key = WRAP_PREFIX + "+#pet.name", condition = "#result!=null")
public RedisPet updatePet(RedisPet pet) {
logger.info("update pet {}", pet.getName());
return new RedisPet(pet.getName(), "Bird1");
} /**
* 当结果为true时淘汰缓存
*
* @param name
* @return
*/
@CacheEvict(value = "petCache", key = WRAP_PREFIX + "+#name", condition = "#result==true")
public boolean deletePet(String name) {
logger.info("delete pet {}", name);
return true;
}
}

涉及到几个注解:

注解 说明
@Cachable 方法执行结果缓存
@CachePut 方法执行结果缓存(强制)
@CacheEvict 方法执行时触发删除

其中 @CachePut@Cachable 的区别在于,前者一定会执行方法,并尝试刷新缓存(条件满足),

而后者则是当缓存中不存在时才会执行方法并更新。

注解中的属性 key/condition 都支持通过 Spring EL 表达式来引用参数对象。

启用注解

除了上面的代码,我们还需要使用 @EnableCaching 启用注解:

@EnableCaching
@Configuration
public class RedisConfig { private static final Logger logger = LoggerFactory.getLogger(RedisConfig.class); /**
* 缓存管理,支持方法级注解
*
* @param template
* @return
*/
@Bean
public RedisCacheManager cacheManager(RedisTemplate<String, Object> template) {
RedisCacheManager redisCacheManager = new RedisCacheManager(template);
// 默认过期时间
redisCacheManager.setDefaultExpiration(30 * 60 * 1000);
return redisCacheManager;
}

当@Cacheable 的key属性为空时,框架会自动生成,格式类似:

param1,param2,param3...

如果希望修改默认的行为,可以使用自定义的 KeyGenerator

    /**
* 定制方法缓存的key生成策略
*
* @return
*/
@Bean
public KeyGenerator keyGenerator() {
return new KeyGenerator() {
@Override
public Object generate(Object target, Method method, Object... args) {
StringBuilder sb = new StringBuilder();
sb.append(target.getClass().getName());
sb.append(method.getName()); for (Object arg : args) {
sb.append(arg.toString());
}
return sb.toString();
}
};
}

单元测试

使用一小段单元测试代码来测试方法级缓存功能

@RunWith(SpringRunner.class)
@SpringBootTest(classes =BootSampleRedis.class)
public class RedisCacheOperationTest { private static final Logger logger = LoggerFactory.getLogger(RedisCacheOperationTest.class); @Autowired
private RedisTemplate<String, Object> redisTemplate; @Autowired
private RedisCacheOperation operation; private RedisPet pet1 = new RedisPet("Polly", "Bird"); @Test
public void testGet() {
operation.getPet(pet1.getName()); Object object = redisTemplate.opsForValue().get(RedisCacheOperation.PREFIX + pet1.getName());
logger.info(String.valueOf(object)); assertNotNull(object);
} @Test
public void testUpdate() {
operation.updatePet(pet1); Object object = redisTemplate.opsForValue().get(RedisCacheOperation.PREFIX + pet1.getName());
logger.info(String.valueOf(object)); assertNull(object);
} @Test
public void testDelete() {
operation.getPet(pet1.getName()); // delete cache
operation.deletePet(pet1.getName()); Object object = redisTemplate.opsForValue().get(RedisCacheOperation.PREFIX + pet1.getName());
logger.info(String.valueOf(object)); assertNull(object);
} }

四、连接池

如果希望通过代码来配置 Jedis 的连接池(熟悉的方式),可以声明 JedisConnectionFactory 实现:

    /**
* 连接池配置
*
* @return
*/
@Bean
public JedisConnectionFactory jedisConnectionFactory() {
JedisPoolConfig config = new JedisPoolConfig(); // 最大连接
config.setMaxTotal(10);
// 最大空闲,与最大连接保持一致,可减少频繁键链的开销
config.setMaxIdle(10);
// 连接最大空闲时间
config.setMinEvictableIdleTimeMillis(10 * 60 * 1000);
// 获取连接等待的最大时长
config.setMaxWaitMillis(30000); // 进行空闲连接检测的时间间隔
config.setTimeBetweenEvictionRunsMillis(30 * 1000);
// 取消不必要的test,有利于性能提升
config.setTestOnBorrow(false);![](https://img2018.cnblogs.com/blog/242916/201812/242916-20181206231048870-1133770725.png) config.setTestOnReturn(false); JedisConnectionFactory factory = new JedisConnectionFactory(config);
factory.setHostName("127.0.0.1");
factory.setPort(6379); logger.info("redis config init first");
return factory;
}

更多配置可参考这里

示例代码可从 码云gitee 下载。

https://gitee.com/littleatp/springboot-samples/

小结

Redis 在大多数项目中的核心用途是缓存,spring-data-redis 为 SpringBoot 中集成 Redis 读写的封装。

除了 RedisTemplate之外,还实现了方法级的缓存注解,一定程度上简化了业务的使用。

Redis 在分布式系统中的应用场景有很多,后续有机会将进行更多的探讨。

欢迎继续关注"美码师的补习系列-springboot篇" ,期待更多精彩内容-

补习系列(14)-springboot redis 整合-数据读写的更多相关文章

  1. 补习系列(13)-springboot redis 与发布订阅

    目录 一.订阅发布 常见应用 二.Redis 与订阅发布 三.SpringBoot 与订阅发布 A. 消息模型 B. 序列化 C. 发布消息 D. 接收消息 小结 一.订阅发布 订阅发布是一种常见的设 ...

  2. 补习系列(15)-springboot 分布式会话原理

    目录 一.背景 二.SpringBoot 分布式会话 三.样例程序 四.原理进阶 A. 序列化 B. 会话代理 C. 数据老化 小结 一.背景 在 补习系列(3)-springboot 几种scope ...

  3. SpringBoot+Redis整合

    SpringBoot+Redis整合 1.在pom.xml添加Redis依赖 <!--整合Redis--> <dependency> <groupId>org.sp ...

  4. 补习系列(6)- springboot 整合 shiro 一指禅

    目标 了解ApacheShiro是什么,能做什么: 通过QuickStart 代码领会 Shiro的关键概念: 能基于SpringBoot 整合Shiro 实现URL安全访问: 掌握基于注解的方法,以 ...

  5. 补习系列(19)-springboot JPA + PostGreSQL

    目录 SpringBoot 整合 PostGreSQL 一.PostGreSQL简介 二.关于 SpringDataJPA 三.整合 PostGreSQL A. 依赖包 B. 配置文件 C. 模型定义 ...

  6. 补习系列(16)-springboot mongodb 数据库应用技巧

    目录 一.关于 MongoDB 二.Spring-Data-Mongo 三.整合 MongoDB CRUD A. 引入框架 B. 数据库配置 C. 数据模型 D. 数据操作 E. 自定义操作 四.高级 ...

  7. 补习系列(2)-springboot mime类型处理

    目标 了解http常见的mime类型定义: 如何使用springboot 处理json请求及响应: 如何使用springboot 处理 xml请求及响应: http参数的获取及文件上传下载: 如何获得 ...

  8. 补习系列(17)-springboot mongodb 内嵌数据库

    目录 简介 一.使用 flapdoodle.embed.mongo A. 引入依赖 B. 准备测试类 C. 完善配置 D. 启动测试 细节 二.使用Fongo A. 引入框架 B. 准备测试类 C.业 ...

  9. 补习系列(3)-springboot中的几种scope

    目标 了解HTTP 请求/响应头及常见的属性: 了解如何使用SpringBoot处理头信息 : 了解如何使用SpringBoot处理Cookie : 学会如何对 Session 进行读写: 了解如何在 ...

随机推荐

  1. 【bzoj 2303】【Apio2011】方格染色

    题目: http://www.lydsy.com/JudgeOnline/problem.php?id=2303 题解: 很神奇的思路,膜一发大佬http://www.cnblogs.com/HHsh ...

  2. [HAOI2008]移动玩具 状压

    发现自己只会打状压了. 233333 不需要考虑是否会被挡,所以直接dp #include<cstdio> #include<cstring> #include<iost ...

  3. Java线程同步锁

    把synchronized当作函数修饰符时,示例代码如下: Public synchronized void method(){ //-. } 这也就是同步方法,那这时synchronized锁定的是 ...

  4. show()封装没有想象中那么简单

    <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...

  5. eclipse部署项目到tomcat

    以管理员身份运行Eclipse 1.移除 2.open 3.改成这样,然后ctrl+s保存 4.重新运行即可.    

  6. 基于Mycat实现读写分离

    随着应用的访问量并发量的增加,应用读写分离是很有必要的.当然应用要实现读写分离,首先数据库层要先做到主从配置,本人前一篇文章介绍了mysql数据库的主从配置方式即:<mysql数据库主从配置&g ...

  7. ceph 常见问题百科全书---luminous安装部署篇

    1. 执行步骤:ceph-deploy new node        机器:centos 7.5   ceph  Luminous版本     源:阿里云 问题: Traceback (most r ...

  8. WebP 在减少图片体积和流量上的效果如何?MIP技术实践分享

    作者 | Jackson 编辑 | 尾尾 不论是 PC 还是移动端,图片一直占据着页面流量的大头,在图片的大小和质量之间如何权衡,成为了长期困扰开发者们的问题.而 WebP 技术的出现,为解决该问题提 ...

  9. SpringBoot之旅第四篇-web开发

    一.引言 有了自动配置,springboot使web开发变得简单,这个在springboot之旅中的第一篇中就有体现,实际的开发中当然不会这么简单,很多时候我们都需要自己去定制一些东西.web开发的东 ...

  10. DES加解密

    package encrypt; import java.security.Key; import java.security.SecureRandom; import java.util.Base6 ...