Spring Boot如何整合Redis

Spring Boot是目前非常流行的Java Web开发框架，Redis是非关系型数据库的一种，以键值对的形式存储。Spring对Redis的支持是通过Spring Data Redis来实现的，给我们提供了RedisTemplate和StringRedisTemplate两种模板来操作数据。Spring Boot框架也提供了对Redis的支持，下面我们来讲一下Spring Boot框架整合Redis的步骤。

工具/材料

IntelliJ IDEA

操作方法

Spring Boot整合Redis我们需要添加依赖的jar包，spring-boot-starter-data-redis中包含spring和redis相关的jar包，jedis作为redis的客户端也需要添加到工程中，Spring Boot的版本信息在父pom中已指定，子模块中的spring相关的jar包无需另外指定。

org.springframework.boot

spring-boot-starter-data-redis

redis.clients

jedis

3.0.0-m1

Spring Boot会根据application.properties中的配置对Redis的属性进行自动配置，并注入到RedisProperties类中。在application.properties配置文件中这些属性都是以spring.redis为前缀的，值得注意的是在Spring Boot 1.5.x版本中默认的Redis客户端是jedis，因此在配置文件中无需指定，如下图所示。

Spring Boot 1.5.x版本的整合配置网上可以搜索大量的文章，然而Spring Boot 2.x版本的整合资料却非常少，甚至提供的配置不能正常使用，因此本文主要讲解Spring Boot 2.x整合Redis以及Redis的使用情况。spring-boot 2.x版本有jedis和lettuce两种客户端，因此我们必须要去指定使用哪一种客户端，两个客户端的配置如下图所示，本文使用的是Jedis客户端连接池，具体的配置如下。

# Redis数据库索引（默认为0）

spring.redis.database=0

# Redis服务器地址

spring.redis.host=127.0.0.1

# Redis服务器连接端口

spring.redis.port=6379

# Redis服务器连接密码（默认为空）

spring.redis.password=xylx1.t!@#

# 配置jedis连接池

# 连接池最大连接数（使用负值表示没有限制）

spring.redis.jedis.pool.max-active=8

# 连接池最大阻塞等待时间（使用负值表示没有限制）

spring.redis.jedis.pool.max-wait=-1ms

# 连接池中的最大空闲连接

spring.redis.jedis.pool.max-idle=8

# 连接池中的最小空闲连接

spring.redis.jedis.pool.min-idle=0

# 连接超时时间（毫秒）

spring.redis.timeout=5000ms

由配置我们可以看到spring-boot 2.x版本时间设置需要加单位ms，因为参数的类型为Duration。另外spring.redis.timeout尽量不要配置0，否则可能会出现io.lettuce.core.RedisCommandTimeoutException: Command timed out超时错误。

配置文件编辑完成后，我们开始编写代码实现Redis数据的存储和读取。我们创建一个RedisUtil工具类，该类使用@Component注解表示交由Spring管理，StringRedisTemplate是Spring提供的，可以使用@Autowired注解直接注入，接下来便可以书写存和取的代码了。

@Component

