Spring Boot 整合 Redis 實作緩存操作

摘要: 原創出處 www.bysocket.com 「泥瓦匠BYSocket 」歡迎轉載，保留摘要，謝謝！

『産品沒有價值，開發團隊再優秀也無濟于事 – 《啟示錄》』

本文提綱

一、緩存的應用場景

二、更新緩存的政策

三、運作 springboot-mybatis-redis 工程案例

四、springboot-mybatis-redis 工程代碼配置詳解

運作環境：

Mac OS 10.12.x

JDK 8 +

Redis 3.2.8

Spring Boot 1.5.1.RELEASE

什麼是緩存？

在網際網路場景下，尤其 2C 端大流量場景下，需要将一些經常展現和不會頻繁變更的資料，存放在存取速率更快的地方。緩存就是一個存儲器，在技術選型中，常用 Redis 作為緩存資料庫。緩存主要是在擷取資源友善性能優化的關鍵方面。

Redis is an in-memory database that persists on disk. The data model is key-value, but many different kind of values are supported: Strings, Lists, Sets, Sorted Sets, Hashes, HyperLogLogs, Bitmaps.

緩存的應用場景有哪些呢？

比如常見的電商場景，根據商品 ID 擷取商品資訊時，店鋪資訊和商品詳情資訊就可以緩存在 Redis，直接從 Redis 擷取。減少了去資料庫查詢的次數。但會出現新的問題，就是如何對緩存進行更新？這就是下面要講的。

這裡我們使用的是 Cache Aside 政策，從三個次元：（摘自耗子叔叔部落格）

失效：應用程式先從cache取資料，沒有得到，則從資料庫中取資料，成功後，放到緩存中。

命中：應用程式從cache中取資料，取到後傳回。

更新：先把資料存到資料庫中，成功後，再讓緩存失效。

大緻流程如下：

擷取商品詳情舉例

a. 從商品 Cache 中擷取商品詳情，如果存在，則傳回擷取 Cache 資料傳回。

b. 如果不存在，則從商品 DB 中擷取。擷取成功後，将資料存到 Cache 中。則下次擷取商品詳情，就可以從 Cache 就可以得到商品詳情資料。

c. 從商品 DB 中更新或者删除商品詳情成功後，則從緩存中删除對應商品的詳情緩存

下面開始運作工程步驟（Quick Start）：

1.資料庫和 Redis 準備

a.建立資料庫 springbootdb：

<code>CREATE DATABASE springbootdb;</code>

b.建立表 city ：(因為我喜歡徒步)

<code>DROP TABLE IF EXISTS `city`;</code>

<code>CREATE TABLE `city` (</code>

<code> </code><code>`id` </code><code>int</code><code>(</code><code>10</code><code>) unsigned NOT NULL AUTO_INCREMENT COMMENT </code><code>'城市編号'</code><code>,</code>

<code> </code><code>`province_id` </code><code>int</code><code>(</code><code>10</code><code>) unsigned NOT NULL COMMENT </code><code>'省份編号'</code><code>,</code>

<code> </code><code>`city_name` varchar(</code><code>25</code><code>) DEFAULT NULL COMMENT </code><code>'城市名稱'</code><code>,</code>

<code> </code><code>`description` varchar(</code><code>25</code><code>) DEFAULT NULL COMMENT </code><code>'描述'</code><code>,</code>

<code> </code><code>PRIMARY KEY (`id`)</code>

<code>) ENGINE=InnoDB AUTO_INCREMENT=</code><code>1</code> <code>DEFAULT CHARSET=utf8;</code>

c.插入資料

<code>INSERT city VALUES (</code><code>1</code> <code>,</code><code>1</code><code>,</code><code>'溫嶺市'</code><code>,</code><code>'BYSocket 的家在溫嶺。'</code><code>);</code>

d.本地安裝 Redis

2. springboot-mybatis-redis 工程項目結構介紹

<code>springboot-mybatis-redis 工程項目結構如下圖所示：</code>

<code>org.spring.springboot.controller - Controller 層</code>

<code>org.spring.springboot.dao - 資料操作層 DAO</code>

<code>org.spring.springboot.domain - 實體類</code>

