天天看點

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 中更新或者删除商品詳情成功後,則從緩存中删除對應商品的詳情緩存

Spring Boot 整合 Redis 實作緩存操作

下面開始運作工程步驟(quick start):

1.資料庫和 redis 準備

a.建立資料庫 springbootdb:

1

<code>create database springbootdb;</code>

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

2

3

4

5

6

7

8

<code>drop table if exists  `city`;</code>

<code>create table `city` (</code>

<code>  </code><code>`</code><code>id</code><code>` int(10) unsigned not null auto_increment comment</code><code>'城市編号'</code><code>,</code>

<code>  </code><code>`province_id` int(10) unsigned  not null comment</code><code>'省份編号'</code><code>,</code>

<code>  </code><code>`city_name` varchar(25) default null comment</code><code>'城市名稱'</code><code>,</code>

<code>  </code><code>`description` varchar(25) default null comment</code><code>'描述'</code><code>,</code>

<code>  </code><code>primary key (`</code><code>id</code><code>`)</code>

<code>) engine=innodb auto_increment=1 default charset=utf8;</code>

c.插入資料

<code>insert city values (1 ,1,</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</code><code>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-04-13 18:29:00.273  info 13038 --- [nio-8080-</code><code>exec</code><code>-1] o.s.s.service.impl.cityserviceimpl       : cityserviceimpl.findcitybyid() : 城市插入緩存 &gt;&gt; city{</code><code>id</code><code>=12, provinceid=3, cityname=</code><code>'三亞'</code><code>, description=</code><code>'水好,天藍'</code><code>}</code>

<code>2017-04-13 18:29:03.145  info 13038 --- [nio-8080-</code><code>exec</code><code>-2] o.s.s.service.impl.cityserviceimpl       : cityserviceimpl.findcitybyid() : 從緩存中擷取了城市 &gt;&gt; city{</code><code>id</code><code>=12, provinceid=3, 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-04-13 18:29:52.248  info 13038 --- [nio-8080-</code><code>exec</code><code>-9] o.s.s.service.impl.cityserviceimpl       : cityserviceimpl.deletecity() : 從緩存中删除城市 id &gt;&gt; 12</code>

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

pom.xml 依賴配置:

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

<code>&lt;?xml version=</code><code>"1.0"</code> <code>encoding=</code><code>"utf-8"</code><code>?&gt;</code>

<code>&lt;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>&gt;</code>

<code>    </code><code>&lt;modelversion&gt;4.0.0&lt;</code><code>/modelversion</code><code>&gt;</code>

<code>    </code><code>&lt;groupid&gt;springboot&lt;</code><code>/groupid</code><code>&gt;</code>

<code>    </code><code>&lt;artifactid&gt;springboot-mybatis-redis&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>    </code><code>&lt;version&gt;0.0.1-snapshot&lt;</code><code>/version</code><code>&gt;</code>

<code>    </code><code>&lt;name&gt;springboot-mybatis-redis :: 整合 mybatis 并使用 redis 作為緩存&lt;</code><code>/name</code><code>&gt;</code>

<code>    </code><code>&lt;!-- spring boot 啟動父依賴 --&gt;</code>

<code>    </code><code>&lt;parent&gt;</code>

<code>        </code><code>&lt;groupid&gt;org.springframework.boot&lt;</code><code>/groupid</code><code>&gt;</code>

<code>        </code><code>&lt;artifactid&gt;spring-boot-starter-parent&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>        </code><code>&lt;version&gt;1.5.1.release&lt;</code><code>/version</code><code>&gt;</code>

<code>    </code><code>&lt;</code><code>/parent</code><code>&gt;</code>

<code>    </code><code>&lt;properties&gt;</code>

<code>        </code><code>&lt;mybatis-spring-boot&gt;1.2.0&lt;</code><code>/mybatis-spring-boot</code><code>&gt;</code>

<code>        </code><code>&lt;mysql-connector&gt;5.1.39&lt;</code><code>/mysql-connector</code><code>&gt;</code>

<code>        </code><code>&lt;spring-boot-starter-redis-version&gt;1.3.2.release&lt;</code><code>/spring-boot-starter-redis-version</code><code>&gt;</code>

<code>    </code><code>&lt;</code><code>/properties</code><code>&gt;</code>

<code>    </code><code>&lt;dependencies&gt;</code>

<code>        </code><code>&lt;!-- spring boot reids 依賴 --&gt;</code>

<code>        </code><code>&lt;dependency&gt;</code>

<code>            </code><code>&lt;groupid&gt;org.springframework.boot&lt;</code><code>/groupid</code><code>&gt;</code>

<code>            </code><code>&lt;artifactid&gt;spring-boot-starter-redis&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>            </code><code>&lt;version&gt;${spring-boot-starter-redis-version}&lt;</code><code>/version</code><code>&gt;</code>

<code>        </code><code>&lt;</code><code>/dependency</code><code>&gt;</code>

<code>        </code><code>&lt;!-- spring boot web 依賴 --&gt;</code>

<code>            </code><code>&lt;artifactid&gt;spring-boot-starter-web&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>        </code><code>&lt;!-- spring boot test 依賴 --&gt;</code>

<code>            </code><code>&lt;artifactid&gt;spring-boot-starter-</code><code>test</code><code>&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>            </code><code>&lt;scope&gt;</code><code>test</code><code>&lt;</code><code>/scope</code><code>&gt;</code>

<code>        </code><code>&lt;!-- spring boot mybatis 依賴 --&gt;</code>

<code>            </code><code>&lt;groupid&gt;org.mybatis.spring.boot&lt;</code><code>/groupid</code><code>&gt;</code>

<code>            </code><code>&lt;artifactid&gt;mybatis-spring-boot-starter&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>            </code><code>&lt;version&gt;${mybatis-spring-boot}&lt;</code><code>/version</code><code>&gt;</code>

<code>        </code><code>&lt;!-- mysql 連接配接驅動依賴 --&gt;</code>

<code>            </code><code>&lt;groupid&gt;mysql&lt;</code><code>/groupid</code><code>&gt;</code>

<code>            </code><code>&lt;artifactid&gt;mysql-connector-java&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>            </code><code>&lt;version&gt;${mysql-connector}&lt;</code><code>/version</code><code>&gt;</code>

<code>        </code><code>&lt;!-- junit --&gt;</code>

<code>            </code><code>&lt;groupid&gt;junit&lt;</code><code>/groupid</code><code>&gt;</code>

<code>            </code><code>&lt;artifactid&gt;junit&lt;</code><code>/artifactid</code><code>&gt;</code>

<code>            </code><code>&lt;version&gt;4.12&lt;</code><code>/version</code><code>&gt;</code>

<code>    </code><code>&lt;</code><code>/dependencies</code><code>&gt;</code>

<code>&lt;</code><code>/project</code><code>&gt;</code>

包括了 spring boot reids 依賴、 mysql 依賴和 mybatis 依賴。

在 application.properties 應用配置檔案,增加 redis 相關配置

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

<code>spring.datasource.url=jdbc:mysql:</code><code>//localhost</code><code>:3306</code><code>/springbootdb</code><code>?useunicode=</code><code>true</code><code>&amp;characterencoding=utf8</code>

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

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

<code>spring.datasource.driver-class-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資料庫索引(預設為0)</code>

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

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

<code>spring.redis.host=127.0.0.1</code>

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

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

<code>## redis伺服器連接配接密碼(預設為空)</code>

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

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

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

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

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

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

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

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

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

<code>## 連接配接逾時時間(毫秒)</code>

<code>spring.redis.timeout=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</code><code>type</code>

city.java 城市對象:

68

69

70

71

72

73

74

75

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

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

<code>/**</code>

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

<code> </code><code>*</code>

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

<code> </code><code>*/</code>

<code>public class city implements serializable {</code>

<code>    </code><code>private static final long serialversionuid = -1l;</code>

<code>    </code><code>/**</code>

<code>     </code><code>* 城市編号</code>

<code>     </code><code>*/</code>

<code>    </code><code>private long</code><code>id</code><code>;</code>

<code>     </code><code>* 省份編号</code>

<code>    </code><code>private long provinceid;</code>

<code>     </code><code>* 城市名稱</code>

<code>    </code><code>private string cityname;</code>

<code>     </code><code>* 描述</code>

<code>    </code><code>private string description;</code>

<code>    </code><code>public long getid() {</code>

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

<code>    </code><code>}</code>

<code>    </code><code>public void setid(long</code><code>id</code><code>) {</code>

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

<code>    </code><code>public long getprovinceid() {</code>

<code>        </code><code>return</code> <code>provinceid;</code>

<code>    </code><code>public void setprovinceid(long provinceid) {</code>

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

<code>    </code><code>public string getcityname() {</code>

<code>        </code><code>return</code> <code>cityname;</code>

<code>    </code><code>public void setcityname(string cityname) {</code>

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

<code>    </code><code>public string getdescription() {</code>

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

<code>    </code><code>public void setdescription(string description) {</code>

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

<code>    </code><code>@override</code>

<code>    </code><code>public string tostring() {</code>

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

<code>                </code><code>"id="</code> <code>+</code><code>id</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>

<code>                </code><code>'}'</code><code>;</code>

<code>}</code>

如果需要自定義序列化實作,隻要實作 redisserializer 接口去實作即可,然後在使用 redistemplate.setvalueserializer 方法去設定你實作的序列化實作。

主要還是城市業務邏輯實作類 cityserviceimpl.java:

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

<code>package 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> </code><code>* &lt;p&gt;</code>

<code>@service</code>

<code>public class cityserviceimpl implements cityservice {</code>

<code>    </code><code>private static final logger logger = loggerfactory.getlogger(cityserviceimpl.class);</code>

<code>    </code><code>@autowired</code>

<code>    </code><code>private citydao citydao;</code>

<code>    </code><code>private redistemplate redistemplate;</code>

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

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

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

<code>    </code><code>public city findcitybyid(long</code><code>id</code><code>) {</code>

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

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

<code>        </code><code>valueoperations&lt;string, city&gt; operations = redistemplate.opsforvalue();</code>

<code>        </code><code>//</code> <code>緩存存在</code>

<code>        </code><code>boolean 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() : 從緩存中擷取了城市 &gt;&gt; "</code> <code>+ city.tostring());</code>

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

<code>        </code><code>}</code>

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

<code>        </code><code>city city = citydao.findbyid(</code><code>id</code><code>);</code>

<code>        </code><code>//</code> <code>插入緩存</code>

<code>        </code><code>operations.</code><code>set</code><code>(key, city, 10, timeunit.seconds);</code>

<code>        </code><code>logger.info(</code><code>"cityserviceimpl.findcitybyid() : 城市插入緩存 &gt;&gt; "</code> <code>+ city.tostring());</code>

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

<code>    </code><code>public 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 long updatecity(city city) {</code>

<code>        </code><code>long ret = citydao.updatecity(city);</code>

<code>        </code><code>//</code> <code>緩存存在,删除緩存</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() : 從緩存中删除城市 &gt;&gt; "</code> <code>+ city.tostring());</code>

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

<code>    </code><code>public long deletecity(long</code><code>id</code><code>) {</code>

<code>        </code><code>long ret = citydao.deletecity(</code><code>id</code><code>);</code>

<code>            </code><code>logger.info(</code><code>"cityserviceimpl.deletecity() : 從緩存中删除城市 id &gt;&gt; "</code> <code>+</code><code>id</code><code>);</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 緩存時,一個是緩存對象需要序列化,二個是緩存更新政策是如何的。

歡迎掃一掃我的公衆号關注 — 及時得到部落格訂閱哦!

Spring Boot 整合 Redis 實作緩存操作