public class RedisUtil {

@Autowired

private StringRedisTemplate redisTemplate;

/**

* 存字符串

* @param key 缓存键

* @param value 缓存值

* @param expireTime过期时间(s)

*/

public void setString(String key, String value, int expireTime){

ValueOperations ops = redisTemplate.opsForValue();

if (expireTime != 0) {

ops.set(key, value, expireTime, TimeUnit.SECONDS);

} else {

ops.set(key,value);

}

}

/**

* 取字符串

* @param key 缓存键

* @return缓存值

*/

public String getString(String key){

ValueOperations ops = this.redisTemplate.opsForValue();

return ops.get(key);

}

接下来我们编写Controller层代码去调用RedisUtil工具类，实现数据的存储和读取，代码比较简单可以参考下图。若想验证Redis是否可用，还需要编写启动类，如下图所示。

由上图可看到我们编写了一个post请求用于存储字符串，get请求用于取出字符串。启动类通过main方法启动应用，接下来我们使用postman去模拟浏览器调用post和get请求，由下图可以看到Redis存储的数据成功被取出。

接下来我们介绍Jedis，这是一个封装了Redis的客户端，在Spring Boot整合Redis的基础上，可以提供更简单的API操作。因此我们需要配置JedisPool的Bean，代码如下，其中@Configuration注解表明这是一个配置类，我们在该类中注入RedisProperties，并且使用@Bean注解指定JedisPool。

@Configuration

public class RedisConfiguration {

@Autowired

private RedisProperties properties;

@Bean

public JedisPool getJedisPool(){

JedisPoolConfig config = new JedisPoolConfig();

config.setMaxIdle(properties.getJedis().getPool().getMaxIdle());

config.setMaxTotal(properties.getJedis().getPool().getMaxActive());

config.setMaxWaitMillis(properties.getJedis().getPool().getMaxWait().toMillis());

JedisPool pool = new JedisPool(config,properties.getHost(),

properties.getPort(),100,

properties.getPassword(), properties.getDatabase());

return pool;

}

}

接下来我们编辑JedisUtil工具类，通过SpringBoot容器的@Component注解来自动创建，并且注入JedisPool，使用jedisPool.getResource()方法来获取Jedis，并最终实现操作redis数据库，其代码如下。

@Component

public class JedisUtil {

@Autowired

JedisPool jedisPool;

//获取key的value值

public String get(String key) {

Jedis jedis = jedisPool.getResource();

String str = "";

try {

str = jedis.get(key);

} finally {

try {

jedis.close();

} catch (Exception e) {

e.printStackTrace();

}

}

return str;

}

public String set(String key, String value) {

Jedis jedis = jedisPool.getResource();

String str = "";

try {

str = jedis.set(key, value);

} finally {

try {

jedis.close();

} catch (Exception e) {

e.printStackTrace();

}

}

return str;

}

}

JedisUtil工具类编写完成后，我们修改之前的RedisController，并注入JedisUtil，代码如下图所示。然后再用postman分别调用post和get接口，我们可以看到成功取到了新的key的value值。

特别提示

在Spring Boot整合Redis前本机需安装Redis，另外可以使用RedisDesktopManager这个Redis这个桌面管理工具查看Redis中的数据。

springboot如何整合redis

SpringBoot整合Redis

1. 概述

随着互联网技术的发展，对技术要求也越来越高，所以在当期情况下项目的开发中对数据访问的效率也有了很高的要求，所以在项目开发中缓存技术使用的也越来越多，因为它可以极大的提高系统的访问速度，关于缓存的框架也种类繁多，比如 redis、Ehchahe、JBoss Cache、Voldemort、Cacheonix 等等，今天主要介绍的是使用现在非常流行的 NoSQL 数据库（Redis）来实现我们的缓存需求。

2. Springboot 简介

Spring Boot 是由 Pivotal 团队提供的全新框架，其设计目的是用来简化新Spring 应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。通过这种方式，Spring Boot 致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者。

主要特点：

1. 创建独立的 Spring 应用程序

2. 嵌入的 Tomcat，无需部署 WAR 文件

3. 简化 Maven 配置

4. 自动配置 Spring

5. 提供生产就绪型功能，如指标，健康检查和外部配置

6. 绝对没有代码生成和对 XML 没有要求配置

3. 简介

Redis 是一个开源（BSD 许可）的，内存中的数据结构存储系统，它可以用作数据库、缓存和消息中间件，Redis 的优势包括它的速度、支持丰富的数据类型、操作原子

性，以及它的通用性。

4. 下面就是 SpringBoot 整合 Redis 具体实现步骤

4.1在 Maven 的 pom.xml文件中加入Redis 包

org.springframework.bootspring-boot-starter-redis${boot.version}

4.2SpringBoot 配置文件中配置 Redis 连接

spring:application:name: spring-boot-redis redis:host: 192.168.12.62port: 6379timeout: 20000 pool:max-active: 8min-idle: 0max-idle: 8max-wait: -1

4.3Redis 配置类

@Configurationpublic class RedisApplication {@Beanpublic RedisTemplate redisTemplate(RedisConnectionFactory connectionFactory) {RedisTemplate template = new RedisTemplate<>();template.setConnectionFactory(connectionFactory);//使用 Jackson2JsonRedisSerializer 来序列化和反序列化 redis 的 value 值Jackson2JsonRedisSerializer serializer = new Jackson2JsonRedisSerializer(Object.class);ObjectMapper mapper = new ObjectMapper();mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);serializer.setObjectMapper(mapper);template.setValueSerializer(serializer);//使用 StringRedisSerializer 来序列化和反序列化redis 的 key 值template.setKeySerializer(new StringRedisSerializer());template.afterPropertiesSet();return template;}}

4.4Service 层应用缓存

@Servicepublic class TestService {@Autowiredprivate PersonRepo personRepo;/*** @Cacheable 应用到读取数据的方法上，先从缓存中读取，如果没有再从 DB 获取数据，然后把数据添加到缓存中* unless 表示条件表达式成立的话不放入缓存*/@Cacheable(value = "user", key = "#root.targetClass #username", unless = "#result eq null")public Person getPersonByName(String username) {Person person = personRepo.getPersonByName(username);return person;}/*** @CachePut 应用到写数据的方法上，如新增/修改方法，调用方法时会自动把相应的数据放入缓存 */@CachePut(value = "user", key = "#root.targetClass #result.username", unless = "#person eq null") public Person savePerson(Person person) { return personRepo.savePerson(person);}/*** @CacheEvict 应用到删除数据的方法上，调用方法时会从缓存中删除对应 key 的数据*/@CacheEvict(value = "user", key = "#root.targetClass #username", condition = "#result eq tr ue")public boolean removePersonByName(String username) { return personRepo.removePersonByName(username) > 0;}public boolean isExistPersonName(Person person) { return personRepo.existPersonName(person) >

4.5 数据访问资源类

@Component @Path("personMgr")public class PersonMgrResource {@Autowiredprivate PersonService personService;@GET@Path("getPersonByName")@Produces(MediaType.APPLICATION_JSON)public JsonResp getPersonByName(@QueryParam("username") String username) {Person person = personService.getPersonByName(username);return JsonResp.success(person);}@POST@Path("removePersonByName")@Produces(MediaType.APPLICATION_JSON)public JsonResp removePersonByName(@QueryParam("username") String username) {if (personService.removePersonByName(username)) {return JsonResp.success();}return JsonResp.fail("系统错误！");}@POST@Path("savePerson")@Produces(MediaType.APPLICATION_JSON)public JsonResp savePerson(Person person) {if (personService.isExistPersonName(person)) { return JsonResp.fail("用户名已存在！");}if (personService.savePerson(person).getId() > 0) { return JsonResp.success();}return JsonResp.fail("系统错误！");}}5. 通过 postman 工具来测试缓存是否生效

第一次访问查找用户：

第一次通过用户名称来查找用户可以看到是从库中查询的数据，我们可以通过RedisClient 工具来查看数据已放入了缓存。

第二次查找用户：发现服务端并未打印任何数据库查询日志，可以知道第二次查询是从缓存中查询得到的数据。

总结

本文介绍如何通过 SpringBoot 来一步步集成 Redis 缓存，关于 Redis 的使用它不仅可以用作缓存，还可以用来构建队列系统，Pub/Sub 实时消息系统，分布式系统的的计数器应用，关于 Redis 更多的介绍，请前往官网查阅。