SpringBoot入门系列（七）Spring Boot整合Redis缓存

2020 年 3 月 18 日
筆記

前面介绍了Spring Boot 中的整合Mybatis并实现增删改查，。不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。

今天主要讲解Springboot整合Redis。Redis是目前使用最多的缓存，包括Spring Boot 中我们也是会用Redis做很多事情。那么今天就来说一说Spring Boot如何整合Redis。Spring Boot整合Redis 需要那些步骤呢？

一、整合Redis

新项目整合 Redis 非常容易，只需要创建项目时勾上 Redis 即可，这里就不说了。

我们还是来说说怎么在现有的项目中手动整合Redis：

1、在pom.xml 增加依赖如下：

<!-- 引入 redis 依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
    <version>1.5.7.RELEASE</version>
</dependency>

2、资源文件application.properties中对Redis进行配置

############################################################  #  # REDIS 配置  #  ############################################################  spring.redis.database=0  spring.redis.host=127.0.0.1  spring.redis.port=6379  spring.redis.password=  spring.redis.jedis.pool.max-active=8  spring.redis.jedis.pool.max-wait=-1  spring.redis.jedis.pool.max-idle=10  spring.redis.jedis.pool.min-idle=2  spring.redis.timeout=6000

3、封装Json工具类

这个工具类比较简单，封装操作redisTemplate的实现类。这个工具类只是简单的封装了StringRedisTemplate，其他相关的数据类型大家可以根据自己的需要自行扩展。