<code>org.spring.springboot.service - 業務邏輯層</code>

<code>Application - 應用啟動類</code>

<code>application.properties - 應用配置檔案，應用啟動會自動讀取配置</code>

3.改資料庫配置

打開 application.properties 檔案，修改相應的資料源配置，比如資料源位址、賬号、密碼等。

（如果不是用 MySQL，自行添加連接配接驅動 pom，然後修改驅動名配置。）

4.編譯工程

在項目根目錄 springboot-learning-example，運作 maven 指令：

<code>mvn clean install</code>

5.運作工程

右鍵運作 springboot-mybatis-redis 工程 Application 應用啟動類的 main 函數。

項目運作成功後，這是個 HTTP OVER JSON 服務項目。是以用 postman 工具可以如下操作

根據 ID，擷取城市資訊

GET http://127.0.0.1:8080/api/city/1

再請求一次，擷取城市資訊會發現資料擷取的耗時快了很多。服務端 Console 輸出的日志：

<code>2017</code><code>-</code><code>04</code><code>-</code><code>13</code> <code>18</code><code>:</code><code>29</code><code>:</code><code>00.273</code> <code>INFO </code><code>13038</code> <code>--- [nio-</code><code>8080</code><code>-exec-</code><code>1</code><code>] o.s.s.service.impl.CityServiceImpl : CityServiceImpl.findCityById() : 城市插入緩存 >> City{id=</code><code>12</code><code>, provinceId=</code><code>3</code><code>, cityName=</code><code>'三亞'</code><code>, description=</code><code>'水好,天藍'</code><code>}</code>

<code>2017</code><code>-</code><code>04</code><code>-</code><code>13</code> <code>18</code><code>:</code><code>29</code><code>:</code><code>03.145</code> <code>INFO </code><code>13038</code> <code>--- [nio-</code><code>8080</code><code>-exec-</code><code>2</code><code>] o.s.s.service.impl.CityServiceImpl : CityServiceImpl.findCityById() : 從緩存中擷取了城市 >> City{id=</code><code>12</code><code>, provinceId=</code><code>3</code><code>, cityName=</code><code>'三亞'</code><code>, description=</code><code>'水好,天藍'</code><code>}</code>

可見，第一次是從資料庫 DB 擷取資料，并插入緩存，第二次直接從緩存中取。

更新城市資訊

PUT http://127.0.0.1:8080/api/city

删除城市資訊

DELETE http://127.0.0.1:8080/api/city/2

這兩種操作中，如果緩存有對應的資料，則删除緩存。服務端 Console 輸出的日志：

<code>2017</code><code>-</code><code>04</code><code>-</code><code>13</code> <code>18</code><code>:</code><code>29</code><code>:</code><code>52.248</code> <code>INFO </code><code>13038</code> <code>--- [nio-</code><code>8080</code><code>-exec-</code><code>9</code><code>] o.s.s.service.impl.CityServiceImpl : CityServiceImpl.deleteCity() : 從緩存中删除城市 ID >> </code><code>12</code>

這裡，我強烈推薦注解的方式實作對象的緩存。但是這裡為了更好說明緩存更新政策。下面講講工程代碼的實作。

pom.xml 依賴配置:

<code><?xml version=</code><code>"1.0"</code> <code>encoding=</code><code>"UTF-8"</code><code>?></code>

<code><project xmlns=</code><code>"http://maven.apache.org/POM/4.0.0"</code> <code>xmlns:xsi=</code><code>"http://www.w3.org/2001/XMLSchema-instance"</code>

<code> </code><code>xsi:schemaLocation=</code><code>"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"</code><code>></code>

<code> </code><code><groupId>springboot</groupId></code>

<code> </code><code><artifactId>springboot-mybatis-redis</artifactId></code>

<code> </code><code><version></code><code>0.0</code><code>.</code><code>1</code><code>-SNAPSHOT</version></code>

<code> </code><code><name>springboot-mybatis-redis :: 整合 Mybatis 并使用 Redis 作為緩存</name></code>

<code> </code><code><groupId>org.springframework.boot</groupId></code>

<code> </code><code><artifactId>spring-boot-starter-parent</artifactId></code>

