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包无需另外指定。

<dependency>
<groupId>orgspringframeworkboot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>redisclients</groupId>
<artifactId>jedis</artifactId>
<version>300-m1</version>
</dependency>

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

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

# Redis数据库索引（默认为0）
springredisdatabase=0
# Redis服务器地址
springredishost=127001

# Redis服务器连接端口
springredisport=6379
# Redis服务器连接密码（默认为空）
springredispassword=xylx1t!@#
# 配置jedis连接池
# 连接池最大连接数（使用负值表示没有限制）
springredisjedispoolmax-active=8
# 连接池最大阻塞等待时间（使用负值表示没有限制）
springredisjedispoolmax-wait=-1ms
# 连接池中的最大空闲连接
springredisjedispoolmax-idle=8
# 连接池中的最小空闲连接
springredisjedispoolmin-idle=0
# 连接超时时间（毫秒）
springredistimeout=5000ms
由配置我们可以看到spring-boot 2x版本时间设置需要加单位ms，因为参数的类型为Duration。另外springredistimeout尽量不要配置0，否则可能会出现iolettucecoreRedisCommandTimeoutException: 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<String, String> ops = redisTemplateopsForValue();
if (expireTime != 0) {
opsset(key, value, expireTime, TimeUnitSECONDS);
} else {
opsset(key,value);
}
}

/
取字符串
@param key 缓存键
@return缓存值
/
public String getString(String key){
ValueOperations<String, String> ops = thisredisTemplateopsForValue();
return opsget(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();
configsetMaxIdle(propertiesgetJedis()getPool()getMaxIdle());
configsetMaxTotal(propertiesgetJedis()getPool()getMaxActive());
configsetMaxWaitMillis(propertiesgetJedis()getPool()getMaxWait()toMillis());
JedisPool pool = new JedisPool(config,propertiesgetHost(),
propertiesgetPort(),100,
propertiesgetPassword(), propertiesgetDatabase());
return pool;
}
}

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

@Component
public class JedisUtil {

@Autowired
JedisPool jedisPool;

//获取key的value值
public String get(String key) {
Jedis jedis = jedisPoolgetResource();
String str = "";
try {
str = jedisget(key);
} finally {
try {
jedisclose();
} catch (Exception e) {
eprintStackTrace();
}
}
return str;
}

public String set(String key, String value) {
Jedis jedis = jedisPoolgetResource();
String str = "";
try {
str = jedisset(key, value);
} finally {
try {
jedisclose();
} catch (Exception e) {
eprintStackTrace();
}
}
return str;
}

}

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

特别提示

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

Java连接redis的使用示例
Redis是开源的key-value存储工具，redis通常用来存储结构化的数据，因为redis的key可以包含String、hash、listset和sorted
list。
Redisclient支持多种语言，包括：c、C++、C#、php、java、python、go等语言，根据自己的开发语言，选择合适的redis
client版本类型即可。我是使用java语言开发的，针对java语言，redis
client也提供了多种客户端支持，按照推荐类型依次是：Jedis、Redisson、JRedis、JDBC-Redis、RJC、redis-protocol、aredis、lettuce。前两种类型是比较推荐的，我们采用了Redisson类型版本作为redisclient的使用。
Redisson版的redis可发工程搭建
1
新建maven工程
2
在pomxml文件的dependencies节点下增加如下内容：
<dependency>
<groupId>orgredisson</groupId>
<artifactId>redisson</artifactId>
<version>102</version>
</dependency>
<dependency>
<groupId>orgslf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>177</version>
</dependency>
3
保存pomxml后，等eclispe工程构建完成后即可进行开发了
开发示例
下面是演示连接redis服务器、保存读取concurrentMap对象、保存读取set对象和保存读取Queue对象的示例代码，代码比较简单，这里就不再详细讲解了，代码如下：
[java]
view
plaincopy
package
commytestredis;
import
javautilQueue;
import
javautilSet;
import
javautilconcurrentConcurrentMap;
import
orgredissonConfig;
import
orgredissonRedisson;
public
class
RedisExample
{
/

@param
args
/
public
static
void
main(String[]
args)
{
//
1初始化
Config
config
=
new
Config();
configsetConnectionPoolSize(10);
configaddAddress("127001:6379");
Redisson
redisson
=
Redissoncreate(config);
Systemoutprintln("reids连接成功");
//
2测试concurrentMap,put方法的时候就会同步到redis中
ConcurrentMap<String,
Object>
map
=
redissongetMap("FirstMap");
mapput("wuguowei",
"男");
mapput("zhangsan",
"nan");
mapput("lisi",
"女");
ConcurrentMap
resultMap
=
redissongetMap("FirstMap");
Systemoutprintln("resultMap=="
+
resultMapkeySet());
//
2测试Set集合
Set
mySet
=
redissongetSet("MySet");
mySetadd("wuguowei");
mySetadd("lisi");
Set
resultSet
=
redissongetSet("MySet");
Systemoutprintln("resultSet==="
+
resultSetsize());
//3测试Queue队列
Queue
myQueue
=
redissongetQueue("FirstQueue");
myQueueadd("wuguowei");
myQueueadd("lili");
myQueueadd("zhangsan");
myQueuepeek();
myQueuepoll();
Queue
resultQueue=redissongetQueue("FirstQueue");
Systemoutprintln("resultQueue==="+resultQueue);
//
关闭连接
redissonshutdown();
}
}

