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源碼。獲取這個系列課程的完整源碼。