<code> </code><code><version></code><code>1.5</code><code>.</code><code>1</code><code>.RELEASE</version></code>

<code> </code><code><spring-boot-starter-redis-version></code><code>1.3</code><code>.</code><code>2</code><code>.RELEASE</spring-boot-starter-redis-version></code>

<code> </code><code><groupId>org.springframework.boot</groupId></code>

<code> </code><code><artifactId>spring-boot-starter-redis</artifactId></code>

<code> </code><code><version>${spring-boot-starter-redis-version}</version></code>

<code> </code><code><artifactId>spring-boot-starter-web</artifactId></code>

<code> </code><code><artifactId>spring-boot-starter-test</artifactId></code>

<code> </code><code><groupId>org.mybatis.spring.boot</groupId></code>

<code> </code><code><artifactId>mybatis-spring-boot-starter</artifactId></code>

<code> </code><code><version>${mybatis-spring-boot}</version></code>

<code> </code><code><groupId>mysql</groupId></code>

<code> </code><code><artifactId>mysql-connector-java</artifactId></code>

<code> </code><code><version>${mysql-connector}</version></code>

<code> </code><code><groupId>junit</groupId></code>

<code> </code><code><artifactId>junit</artifactId></code>

包括了 Spring Boot Reids 依賴、 MySQL 依賴和 Mybatis 依賴。

在 application.properties 應用配置檔案，增加 Redis 相關配置

<code>## 資料源配置</code>

<code>spring.datasource.url=jdbc:mysql:</code><code>//localhost:3306/springbootdb?useUnicode=true&characterEncoding=utf8</code>

<code>spring.datasource.username=root</code>

<code>spring.datasource.password=</code><code>123456</code>

<code>spring.datasource.driver-</code><code>class</code><code>-name=com.mysql.jdbc.Driver</code>

<code>## Mybatis 配置</code>

<code>mybatis.typeAliasesPackage=org.spring.springboot.domain</code>

