使用Redis作为SpringBoot项目数据缓存

我们平时在项目中设计数据访问的时候往往都是采用直接访问数据库，采用数据库连接池来实现，但是如果我们的项目访问量过大或者访问过于频繁，将会对我们的数据库带来很大的压力。为了解决这个问题从而redis数据库脱颖而出，redis数据库出现时是以非关系数据库的光环展示在广大程序猿的面前的，后来redis的迭代版本支持了缓存数据、登录session状态（分布式session共享）等。所以又被作为内存缓存的形式应用到大型企业级项目中。

本章目标

实现SpringBoot项目中整合Redis非关系数据库作为内存缓存框架，并测试数据读取源。

安装Redis

官网的redis仅支持Linux服务器的安装版本，由于开发人员都是在windows上工作，所以GitHub上的牛人基于linux平台下的Redis实现了windows版本。我们直接访问github网址：https://github.com/MicrosoftArchive/redis/releases，下载最新的windows X64版本的压缩包安装即可。

开启Redis

如果6379没有端口没有被占用，我们需要在cmd命令窗口运行Redis，我们首先使用cmd命令进入到Redis解压目录并且执行redis-server.exe redis.windows.conf命令，如图所示：

可以看到我们的redis数据库已经启动了，下面输出日志开启了服务链接在6379端口。我们的数据库已经配置完成了，接下来我们来构建SpringBoot整合Redis项目。

添加Redis依赖

        
            org.springframework.boot
            spring-boot-starter-cache
        
        
        
            org.springframework.boot
            spring-boot-starter-redis
            1.4.3.RELEASE
        

配置Redis数据库

创建application.yml配置文件添加如下配置内容

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC&useSSL=true
    username: root
    password: 123456
    maxActive: 20       #最大活跃数
    initialSize: 1      #初始化数量
    maxWait: 60000      #最大连接等待超时时间
    #打开PSCache，并且指定每个连接PSCache的大小
    poolPreparedStatements: true
    maxPoolPreparedStatementPerConnectionSize: 20
    #通过connectionProperties属性来打开mergeSql功能；慢SQL记录
    #connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
    minIdle: 1
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: select 1 from dual
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    #配置监控统计拦截的filters，去掉后监控界面sql将无法统计,'wall'用于防火墙
    filters: stat, wall, log4j
  jpa:
    properties:
      hibernate:
        show_sql: true
        format_sql: true
  #配置redis数据库连接
  redis:
    host: 127.0.0.1
    port: 6379
    pool:
      max-idle: 20      # 连接池中的最大空闲连接
      min-idle: 1
      max-active: 20    # 连接池最大连接数（使用负值表示没有限制）
      max-wait: 60000   #连接池最大阻塞等待时间
    database: 0         #默认是索引为的0的数据库

配置CacheManager

下面我们需要让SpringBoot内置的缓存框架使用我们的Redis作为新的缓存，我们来添加一个RedisConfiguration的配置类，并添加对应的配置

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

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

创建UserEntity

@Entity
@Table(name = "t_users")
public class UserEntity implements Serializable
{

    @Id
    @GeneratedValue
    @Column(name = "t_id")
    private Long id;

    @Column(name = "t_name")
    private String name;

    @Column(name = "t_age")
    private int age;

    @Column(name = "t_address")
    private String address;
}

创建SpringDataJPA支持的JPA接口

public interface UserJPA extends JpaRepository
{

}

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

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

    @Autowired
    private UserJPA userJPA;

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

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

创建控制器

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    /**
     * 查询用户列表
     * @return
     */
    @RequestMapping(value = "/list")
    public List<UserEntity> list()
    {
        return userService.list();
    }

测试

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

使用Redis-Cli客户端

我们使用Cmd命令进入我们的Redis解压目录，并执行redis-cli.exe应用程序

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

自定义Key

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

@Configuration
@EnableCaching
public class RedisConfiguration extends CachingConfigurerSupport
{
    /**
     * 自定义生成key的规则
     * @return
     */
    @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是否已经按照我们自定义规则生成。

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

Redis命令

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

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

总结

以上所述就是本章的全部讲解内容，本章主要讲解了SpringBoot项目中如何使用Redis非关系型数据库作为缓存框架，并完成自定义Redis生成的key值。