Spring Boot连接Redis哨兵集群的原理如下：
1 Spring Boot使用Jedis客户端连接Redis哨兵集群。Jedis是一个Java Redis客户端，它支持连接Redis哨兵集群。
2 Jedis客户端会向Redis哨兵集群发送SENTINEL get-master-addr-by-name命令，获取当前Redis主节点的IP地址和端口号。
3 Jedis客户端会使用获取到的IP地址和端口号连接Redis主节点，并发送PING命令测试连接是否正常。
4 如果连接正常，Jedis客户端会将连接信息保存在连接池中，以便后续使用。
5 如果连接失败，Jedis客户端会向Redis哨兵集群发送SENTINEL get-master-addr-by-name命令，获取新的Redis主节点的IP地址和端口号，然后重复步骤2-4。
6 如果Redis主节点发生故障，Redis哨兵会自动将从节点升级为主节点，并通知Jedis客户端更新连接信息。
总之，Spring Boot连接Redis哨兵集群的原理是通过Jedis客户端向Redis哨兵集群发送命令获取当前Redis主节点的IP地址和端口号，然后使用获取到的信息连接Redis主节点。如果连接失败，Jedis客户端会重新获取新的Redis主节点的IP地址和端口号，直到连接成功为止。如果Redis主节点发生故障，Redis哨兵会自动将从节点升级为主节点，并通知Jedis客户端更新连接信息。

我安装的是263的版本，该版本下默认的使用lettuce，而不是jedis，若想使用jedis，需要自己额外进行引用

1、nested exception is orgspringframeworkbeansfactoryNoSuchBeanDefinitionException: No qualifying bean of type 'orgspringframeworkdatarediscoreRedisTemplate<javalangString, javalangObject>' available: expected at least 1 bean which qualifies as autowire candidate Dependency annotations: {@orgspringframeworkbeansfactoryannotationAutowired(required=true)}

改成这个就可以使用了

不行。由于只用到redis和springboot的整合，所以只能实现一个URL下的不同端口的应用之间的session共享，如果连应用名称都完全不同的两个应用要实现session共享，在这个基础上还需要使用到Nginx，这种方式我暂时还没有试过。(SpringBoot项目默认就是不带应用名称的，除非自己在配置文件中修改过)

这里我是用lettuce客户端，未使用Jedis 二者 区别如下：
1、Jedis 是直连模式，在多个线程间共享一个 Jedis 实例时是线程不安全的，
每个线程都去拿自己的 Jedis 实例，当连接数量增多时，物理连接成本就较高了
2、Lettuce的连接是基于Netty的，连接实例可以在多个线程间共享，如果你不知道Netty也没事，大致意思就是一个多线程的应用可以使用同一个连接实例，而不用担心并发线程的数量。通过异步的方式可以让我们更好地利用系统资源。
附注：若想详细了解Lettuce 可以看这篇文章 >