<code>mybatis.mapperLocations=classpath:mapper/*.xml</code>

<code>## Redis 配置</code>

<code>## Redis資料庫索引（預設為</code><code>0</code><code>）</code>

<code>spring.redis.database=</code><code>0</code>

<code>## Redis伺服器位址</code>

<code>spring.redis.host=</code><code>127.0</code><code>.</code><code>0.1</code>

<code>## Redis伺服器連接配接端口</code>

<code>spring.redis.port=</code><code>6379</code>

<code>## Redis伺服器連接配接密碼（預設為空）</code>

<code>spring.redis.password=</code>

<code>## 連接配接池最大連接配接數（使用負值表示沒有限制）</code>

<code>spring.redis.pool.max-active=</code><code>8</code>

<code>## 連接配接池最大阻塞等待時間（使用負值表示沒有限制）</code>

<code>spring.redis.pool.max-wait=-</code><code>1</code>

<code>## 連接配接池中的最大空閑連接配接</code>

<code>spring.redis.pool.max-idle=</code><code>8</code>

<code>## 連接配接池中的最小空閑連接配接</code>

<code>spring.redis.pool.min-idle=</code><code>0</code>

<code>## 連接配接逾時時間（毫秒）</code>

<code>spring.redis.timeout=</code><code>0</code>

詳細解釋可以參考注釋。對應的配置類：org.springframework.boot.autoconfigure.data.redis.RedisProperties

<code>Serializable</code>

<code>java.lang.IllegalArgumentException: DefaultSerializer requires a Serializable payload but received an object of type</code>

City.java 城市對象：

<code>package</code> <code>org.spring.springboot.domain;</code>

<code>import</code> <code>java.io.Serializable;</code>

<code> </code><code>* 城市實體類</code>

<code> </code><code>* Created by bysocket on 07/02/2017.</code>

<code>public</code> <code>class</code> <code>City </code><code>implements</code> <code>Serializable {</code>

<code> </code><code>private</code> <code>static</code> <code>final</code> <code>long</code> <code>serialVersionUID = -1L;</code>

<code> </code><code>private</code> <code>Long id;</code>

<code> </code><code>private</code> <code>Long provinceId;</code>

<code> </code><code>private</code> <code>String cityName;</code>

<code> </code><code>private</code> <code>String description;</code>

<code> </code><code>public</code> <code>Long getId() {</code>

<code> </code><code>return</code> <code>id;</code>

<code> </code><code>public</code> <code>void</code> <code>setId(Long id) {</code>

<code> </code><code>public</code> <code>Long getProvinceId() {</code>

<code> </code><code>return</code> <code>provinceId;</code>

<code> </code><code>public</code> <code>void</code> <code>setProvinceId(Long provinceId) {</code>

<code> </code><code>this</code><code>.provinceId = provinceId;</code>

<code> </code><code>public</code> <code>String getCityName() {</code>

<code> </code><code>return</code> <code>cityName;</code>

<code> </code><code>public</code> <code>void</code> <code>setCityName(String cityName) {</code>

<code> </code><code>this</code><code>.cityName = cityName;</code>

<code> </code><code>public</code> <code>String getDescription() {</code>

<code> </code><code>return</code> <code>description;</code>

<code> </code><code>public</code> <code>void</code> <code>setDescription(String description) {</code>

<code> </code><code>this</code><code>.description = description;</code>

<code> </code><code>@Override</code>

<code> </code><code>public</code> <code>String toString() {</code>

<code> </code><code>return</code> <code>"City{"</code> <code>+</code>

<code> </code><code>", provinceId="</code> <code>+ provinceId +</code>

<code> </code><code>", cityName='"</code> <code>+ cityName + '\</code><code>''</code> <code>+</code>

<code> </code><code>", description='"</code> <code>+ description + '\</code><code>''</code> <code>+</code>

如果需要自定義序列化實作，隻要實作 RedisSerializer 接口去實作即可，然後在使用 RedisTemplate.setValueSerializer 方法去設定你實作的序列化實作。

主要還是城市業務邏輯實作類 CityServiceImpl.java：

<code>package</code> <code>org.spring.springboot.service.impl;</code>

<code>import</code> <code>org.slf4j.Logger;</code>

<code>import</code> <code>org.slf4j.LoggerFactory;</code>

<code>import</code> <code>org.spring.springboot.dao.CityDao;</code>

<code>import</code> <code>org.spring.springboot.domain.City;</code>

<code>import</code> <code>org.spring.springboot.service.CityService;</code>

<code>import</code> <code>org.springframework.beans.factory.annotation.Autowired;</code>

<code>import</code> <code>org.springframework.data.redis.core.RedisTemplate;</code>

<code>import</code> <code>org.springframework.data.redis.core.StringRedisTemplate;</code>

<code>import</code> <code>org.springframework.data.redis.core.ValueOperations;</code>

<code>import</code> <code>org.springframework.stereotype.Service;</code>

<code>import</code> <code>java.util.List;</code>

<code>import</code> <code>java.util.concurrent.TimeUnit;</code>

<code> </code><code>* 城市業務邏輯實作類</code>

<code>@Service</code>

<code>public</code> <code>class</code> <code>CityServiceImpl </code><code>implements</code> <code>CityService {</code>

<code> </code><code>private</code> <code>static</code> <code>final</code> <code>Logger LOGGER = LoggerFactory.getLogger(CityServiceImpl.</code><code>class</code><code>);</code>

<code> </code><code>@Autowired</code>

<code> </code><code>private</code> <code>CityDao cityDao;</code>

<code> </code><code>private</code> <code>RedisTemplate redisTemplate;</code>

<code> </code><code>* 擷取城市邏輯：</code>

<code> </code><code>* 如果緩存存在，從緩存中擷取城市資訊</code>

<code> </code><code>* 如果緩存不存在，從 DB 中擷取城市資訊，然後插入緩存</code>

<code> </code><code>public</code> <code>City findCityById(Long id) {</code>

<code> </code><code>// 從緩存中擷取城市資訊</code>

<code> </code><code>String key = </code><code>"city_"</code> <code>+ id;</code>

<code> </code><code>ValueOperations<String, City> operations = redisTemplate.opsForValue();</code>

<code> </code><code>boolean</code> <code>hasKey = redisTemplate.hasKey(key);</code>

<code> </code><code>if</code> <code>(hasKey) {</code>

<code> </code><code>City city = operations.get(key);</code>

<code> </code><code>LOGGER.info(</code><code>"CityServiceImpl.findCityById() : 從緩存中擷取了城市 >> "</code> <code>+ city.toString());</code>

<code> </code><code>return</code> <code>city;</code>

<code> </code><code>// 從 DB 中擷取城市資訊</code>

<code> </code><code>City city = cityDao.findById(id);</code>

<code> </code><code>operations.set(key, city, </code><code>10</code><code>, TimeUnit.SECONDS);</code>

<code> </code><code>LOGGER.info(</code><code>"CityServiceImpl.findCityById() : 城市插入緩存 >> "</code> <code>+ city.toString());</code>

<code> </code><code>return</code> <code>city;</code>

<code> </code><code>public</code> <code>Long saveCity(City city) {</code>

<code> </code><code>return</code> <code>cityDao.saveCity(city);</code>

<code> </code><code>* 更新城市邏輯：</code>

<code> </code><code>* 如果緩存存在，删除</code>

<code> </code><code>* 如果緩存不存在，不操作</code>

<code> </code><code>public</code> <code>Long updateCity(City city) {</code>

<code> </code><code>Long ret = cityDao.updateCity(city);</code>

<code> </code><code>String key = </code><code>"city_"</code> <code>+ city.getId();</code>

<code> </code><code>redisTemplate.delete(key);</code>

<code> </code><code>LOGGER.info(</code><code>"CityServiceImpl.updateCity() : 從緩存中删除城市 >> "</code> <code>+ city.toString());</code>

<code> </code><code>return</code> <code>ret;</code>

<code> </code><code>public</code> <code>Long deleteCity(Long id) {</code>

<code> </code><code>Long ret = cityDao.deleteCity(id);</code>

<code> </code><code>LOGGER.info(</code><code>"CityServiceImpl.deleteCity() : 從緩存中删除城市 ID >> "</code> <code>+ id);</code>

首先這裡注入了 RedisTemplate 對象。聯想到 Spring 的 JdbcTemplate ，RedisTemplate 封裝了 RedisConnection，具有連接配接管理，序列化和 Redis 操作等功能。還有針對 String 的支援對象 StringRedisTemplate。

Redis 操作視圖接口類用的是 ValueOperations，對應的是 Redis String/Value 操作。還有其他的操作視圖，ListOperations、SetOperations、ZSetOperations 和 HashOperations 。ValueOperations 插入緩存是可以設定失效時間，這裡設定的失效時間是 10 s。

回到更新緩存的邏輯

a. findCityById 擷取城市邏輯：

如果緩存存在，從緩存中擷取城市資訊

如果緩存不存在，從 DB 中擷取城市資訊，然後插入緩存

b. deleteCity 删除 / updateCity 更新城市邏輯：

如果緩存存在，删除

如果緩存不存在，不操作

其他不明白的，可以 git clone 下載下傳工程 springboot-learning-example ，工程代碼注解很詳細。 https://github.com/JeffLi1993/springboot-learning-example。

本文涉及到 Spring Boot 在使用 Redis 緩存時，一個是緩存對象需要序列化，二個是緩存更新政策是如何的。

本文轉自yunlielai51CTO部落格，原文連結：http://blog.51cto.com/4925054/1916243，如需轉載請自行聯系原作者

Spring Boot 整合 Redis 實作緩存操作

繼續閱讀

set define off關閉替代變量功能

報錯：'mysql' 不是内部或外部指令，也不是可運作的程式或批處理檔案。

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法

Linxu常用指令技巧彙總

ERROR 1 (HY000): Can't create/write to file '/tmp/#sql_4188_1.MYI' (Errcode: 28)

艱難安裝LDAP,SSL認證

《Linux指令行與Shell腳本程式設計大全第2版.布盧姆》pdf

MySQL的4種隔離級别？出現問題

XX系統實施過程問題總結

無元件上傳圖檔到資料庫中，最完整解決方案

【MySQL資料庫】資料庫索引事務1.索引2.事務

neo4j之cypher使用文檔

NOSQL安全攻擊

mybatis_入門程式Mybatis入門

登入plsql 報錯 the account is locked --使用者被鎖

SequoiaDB巨杉資料庫C++驅動概述