Spring Boot 整合 Redis 實現緩存操作
摘要: 原創出處 泥瓦匠BYSocket
歡迎轉載,保留摘要,謝謝!
三、運行 springboot-mybatis-redis 工程案例
四、springboot-mybatis-redis 工程代碼配置詳解運行環境:Mac OS 10.12.xJDK 8 +Redis 3.2.8Spring Boot 1.5.1.RELEASE一、緩存的應用場景
什麼是緩存?
在互聯網場景下,尤其 2C 端大流量場景下,需要將一些經常展現和不會頻繁變更的數據,存放在存取速率更快的地方。緩存就是一個存儲器,在技術選型中,常用 Redis 作為緩存資料庫。緩存主要是在獲取資源方便性能優化的關鍵方面。Redis 是一個高性能的 key-value 資料庫。GitHub 地址: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 獲取。減少了去資料庫查詢的次數。但會出現新的問題,就是如何對緩存進行更新?這就是下面要講的。二、更新緩存的策略
參考《緩存更新的套路》緩存更新的套路 | | 酷 殼 - CoolShell,緩存更新的模式有四種: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 – JeffLi1993/springboot-learning-example。
下面開始運行工程步驟(Quick Start):1.資料庫和 Redis 準備a.創建資料庫 springbootdb:
CREATE DATABASE springbootdb;n
b.創建表 city :(因為我喜歡徒步)
DROP TABLE IF EXISTS `city`;nCREATE TABLE `city` (n `id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT 城市編號,n `province_id` int(10) unsigned NOT NULL COMMENT 省份編號,n `city_name` varchar(25) DEFAULT NULL COMMENT 城市名稱,n `description` varchar(25) DEFAULT NULL COMMENT 描述,n PRIMARY KEY (`id`)n) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;n
c.插入數據
INSERT city VALUES (1 ,1,溫嶺市,BYSocket 的家在溫嶺。);n
springboot-mybatis-redis 工程項目結構如下圖所示:norg.spring.springboot.controller - Controller 層norg.spring.springboot.dao - 數據操作層 DAOnorg.spring.springboot.domain - 實體類norg.spring.springboot.service - 業務邏輯層nApplication - 應用啟動類napplication.properties - 應用配置文件,應用啟動會自動讀取配置n
mvn clean installn
5.運行工程 右鍵運行 springboot-mybatis-redis 工程 Application 應用啟動類的 main 函數。項目運行成功後,這是個 HTTP OVER JSON 服務項目。所以用 postman 工具可以如下操作根據 ID,獲取城市信息GET http://127.0.0.1:8080/api/city/1再請求一次,獲取城市信息會發現數據獲取的耗時快了很多。服務端 Console 輸出的日誌:
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=水好,天藍}n2017-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=水好,天藍}n
可見,第一次是從資料庫 DB 獲取數據,並插入緩存,第二次直接從緩存中取。
更新城市信息PUT http://127.0.0.1:8080/api/city刪除城市信息DELETE http://127.0.0.1:8080/api/city/2這兩種操作中,如果緩存有對應的數據,則刪除緩存。服務端 Console 輸出的日誌:2017-04-13 18:29:52.248 INFO 13038 --- [nio-8080-exec-9] o.s.s.service.impl.CityServiceImpl : CityServiceImpl.deleteCity() : 從緩存中刪除城市 ID >> 12n
四、springboot-mybatis-redis 工程代碼配置詳解
這裡,我強烈推薦 註解 的方式實現對象的緩存。但是這裡為了更好說明緩存更新策略。下面講講工程代碼的實現。
pom.xml 依賴配置:<?xml version="1.0" encoding="UTF-8"?>n<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"n xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">n <modelVersion>4.0.0</modelVersion>n n <groupId>springboot</groupId>n <artifactId>springboot-mybatis-redis</artifactId>n <version>0.0.1-SNAPSHOT</version>n <name>springboot-mybatis-redis :: 整合 Mybatis 並使用 Redis 作為緩存</name>n n <!-- Spring Boot 啟動父依賴 -->n <parent>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-parent</artifactId>n <version>1.5.1.RELEASE</version>n </parent>n n <properties>n <mybatis-spring-boot>1.2.0</mybatis-spring-boot>n <mysql-connector>5.1.39</mysql-connector>n <spring-boot-starter-redis-version>1.3.2.RELEASE</spring-boot-starter-redis-version>n </properties>n n <dependencies>n n <!-- Spring Boot Reids 依賴 -->n <dependency>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-redis</artifactId>n <version>${spring-boot-starter-redis-version}</version>n </dependency>n n <!-- Spring Boot Web 依賴 -->n <dependency>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-web</artifactId>n </dependency>n n <!-- Spring Boot Test 依賴 -->n <dependency>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-test</artifactId>n <scope>test</scope>n </dependency>n n <!-- Spring Boot Mybatis 依賴 -->n <dependency>n <groupId>org.mybatis.spring.boot</groupId>n <artifactId>mybatis-spring-boot-starter</artifactId>n <version>${mybatis-spring-boot}</version>n </dependency>n n <!-- MySQL 連接驅動依賴 -->n <dependency>n <groupId>mysql</groupId>n <artifactId>mysql-connector-java</artifactId>n <version>${mysql-connector}</version>n </dependency>n n <!-- Junit -->n <dependency>n <groupId>junit</groupId>n <artifactId>junit</artifactId>n <version>4.12</version>n </dependency>n </dependencies>n</project>n
包括了 Spring Boot Reids 依賴、 MySQL 依賴和 Mybatis 依賴。
在 application.properties 應用配置文件,增加 Redis 相關配置
## 數據源配置nspring.datasource.url=jdbc:mysql://localhost:3306/springbootdb?useUnicode=true&characterEncoding=utf8nspring.datasource.username=rootnspring.datasource.password=123456nspring.datasource.driver-class-name=com.mysql.jdbc.Drivern n## Mybatis 配置nmybatis.typeAliasesPackage=org.spring.springboot.domainnmybatis.mapperLocations=classpath:mapper/*.xmln n## Redis 配置n## Redis資料庫索引(默認為0)nspring.redis.database=0n## Redis伺服器地址nspring.redis.host=127.0.0.1n## Redis伺服器連接埠nspring.redis.port=6379n## Redis伺服器連接密碼(默認為空)nspring.redis.password=n## 連接池最大連接數(使用負值表示沒有限制)nspring.redis.pool.max-active=8n## 連接池最大阻塞等待時間(使用負值表示沒有限制)nspring.redis.pool.max-wait=-1n## 連接池中的最大空閑連接nspring.redis.pool.max-idle=8n## 連接池中的最小空閑連接nspring.redis.pool.min-idle=0n## 連接超時時間(毫秒)nspring.redis.timeout=0n
Serializablenjava.lang.IllegalArgumentException: DefaultSerializer requires a Serializable payload but received an object of typen
City.java 城市對象:
package org.spring.springboot.domain;n nimport java.io.Serializable;n n/**n * 城市實體類n *n * Created by bysocket on 07/02/2017.n */npublic class City implements Serializable {n n private static final long serialVersionUID = -1L;n n /**n * 城市編號n */n private Long id;n n /**n * 省份編號n */n private Long provinceId;n n /**n * 城市名稱n */n private String cityName;n n /**n * 描述n */n private String description;n n public Long getId() {n return id;n }n n public void setId(Long id) {n this.id = id;n }n n public Long getProvinceId() {n return provinceId;n }n n public void setProvinceId(Long provinceId) {n this.provinceId = provinceId;n }n n public String getCityName() {n return cityName;n }n n public void setCityName(String cityName) {n this.cityName = cityName;n }n n public String getDescription() {n return description;n }n n public void setDescription(String description) {n this.description = description;n }n n @Overriden public String toString() {n return "City{" +n "id=" + id +n ", provinceId=" + provinceId +n ", cityName=" + cityName + +n ", description=" + description + +n };n }n}n
如果需要自定義序列化實現,只要實現 RedisSerializer 介面去實現即可,然後在使用 RedisTemplate.setValueSerializer 方法去設置你實現的序列化實現。
主要還是城市業務邏輯實現類 CityServiceImpl.java:package org.spring.springboot.service.impl;n nimport org.slf4j.Logger;nimport org.slf4j.LoggerFactory;nimport org.spring.springboot.dao.CityDao;nimport org.spring.springboot.domain.City;nimport org.spring.springboot.service.CityService;nimport org.springframework.beans.factory.annotation.Autowired;nimport org.springframework.data.redis.core.RedisTemplate;nimport org.springframework.data.redis.core.StringRedisTemplate;nimport org.springframework.data.redis.core.ValueOperations;nimport org.springframework.stereotype.Service;n nimport java.util.List;nimport java.util.concurrent.TimeUnit;n n/**n * 城市業務邏輯實現類n * <p>n * Created by bysocket on 07/02/2017.n */n@Servicenpublic class CityServiceImpl implements CityService {n n private static final Logger LOGGER = LoggerFactory.getLogger(CityServiceImpl.class);n n @Autowiredn private CityDao cityDao;n n @Autowiredn private RedisTemplate redisTemplate;n n /**n * 獲取城市邏輯:n * 如果緩存存在,從緩存中獲取城市信息n * 如果緩存不存在,從 DB 中獲取城市信息,然後插入緩存n */n public City findCityById(Long id) {n // 從緩存中獲取城市信息n String key = "city_" + id;n ValueOperations<String, City> operations = redisTemplate.opsForValue();n n // 緩存存在n boolean hasKey = redisTemplate.hasKey(key);n if (hasKey) {n City city = operations.get(key);n n LOGGER.info("CityServiceImpl.findCityById() : 從緩存中獲取了城市 >> " + city.toString());n return city;n }n n // 從 DB 中獲取城市信息n City city = cityDao.findById(id);n n // 插入緩存n operations.set(key, city, 10, TimeUnit.SECONDS);n LOGGER.info("CityServiceImpl.findCityById() : 城市插入緩存 >> " + city.toString());n n return city;n }n n @Overriden public Long saveCity(City city) {n return cityDao.saveCity(city);n }n n /**n * 更新城市邏輯:n * 如果緩存存在,刪除n * 如果緩存不存在,不操作n */n @Overriden public Long updateCity(City city) {n Long ret = cityDao.updateCity(city);n n // 緩存存在,刪除緩存n String key = "city_" + city.getId();n boolean hasKey = redisTemplate.hasKey(key);n if (hasKey) {n redisTemplate.delete(key);n n LOGGER.info("CityServiceImpl.updateCity() : 從緩存中刪除城市 >> " + city.toString());n }n n return ret;n }n n @Overriden public Long deleteCity(Long id) {n n Long ret = cityDao.deleteCity(id);n n // 緩存存在,刪除緩存n String key = "city_" + id;n boolean hasKey = redisTemplate.hasKey(key);n if (hasKey) {n redisTemplate.delete(key);n n LOGGER.info("CityServiceImpl.deleteCity() : 從緩存中刪除城市 ID >> " + id);n }n return ret;n }n n}n
首先這裡注入了 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 ,工程代碼註解很詳細。 JeffLi1993/springboot-learning-example。五、小結
本文涉及到 Spring Boot 在使用 Redis 緩存時,一個是緩存對象需要序列化,二個是緩存更新策略是如何的。
推薦閱讀:
※Spring探秘,妙用BeanPostProcessor
※史上最簡單的SpringCloud教程: docker部署spring cloud項目
※Ribbon源碼分析系列(一)
TAG:Spring | SpringBoot |