摘要: 原创出处 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:
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() : 城市插入缓存 >> 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() : 从缓存中获取了城市 >> 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 >> 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><?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><modelversion>4.0.0<</code><code>/modelversion</code><code>></code>
<code> </code><code><groupid>springboot<</code><code>/groupid</code><code>></code>
<code> </code><code><artifactid>springboot-mybatis-redis<</code><code>/artifactid</code><code>></code>
<code> </code><code><version>0.0.1-snapshot<</code><code>/version</code><code>></code>
<code> </code><code><name>springboot-mybatis-redis :: 整合 mybatis 并使用 redis 作为缓存<</code><code>/name</code><code>></code>
<code> </code><code><!-- spring boot 启动父依赖 --></code>
<code> </code><code><parent></code>
<code> </code><code><groupid>org.springframework.boot<</code><code>/groupid</code><code>></code>
<code> </code><code><artifactid>spring-boot-starter-parent<</code><code>/artifactid</code><code>></code>
<code> </code><code><version>1.5.1.release<</code><code>/version</code><code>></code>
<code> </code><code><</code><code>/parent</code><code>></code>
<code> </code><code><properties></code>
<code> </code><code><mybatis-spring-boot>1.2.0<</code><code>/mybatis-spring-boot</code><code>></code>
<code> </code><code><mysql-connector>5.1.39<</code><code>/mysql-connector</code><code>></code>
<code> </code><code><spring-boot-starter-redis-version>1.3.2.release<</code><code>/spring-boot-starter-redis-version</code><code>></code>
<code> </code><code><</code><code>/properties</code><code>></code>
<code> </code><code><dependencies></code>
<code> </code><code><!-- spring boot reids 依赖 --></code>
<code> </code><code><dependency></code>
<code> </code><code><groupid>org.springframework.boot<</code><code>/groupid</code><code>></code>
<code> </code><code><artifactid>spring-boot-starter-redis<</code><code>/artifactid</code><code>></code>
<code> </code><code><version>${spring-boot-starter-redis-version}<</code><code>/version</code><code>></code>
<code> </code><code><</code><code>/dependency</code><code>></code>
<code> </code><code><!-- spring boot web 依赖 --></code>
<code> </code><code><artifactid>spring-boot-starter-web<</code><code>/artifactid</code><code>></code>
<code> </code><code><!-- spring boot test 依赖 --></code>
<code> </code><code><artifactid>spring-boot-starter-</code><code>test</code><code><</code><code>/artifactid</code><code>></code>
<code> </code><code><scope></code><code>test</code><code><</code><code>/scope</code><code>></code>
<code> </code><code><!-- spring boot mybatis 依赖 --></code>
<code> </code><code><groupid>org.mybatis.spring.boot<</code><code>/groupid</code><code>></code>
<code> </code><code><artifactid>mybatis-spring-boot-starter<</code><code>/artifactid</code><code>></code>
<code> </code><code><version>${mybatis-spring-boot}<</code><code>/version</code><code>></code>
<code> </code><code><!-- mysql 连接驱动依赖 --></code>
<code> </code><code><groupid>mysql<</code><code>/groupid</code><code>></code>
<code> </code><code><artifactid>mysql-connector-java<</code><code>/artifactid</code><code>></code>
<code> </code><code><version>${mysql-connector}<</code><code>/version</code><code>></code>
<code> </code><code><!-- junit --></code>
<code> </code><code><groupid>junit<</code><code>/groupid</code><code>></code>
<code> </code><code><artifactid>junit<</code><code>/artifactid</code><code>></code>
<code> </code><code><version>4.12<</code><code>/version</code><code>></code>
<code> </code><code><</code><code>/dependencies</code><code>></code>
<code><</code><code>/project</code><code>></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>&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>* <p></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<string, city> 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() : 从缓存中获取了城市 >> "</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() : 城市插入缓存 >> "</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() : 从缓存中删除城市 >> "</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 >> "</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 缓存时,一个是缓存对象需要序列化,二个是缓存更新策略是如何的。
欢迎扫一扫我的公众号关注 — 及时得到博客订阅哦!