package com.weiz.utils;    import java.util.Map;  import java.util.Set;  import java.util.concurrent.TimeUnit;    import org.springframework.beans.factory.annotation.Autowired;  import org.springframework.data.redis.core.StringRedisTemplate;  import org.springframework.stereotype.Component;    /**   *   * @Title: RedisOperator.java   * @Package com.weiz.util   * @Description: 使用redisTemplate的操作实现类 Copyright: Copyright (c) 2016   *               Company:FURUIBOKE.SCIENCE.AND.TECHNOLOGY   *   * @author weiz   * @date 2017年9月29日 下午2:25:03   * @version V1.0   */  @Component  public class RedisOperator {    // @Autowired  //    private RedisTemplate<String, Object> redisTemplate;       @Autowired     private StringRedisTemplate redisTemplate;       // Key（键），简单的key-value操作       /**      * 实现命令：TTL key，以秒为单位，返回给定 key的剩余生存时间(TTL, time to live)。      *      * @param key      * @return      */     public long ttl(String key) {        return redisTemplate.getExpire(key);     }       /**      * 实现命令：expire 设置过期时间，单位秒      *      * @param key      * @return      */     public void expire(String key, long timeout) {        redisTemplate.expire(key, timeout, TimeUnit.SECONDS);     }       /**      * 实现命令：INCR key，增加key一次      *      * @param key      * @return      */     public long incr(String key, long delta) {        return redisTemplate.opsForValue().increment(key, delta);     }       /**      * 实现命令：KEYS pattern，查找所有符合给定模式 pattern的 key      */     public Set<String> keys(String pattern) {        return redisTemplate.keys(pattern);     }       /**      * 实现命令：DEL key，删除一个key      *      * @param key      */     public void del(String key) {        redisTemplate.delete(key);     }       // String（字符串）       /**      * 实现命令：SET key value，设置一个key-value（将字符串值 value关联到 key）      *      * @param key      * @param value      */     public void set(String key, String value) {        redisTemplate.opsForValue().set(key, value);     }       /**      * 实现命令：SET key value EX seconds，设置key-value和超时时间（秒）      *      * @param key      * @param value      * @param timeout      *            （以秒为单位）      */     public void set(String key, String value, long timeout) {        redisTemplate.opsForValue().set(key, value, timeout, TimeUnit.SECONDS);     }       /**      * 实现命令：GET key，返回 key所关联的字符串值。      *      * @param key      * @return value      */     public String get(String key) {        return (String)redisTemplate.opsForValue().get(key);     }       // Hash（哈希表）       /**      * 实现命令：HSET key field value，将哈希表 key中的域 field的值设为 value      *      * @param key      * @param field      * @param value      */     public void hset(String key, String field, Object value) {        redisTemplate.opsForHash().put(key, field, value);     }       /**      * 实现命令：HGET key field，返回哈希表 key中给定域 field的值      *      * @param key      * @param field      * @return      */     public String hget(String key, String field) {        return (String) redisTemplate.opsForHash().get(key, field);     }       /**      * 实现命令：HDEL key field [field ...]，删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。      *      * @param key      * @param fields      */     public void hdel(String key, Object... fields) {        redisTemplate.opsForHash().delete(key, fields);     }       /**      * 实现命令：HGETALL key，返回哈希表 key中，所有的域和值。      *      * @param key      * @return      */     public Map<Object, Object> hgetall(String key) {        return redisTemplate.opsForHash().entries(key);     }       // List（列表）       /**      * 实现命令：LPUSH key value，将一个值 value插入到列表 key的表头      *      * @param key      * @param value      * @return 执行 LPUSH命令后，列表的长度。      */     public long lpush(String key, String value) {        return redisTemplate.opsForList().leftPush(key, value);     }       /**      * 实现命令：LPOP key，移除并返回列表 key的头元素。      *      * @param key      * @return 列表key的头元素。      */     public String lpop(String key) {        return (String)redisTemplate.opsForList().leftPop(key);     }       /**      * 实现命令：RPUSH key value，将一个值 value插入到列表 key的表尾(最右边)。      *      * @param key      * @param value      * @return 执行 LPUSH命令后，列表的长度。      */     public long rpush(String key, String value) {        return redisTemplate.opsForList().rightPush(key, value);     }    }

4、创建RedisController控制器

package com.weiz.controller;    import java.util.ArrayList;  import java.util.Date;  import java.util.List;    import org.springframework.beans.factory.annotation.Autowired;  import org.springframework.data.redis.core.StringRedisTemplate;  import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RestController;    import com.weiz.utils.JSONResult;  import com.weiz.pojo.SysUser;  import com.weiz.pojo.User;  import com.weiz.utils.JsonUtils;  import com.weiz.utils.RedisOperator;    @RestController  @RequestMapping("redis")  public class RedisController {        @Autowired      private StringRedisTemplate strRedis;        @Autowired      private RedisOperator redis;        @RequestMapping("/test")      public JSONResult test() {          SysUser user = new SysUser();          user.setId("100111");          user.setUsername("spring boot");          user.setPassword("abc123");          user.setIsDelete(0);          user.setRegistTime(new Date());          strRedis.opsForValue().set("json:user", JsonUtils.objectToJson(user));            return JSONResult.ok(user);      }        @RequestMapping("/getJsonList")      public JSONResult getJsonList() {            User user = new User();          user.setAge(18);          user.setName("慕课网");          user.setPassword("123456");          user.setBirthday(new Date());            User u1 = new User();          u1.setAge(19);          u1.setName("spring boot");          u1.setPassword("123456");          u1.setBirthday(new Date());            User u2 = new User();          u2.setAge(17);          u2.setName("hello spring boot");          u2.setPassword("123456");          u2.setBirthday(new Date());            List<User> userList = new ArrayList<>();          userList.add(user);          userList.add(u1);          userList.add(u2);            redis.set("json:info:userlist", JsonUtils.objectToJson(userList), 2000);            String userListJson = redis.get("json:info:userlist");          List<User> userListBorn = JsonUtils.jsonToList(userListJson, User.class);            return JSONResult.ok(userListBorn);      }  }

说明：

1. /test 是没有封装的，原生的Redis 客户端操作Redis的方法。

2. /getJsonList 为封装的工具类操作调用方法。

二、测试

在浏览器中输入：http://localhost:8080/redis/test 查看是否有数据返回。

最后

以上，就把Spring Boot 如何整合Redis简单的介绍完了，同时提供了Redis的操作类，这个工具类只是简单的封装了StringRedisTemplate，其他相关的数据类型大家可以根据自己的需要自行扩展。

这个系列课程的完整源码，也会提供给大家。大家关注我的微信公众号（架构师精进），回复：springboot源码。获取这个系列课程的完整源码。