no-image

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

 

強烈推薦讀者 – 

「springboot-learning-example」開源專案,Star 一下

spring boot 實踐學習案例,是 spring boot 初學者及核心技術鞏固的最佳實踐。
https://git.oschina.net/jeff1993/springboot-learning-example

 

 

一、快取的應用場景

什麼是快取?

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

Redis 是一個高效能的 key-value 資料庫。GitHub 地址:https://github.com/antirez/redis 。Github 是這麼描述的:

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 獲取。減少了去資料庫查詢的次數。但會出現新的問題,就是如何對快取進行更新?這就是下面要講的。

二、更新快取的策略

參考《快取更新的套路》http://coolshell.cn/articles/17416.html,快取更新的模式有四種:Cache aside, Read through, Write through, Write behind caching。

這裡我們使用的是 Cache Aside 策略,從三個維度:(摘自 耗子叔叔部落格)

失效:應用程式先從cache取資料,沒有得到,則從資料庫中取資料,成功後,放到快取中。

命中:應用程式從cache中取資料,取到後返回。

更新:先把資料存到資料庫中,成功後,再讓快取失效。

大致流程如下:

獲取商品詳情舉例

a. 從商品 Cache 中獲取商品詳情,如果存在,則返回獲取 Cache 資料返回。

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

c. 從商品 DB 中更新或者刪除商品詳情成功後,則從快取中刪除對應商品的詳情快取

三、執行 springboot-mybatis-redis 工程案例

git clone 下載工程 springboot-learning-example ,專案地址見 GitHub – https://github.com/JeffLi1993/springboot-learning-example

下面開始執行工程步驟(Quick Start):

1.資料庫和 Redis 準備

a.建立資料庫 springbootdb:

1

CREATE DATABASE springbootdb;

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

1

2

3

4

5

6

7

8

DROP TABLE IF EXISTS  `city`;

