Spring Boot 整合 Redis

Redis介绍

Redis 是一个高性能的key-value数据库。我们平时在项目中设计数据访问的时候往往都是采用直接访问数据库，采用数据库连接池来实现，但是如果项目访问量过大或者访问过于频繁，将会对数据库带来很大的压力。为了解决这个问题，Redis数据库脱颖而出，Redis的迭代版本支持缓存数据、登录session状态（分布式session共享）等，被作为内存缓存的形式应用到大型企业级项目中。

本章目标

在Spring Boot 整合 JPA使用Redis非关系数据库作为内存缓存框架和分布式session共享。

安装Redis

官网的Redis仅支持安装Linux服务器的版本，安装windows版本访问github网址：https://github.com/MicrosoftArchive/redis/releases，下载最新的windows X64版本的压缩包解压安装即可。

开启Redis

使用cmd命令进入到Redis解压目录，执行以下命令启动Redis

redis-server.exe redis.windows.conf

Redis.png

添加Redis依赖

<!-- 添加缓存支持 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<!-- 添加Redis缓存支持 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

配置Redis数据库

# Redis数据库索引（默认为0）
spring.redis.database=0  
# Redis服务器地址
spring.redis.host=127.0.0.1
# Redis服务器连接端口
spring.redis.port=6379  
# Redis服务器连接密码（默认为空）
spring.redis.password=
# 连接池最大连接数（使用负值表示没有限制）
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=0 

Redis作缓存管理

添加一个RedisConfiguration配置类

@Configuration
@EnableCaching
public class RedisConfiguration extends CachingConfigurerSupport
{
    /**
     * 采用RedisCacheManager作为缓存管理器
     * @param redisTemplate
     */
    @Bean
    public CacheManager cacheManager(RedisTemplate redisTemplate) {
        return new RedisCacheManager(redisTemplate);
    }
}

@EnableCaching注解用来开启项目的缓存支持，我们在配置类内添加了方法cacheManager()，方法的返回值则是使用了我们的Redis缓存的管理器，SpringBoot项目启动时就会去找自定义配置的CacheManager对象并且自动应用到项目中。

创建业务逻辑服务类：UserService添加redis的缓存支持

@Service
@CacheConfig(cacheNames = "user")
public class UserService {

    @Autowired
    private UserJPA userJPA;

    @Cacheable
    public List<UserEntity> list() { return userJPA.findAll();  }

    @Cacheable
    public UserEntity findById(long id){return userJPA.findOne(id);}
}

@CacheConfig：该注解是用来开启声明的类参与缓存
@Cacheable注解没有添加key值，那么会自动使用cahceNames配置参数并且追加方法名。
@Cacheable：配置方法的缓存参数，可自定义缓存的key以及value。

创建控制器

@RestController
public class UserController {

    @Autowired
    private UserService userService;

  @RequestMapping(value = "/list")
    public List<UserEntity> list() { return userService.list(); }

    @RequestMapping(value = "/find")
    public UserEntity findById(long id){return userService.findById(id);}

测试

启动成功后访问地址：127.0.0.1:8080/list 控制台输出了SQL查询语句，当我们再次访问时，可以看到跟上次访问列表的数据一致，但是控制台的SQL语句只有一次输出，这个输出是上次访问的时候执行的，证明我们配置的Redis缓存已经生效。可以使用Redis的客户端来查看是否已经存在。

使用Redis-Cli客户端

用cmd命令进入Redis解压目录，执行redis-cli.exe应用程序

key.png

可以看到Redis为我们自动生成的Key让我们很无奈，根本看不懂！那我们以后维护起来就很复杂。下面我们来自定义Redis生成Key的规则！

自定义Key

我们打开RedisConfiguration配置类，添加继承CachingConfigurerSupport类，并重写方法keyGenerator()

@Configuration
@EnableCaching
public class RedisConfiguration extends CachingConfigurerSupport
{
    /**
     * 自定义生成key的规则
     */
    @Override
    public KeyGenerator keyGenerator() {
        return new KeyGenerator() {
            @Override
            public Object generate(Object o, Method method, Object... objects) {
                //格式化缓存key字符串
                StringBuilder sb = new StringBuilder();
                //追加类名
                sb.append(o.getClass().getName());
                //追加方法名
                sb.append(method.getName());
                //遍历参数并且追加
                for (Object obj : objects) {
                    sb.append(obj.toString());
                }
                System.out.println("调用Redis缓存Key : " + sb.toString());
                return sb.toString();
            }
        };
    }

我们根据类名、方法名、参数列表等完成自定义Redis缓存的Key定义，下面我们重启下项目，两次访问127.0.0.1:8080/list 地址查看界面输出可以看到跟我们之前一样，第一次放了数据库，第二次查询了缓存数据，我们再来通过redis-cli客户端查看下数据库内保存的key是否已经按照我们自定义规则生成。

keys.png

可以看到第二条，就是根据我们规则生成的key。

共享Session

分布式系统中，sessiong共享有很多的解决方案，其中托管到缓存中应该是最常用的方案之一

添加依赖

<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>

Session配置

@Configuration
//设置Session失效时间，使用Redis Session之后，原Boot的server.session.timeout属性不再生效
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 86400*30)
public class SessionConfig {
}

测试

添加测试方法获取sessionid

@RequestMapping("/uid")
    String uid(HttpSession session) {
        UUID uid = (UUID) session.getAttribute("uid");
        if (uid == null) {
            uid = UUID.randomUUID();
        }
        session.setAttribute("uid", uid);
        return session.getId();
    }

登录redis 输入 keys 'sessions'

t<spring:session:sessions:db031986-8ecc-48d6-b471-b137a3ed6bc4
t(spring:session:expirations:1472976480000

其中 1472976480000为失效时间，意思是这个时间后session失效，db031986-8ecc-48d6-b471-b137a3ed6bc4 为sessionId,登录http://localhost:8080/uid 发现会一致，就说明session 已经在redis里面进行有效的管理了。

按照上面的步骤在另一个项目中再次配置一次，启动后就自动共享session

Redis命令

Redis数据库内有很多个命令下面我简单介绍几个大家在日常开发中常用到的。

• flushdb：清空当前数据库。
• select [index]：选择索引数据库，index为索引值名，如：select 1。
• del [key]：删除一条指定key的值。
• keys *：查看数据库内所有的key。
• flushall：清空所有数据库。
• quit：退出客户端连接。

参考

redis中文官方网站
在Spring Boot中使用Redis