CREATE TABLE `city` (

  `id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '城市編號',

  `province_id` int(10) unsigned  NOT NULL COMMENT '省份編號',

  `city_name` varchar(25) DEFAULT NULL COMMENT '城市名稱',

  `description` varchar(25) DEFAULT NULL COMMENT '描述',

  PRIMARY KEY (`id`)

) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

c.插入資料

1

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

d.本地安裝 Redis

詳見寫過的文章《 Redis 安裝 》http://www.bysocket.com/?p=917

2. springboot-mybatis-redis 工程專案結構介紹

1

2

3

4

5

6

7

springboot-mybatis-redis 工程專案結構如下圖所示:

org.spring.springboot.controller - Controller 層

org.spring.springboot.dao - 資料操作層 DAO

org.spring.springboot.domain - 實體類

org.spring.springboot.service - 業務邏輯層

Application - 應用啟動類

application.properties - 應用配置檔案,應用啟動會自動讀取配置

3.改資料庫配置

開啟 application.properties 檔案, 修改相應的資料來源配置,比如資料來源地址、賬號、密碼等。

(如果不是用 MySQL,自行新增連線驅動 pom,然後修改驅動名配置。)

4.編譯工程

在專案根目錄 springboot-learning-example,執行 maven 指令:

1

mvn clean install

5.執行工程

右鍵執行 springboot-mybatis-redis 工程 Application 應用啟動類的 main 函式。

專案執行成功後,這是個 HTTP OVER JSON 服務專案。所以用 postman 工具可以如下操作

根據 ID,獲取城市資訊

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

再請求一次,獲取城市資訊會發現資料獲取的耗時快了很多。服務端 Console 輸出的日誌:

1

2

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

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

可見,第一次是從資料庫 DB 獲取資料,並插入快取,第二次直接從快取中取。

更新城市資訊

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

刪除城市資訊

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

這兩種操作中,如果快取有對應的資料,則刪除快取。服務端 Console 輸出的日誌:

1

2017-04-13 18:29:52.248  INFO 13038 --- [nio-8080-exec-9] o.s.s.service.impl.CityServiceImpl       : CityServiceImpl.deleteCity() : 從快取中刪除城市 ID >> 12

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

這裡,我強烈推薦 註解 的方式實現物件的快取。但是這裡為了更好說明快取更新策略。下面講講工程程式碼的實現。

pom.xml 依賴配置:

1

2

3

4

5

6

7

8

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

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

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

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

    <modelVersion>4.0.0</modelVersion>

 

    <groupId>springboot</groupId>

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

    <version>0.0.1-SNAPSHOT</version>

    <name>springboot-mybatis-redis :: 整合 Mybatis 並使用 Redis 作為快取</name>

 

    <!-- Spring Boot 啟動父依賴 -->

    <parent>

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

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

        <version>1.5.1.RELEASE</version>

    </parent>

 

    <properties>

        <mybatis-spring-boot>1.2.0</mybatis-spring-boot>

        <mysql-connector>5.1.39</mysql-connector>

        <spring-boot-starter-redis-version>1.3.2.RELEASE</spring-boot-starter-redis-version>

    </properties>

 

    <dependencies>

 

        <!-- Spring Boot Reids 依賴 -->

        <dependency>

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

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

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

        </dependency>

 

        <!-- Spring Boot Web 依賴 -->

        <dependency>

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

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

        </dependency>

 

        <!-- Spring Boot Test 依賴 -->

        <dependency>

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

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

            <scope>test</scope>

        </dependency>

 

        <!-- Spring Boot Mybatis 依賴 -->

        <dependency>

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

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

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

        </dependency>

 

        <!-- MySQL 連線驅動依賴 -->

        <dependency>

            <groupId>mysql</groupId>

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

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

        </dependency>

 

        <!-- Junit -->

        <dependency>

            <groupId>junit</groupId>

            <artifactId>junit</artifactId>

            <version>4.12</version>

        </dependency>

    </dependencies>

</project>

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

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

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

## 資料來源配置

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

spring.datasource.username=root

spring.datasource.password=123456

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

 

## Mybatis 配置

mybatis.typeAliasesPackage=org.spring.springboot.domain

mybatis.mapperLocations=classpath:mapper/*.xml

 

## Redis 配置

## Redis資料庫索引(預設為0)

spring.redis.database=0

## Redis伺服器地址

spring.redis.host=127.0.0.1

## Redis伺服器連線埠

spring.redis.port=6379

## Redis伺服器連線密碼(預設為空)

spring.redis.password=

## 連線池最大連線數(使用負值表示沒有限制)

spring.redis.pool.max-active=8

## 連線池最大阻塞等待時間(使用負值表示沒有限制)

spring.redis.pool.max-wait=-1

## 連線池中的最大空閒連線

spring.redis.pool.max-idle=8

## 連線池中的最小空閒連線

spring.redis.pool.min-idle=0

## 連線超時時間(毫秒)

spring.redis.timeout=0

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

CityRestController 控制層依舊是 Restful 風格的,詳情可以參考《Springboot 實現 Restful 服務,基於 HTTP / JSON 傳輸》。 http://www.bysocket.com/?p=1627 domain 物件 City 必須實現序列化,因為需要將物件序列化後儲存到 Redis。如果沒實現 Serializable ,控制檯會爆出以下異常:

1

2

Serializable

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

City.java 城市物件:

1

2

3

4

5

6

7

8

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

68

69

70

71

72

73

74

75

package org.spring.springboot.domain;

 

import java.io.Serializable;

 

/**

 * 城市實體類

 *

 * Created by bysocket on 07/02/2017.

 */

public class City implements Serializable {

 

    private static final long serialVersionUID = -1L;

 

    /**

     * 城市編號

     */

    private Long id;

 

    /**

     * 省份編號

     */

    private Long provinceId;

 

    /**

     * 城市名稱

     */

    private String cityName;

 

    /**

     * 描述

     */

    private String description;

 

    public Long getId() {

        return id;

    }

 

    public void setId(Long id) {

        this.id = id;

    }

 

    public Long getProvinceId() {

        return provinceId;

    }

 

    public void setProvinceId(Long provinceId) {

        this.provinceId = provinceId;

    }

 

    public String getCityName() {

        return cityName;

    }

 

    public void setCityName(String cityName) {

        this.cityName = cityName;

    }

 

    public String getDescription() {

        return description;

    }

 

    public void setDescription(String description) {

        this.description = description;

    }

 

    @Override

    public String toString() {

        return "City{"

                "id=" id

                ", provinceId=" provinceId

                ", cityName='" cityName '\''

                ", description='" description '\''

                '}';

    }

}

如果需要自定義序列化實現,只要實現 RedisSerializer 介面去實現即可,然後在使用 RedisTemplate.setValueSerializer 方法去設定你實現的序列化實現。

主要還是城市業務邏輯實現類 CityServiceImpl.java:

1

2

3

4

5

6

7

8

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

68

69

70

71

72

73

74

75

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

package org.spring.springboot.service.impl;

 

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.spring.springboot.dao.CityDao;

import org.spring.springboot.domain.City;

import org.spring.springboot.service.CityService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.data.redis.core.RedisTemplate;

import org.springframework.data.redis.core.StringRedisTemplate;

import org.springframework.data.redis.core.ValueOperations;

import org.springframework.stereotype.Service;

 

import java.util.List;

import java.util.concurrent.TimeUnit;

 

/**

 * 城市業務邏輯實現類

 * <p>

 * Created by bysocket on 07/02/2017.

 */

@Service

public class CityServiceImpl implements CityService {

 

    private static final Logger LOGGER = LoggerFactory.getLogger(CityServiceImpl.class);

 

    @Autowired

    private CityDao cityDao;

 

    @Autowired

    private RedisTemplate redisTemplate;

 

    /**

     * 獲取城市邏輯:

     * 如果快取存在,從快取中獲取城市資訊

     * 如果快取不存在,從 DB 中獲取城市資訊,然後插入快取

     */

    public City findCityById(Long id) {

        // 從快取中獲取城市資訊

        String key = "city_" id;

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

 

        // 快取存在

        boolean hasKey = redisTemplate.hasKey(key);

        if (hasKey) {

            City city = operations.get(key);

 

            LOGGER.info("CityServiceImpl.findCityById() : 從快取中獲取了城市 >> " city.toString());

            return city;

        }

 

        // 從 DB 中獲取城市資訊

        City city = cityDao.findById(id);

 

        // 插入快取

        operations.set(key, city, 10, TimeUnit.SECONDS);

        LOGGER.info("CityServiceImpl.findCityById() : 城市插入快取 >> " city.toString());

 

        return city;

    }

 

    @Override

    public Long saveCity(City city) {

        return cityDao.saveCity(city);

    }

 

    /**

     * 更新城市邏輯:

     * 如果快取存在,刪除

     * 如果快取不存在,不操作

     */

    @Override

    public Long updateCity(City city) {

        Long ret = cityDao.updateCity(city);

 

        // 快取存在,刪除快取

        String key = "city_" city.getId();

        boolean hasKey = redisTemplate.hasKey(key);

        if (hasKey) {

            redisTemplate.delete(key);

 

            LOGGER.info("CityServiceImpl.updateCity() : 從快取中刪除城市 >> " city.toString());

        }

 

        return ret;

    }

 

    @Override

    public Long deleteCity(Long id) {

 

        Long ret = cityDao.deleteCity(id);

 

        // 快取存在,刪除快取

        String key = "city_" id;

        boolean hasKey = redisTemplate.hasKey(key);

        if (hasKey) {

            redisTemplate.delete(key);

 

            LOGGER.info("CityServiceImpl.deleteCity() : 從快取中刪除城市 ID >> " id);

        }

        return ret;

    }

 

}

首先這裡注入了 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 快取時,一個是快取物件需要序列化,二個是快取更新策略是如何的。

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

— http://www.bysocket.com/ —

— https://github.com/JeffLi1993 —

關聯文章