redistemplate文档用法_Spring学习笔记之RedisTemplate的配置与使用教程
前言
Spring针对Redis的使用,封装了一个比较强大的Template以方便使用;之前在Spring的生态圈中也使用过redis,但直接使用Jedis进行相应的交互操作,现在正好来看一下RedisTemplate是怎么实现的,以及使用起来是否更加便利
I. 基本配置
1. 依赖
依然是采用Jedis进行连接池管理,因此除了引入 spring-data-redis之外,再加上jedis依赖,pom文件中添加
org.springframework.data
spring-data-redis
1.8.4.RELEASE
redis.clients
jedis
2.9.0
如果需要指定序列化相关参数,也可以引入jackson,本篇为简单入门级,就不加这个了
2. 配置文件
准备redis相关的配置参数,常见的有host, port, password, timeout…,下面是一份简单的配置,并给出了相应的含义
redis.hostName=127.0.0.1
redis.port=6379
redis.password=https://blog.hhui.top
# 连接超时时间
redis.timeout=10000
#最大空闲数
redis.maxIdle=300
#控制一个pool可分配多少个jedis实例,用来替换上面的redis.maxActive,如果是jedis 2.4以后用该属性
redis.maxTotal=1000
#最大建立连接等待时间。如果超过此时间将接到异常。设为-1表示无限制。
redis.maxWaitMillis=1000
#连接的最小空闲时间 默认1800000毫秒(30分钟)
redis.minEvictableIdleTimeMillis=300000
#每次释放连接的最大数目,默认3
redis.numTestsPerEvictionRun=1024
#逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程, 默认-1
redis.timeBetweenEvictionRunsMillis=30000
#是否在从池中取出连接前进行检验,如果检验失败,则从池中去除连接并尝试取出另一个
redis.testOnBorrow=true
#在空闲时检查有效性, 默认false
redis.testWhileIdle=true
说明
redis密码请一定记得设置,特别是在允许远程访问的时候,如果没有密码,默认端口号,很容易就被是扫描注入脚本,然后开始给人挖矿(亲身经历…)
II. 使用与测试
根据一般的思路,首先是得加载上面的配置,创建redis连接池,然后再实例化RedisTemplate对象,最后持有这个实力开始各种读写操作
1. 配置类
使用JavaConfig的方式来配置,主要是两个Bean,读取配置文件设置各种参数的RedisConnectionFactory以及预期的RedisTemplate
@Configuration
@PropertySource("classpath:redis.properties")
public class RedisConfig extends JCacheConfigurerSupport {
@Autowired
private Environment environment;
@Bean
public RedisConnectionFactory redisConnectionFactory() {
JedisConnectionFactory fac = new JedisConnectionFactory();
fac.setHostName(environment.getProperty("redis.hostName"));
fac.setPort(Integer.parseInt(environment.getProperty("redis.port")));
fac.setPassword(environment.getProperty("redis.password"));
fac.setTimeout(Integer.parseInt(environment.getProperty("redis.timeout")));
fac.getPoolConfig().setMaxIdle(Integer.parseInt(environment.getProperty("redis.maxIdle")));
fac.getPoolConfig().setMaxTotal(Integer.parseInt(environment.getProperty("redis.maxTotal")));
fac.getPoolConfig().setMaxWaitMillis(Integer.parseInt(environment.getProperty("redis.maxWaitMillis")));
fac.getPoolConfig().setMinEvictableIdleTimeMillis(
Integer.parseInt(environment.getProperty("redis.minEvictableIdleTimeMillis")));
fac.getPoolConfig()
.setNumTestsPerEvictionRun(Integer.parseInt(environment.getProperty("redis.numTestsPerEvictionRun")));
fac.getPoolConfig().setTimeBetweenEvictionRunsMillis(
Integer.parseInt(environment.getProperty("redis.timeBetweenEvictionRunsMillis")));
fac.getPoolConfig().setTestOnBorrow(Boolean.parseBoolean(environment.getProperty("redis.testOnBorrow")));
fac.getPoolConfig().setTestWhileIdle(Boolean.parseBoolean(environment.getProperty("redis.testWhileIdle")));
return fac;
}
@Bean
public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate redis = new RedisTemplate<>();
redis.setConnectionFactory(redisConnectionFactory);
redis.afterPropertiesSet();
return redis;
}
}
2. 测试与使用
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {RedisConfig.class})
public class RedisTest {
@Autowired
private RedisTemplate redisTemplate;
@Test
public void testRedisObj() {
Map properties = new HashMap<>();
properties.put("123", "hello");
properties.put("abc", 456);
redisTemplate.opsForHash().putAll("hash", properties);
Map ans = redisTemplate.opsForHash().entries("hash");
System.out.println("ans: " + ans);
}
}
执行后输出如下
ans: {123=hello, abc=456}
从上面的配置与实现来看,是很简单的了,基本上没有绕什么圈子,但是使用redis-cli连上去,却查询不到 hash 这个key的内容
127.0.0.1:6379> get hash
(nil)
127.0.0.1:6379> keys *
1) "\xac\xed\x00\x05t\x00\x04hash"
使用代码去查没问题,直接控制台连接,发现这个key和我们预期的不一样,多了一些前缀,why ?
3. 序列化问题
为了解决上面的问题,只能debug进去,看下是什么引起的了
对应源码位置:
// org.springframework.data.redis.core.AbstractOperations#rawKey
byte[] rawKey(Object key) {
Assert.notNull(key, "non null key required");
return this.keySerializer() == null && key instanceof byte[] ? (byte[])((byte[])key) : this.keySerializer().serialize(key);
}
可以看到这个key不是我们预期的 key.getBytes(), 而是调用了this.keySerializer().serialize(key),而debug的结果,默认Serializer是JdkSerializationRedisSerializer
然后就是顺藤摸瓜一步一步深入进去,链路如下
// org.springframework.core.serializer.support.SerializingConverter#convert
// org.springframework.core.serializer.DefaultSerializer#serialize
public class DefaultSerializer implements Serializer {
public DefaultSerializer() {
}
public void serialize(Object object, OutputStream outputStream) throws IOException {
if (!(object instanceof Serializable)) {
throw new IllegalArgumentException(this.getClass().getSimpleName() + " requires a Serializable payload but received an object of type [" + object.getClass().getName() + "]");
} else {
ObjectOutputStream objectOutputStream = new ObjectOutputStream(outputStream);
objectOutputStream.writeObject(object);
objectOutputStream.flush();
}
}
}
所以具体的实现很清晰了,就是 ObjectOutputStream,这个东西就是Java中最原始的序列化反序列流工具,会包含类型信息,所以会带上那串前缀了
所以要解决这个问题,也比较明确了,替换掉原生的JdkSerializationRedisSerializer,改为String的方式,正好提供了一个StringRedisSerializer,所以在RedisTemplate的配置处,稍稍修改
@Bean
public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate redis = new RedisTemplate<>();
redis.setConnectionFactory(redisConnectionFactory);
// 设置redis的String/Value的默认序列化方式
StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
redis.setKeySerializer(stringRedisSerializer);
redis.setValueSerializer(stringRedisSerializer);
redis.setHashKeySerializer(stringRedisSerializer);
redis.setHashValueSerializer(stringRedisSerializer);
redis.afterPropertiesSet();
return redis;
}
再次执行,结果尴尬的事情出现了,抛异常了,类型转换失败
java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String
at org.springframework.data.redis.serializer.StringRedisSerializer.serialize(StringRedisSerializer.java:33)
at org.springframework.data.redis.core.AbstractOperations.rawHashValue(AbstractOperations.java:171)
at org.springframework.data.redis.core.DefaultHashOperations.putAll(DefaultHashOperations.java:129)
...
看前面的测试用例,map中的value有integer,而StringRedisSerializer接收的参数必须是String,所以不用这个,自己照样子重新写一个兼容掉
public class DefaultStrSerializer implements RedisSerializer {
private final Charset charset;
public DefaultStrSerializer() {
this(Charset.forName("UTF8"));
}
public DefaultStrSerializer(Charset charset) {
Assert.notNull(charset, "Charset must not be null!");
this.charset = charset;
}
@Override
public byte[] serialize(Object o) throws SerializationException {
return o == null ? null : String.valueOf(o).getBytes(charset);
}
@Override
public Object deserialize(byte[] bytes) throws SerializationException {
return bytes == null ? null : new String(bytes, charset);
}
}
然后可以开始愉快的玩耍了,执行完之后测试
keys *
1) "\xac\xed\x00\x05t\x00\x04hash"
2) "hash"
127.0.0.1:6379> hgetAll hash
1) "123"
2) "hello"
3) "abc"
4) "456"
III. RedisTemplate使用姿势
1. opsForXXX
简单过来一下RedisTemplate的使用姿势,针对不同的数据结构(String, List, ZSet, Hash)读封装了比较使用的调用方式 opsForXXX
// hash 数据结构操作
org.springframework.data.redis.core.RedisTemplate#opsForHash
// list
org.springframework.data.redis.core.RedisTemplate#opsForList
// string
org.springframework.data.redis.core.RedisTemplate#opsForValue
// set
org.springframework.data.redis.core.RedisTemplate#opsForSet
// zset
org.springframework.data.redis.core.RedisTemplate#opsForZSet
2. execute
除了上面的这种使用方式之外,另外一种常见的就是直接使用execute了,一个简单的case如下
@Test
public void testRedis() {
String key = "hello";
String value = "world";
redisTemplate.execute((RedisCallback) con -> {
con.set(key.getBytes(), value.getBytes());
return null;
});
String asn = redisTemplate.execute((RedisCallback) con -> new String(con.get(key.getBytes())));
System.out.println(asn);
String hkey = "hKey";
redisTemplate.execute((RedisCallback) con -> {
con.hSet(hkey.getBytes(), "23".getBytes(), "what".getBytes());
return null;
});
Map map = redisTemplate.execute((RedisCallback>) con -> con.hGetAll(hkey.getBytes()));
for (Map.Entry entry : map.entrySet()) {
System.out.println("key: " + new String(entry.getKey()) + " | value: " + new String(entry.getValue()));
}
}
输出结果如下
world
key: 23 | value: what
3. 区别
一个自然而然能想到的问题就是上面的两种方式有什么区别?
opsForXXX 的底层,就是通过调用execute方式来做的,其主要就是封装了一些使用姿势,定义了序列化,使用起来更加的简单和便捷;这种方式下,带来的小号就是每次都需要新建一个DefaultXXXOperations对象,多绕了一步,基于此是否会带来额外的性能和内存开销呢?没测过,但个人感觉量小的情况下,应该没什么明显的影响;而qps很高的情况下,这方便的优化能带来的帮助,估计也不太大
IV. 其他
0. 项目
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对脚本之家的支持。
redistemplate文档用法_Spring学习笔记之RedisTemplate的配置与使用教程相关推荐
- HTML5 权威指南第 10 章 文档分节 学习笔记
HTML5 权威指南第 10 章 文档分节 学习笔记 第 8 章 标记文字 内容从从文字出发,专注如何将单体内容正确的呈现出来:第 9 章 组织内容 内容从段落出发,专注如何将单体内容合理的放在段落中 ...
- Schama —— Xml文档约束技术 学习笔记
本文查阅方法: 1.查阅目录 -- 查阅本文目录,确定想要查阅的目录标题 2.快捷"查找" -- 在当前浏览器页面,按键 "Ctrl+F" 按键 ...
- 官网案例文档结构-kera学习笔记三
下载网址:https://github.com/keras-team/keras Keras开发包文件目录 Keras实例文件目录 keras-master 文档结构框架 ├─.github ├─do ...
- redistemplate文档用法_Jedis 使用及 StringRedisTemplate 常用方法
Java官方推荐使用Jedis作为Redis的连接开发工具 1.Jedis 使用 1.1.添加依赖 org.springframework.boot spring-boot-starter-data- ...
- 涨薪神作,阿里内部火爆的实战文档和搭建项目笔记,你还怕没有项目可做吗
前言 认识一个事物最好的方式就是首先去了解它的历史. 随着Spring功能的不断丰富,版本的不断迭代发展,Spring 框架渐渐暴露出了一些问题和弊端.例如太多样板化的配置.繁琐复杂的使用过程等,我们 ...
- c语言学习,使用文档来查找学习库函数
目录 资源推荐 使用文档来查找学习库函数 以www.cplusplus.com学习为例 msdn http://zh.cppreference.com--c/c++的官网 资源推荐 www.cplus ...
- FreeMarker中文帮助手册API文档,基础入门学习文档
FreeMarker中文帮助手册API文档,基础入门学习文档 分类: 编程技术 发布: bywei 浏览: 7 日期: 2011年5月28日 分享到: QQ空间 新浪微博 腾讯微博 人人网 什么是Fr ...
- 20165234 [第二届构建之法论坛] 预培训文档(Java版) 学习总结
[第二届构建之法论坛] 预培训文档(Java版) 学习总结 我通读并学习了此文档,并且动手实践了一遍.以下是我学习过程的记录~ Part1.配置环境 配置JDK 原文中提到了2个容易被混淆的概念 JD ...
- Manim文档及源码笔记-CE文档-示例库3使用Manim绘图
Manim文档及源码笔记-CE文档-示例库3使用Manim绘图 参考原文: Manim Community Edition Example Gallery 前言 笔记随想: 暂未发现官方中文版,自己实 ...
最新文章
- anaconda创建一个虚拟环境
- anaconda怎么运行python程序_Heartrate:如追综心跳般实时动态可视化监测Python程序运行...
- ubuntu20.04安装mysql教程
- windows2016服务器优化,Windows Server 2012 服务器优化图文方法
- 学习使用c++编写opencv的一些记录
- 《JavaScript征途》广泛征集读后感创作者,参与有奖!
- 廖雪峰python学习笔记之Web开发
- ASM 转自三思笔记,改成自己看着舒服的格式而已
- 大数据入门:Hadoop大数据开发核心讲解
- C语言大作业:车辆信息管理系统
- AI智能尺寸测量仪简介(图像尺寸测量仪)
- 编译android版本protobuf
- 推荐四个在线任务管理网站
- python出行轨迹记录软件_看看过去跑过哪些地方,用Python和高德API绘制跑步轨迹...
- IM即时通讯系统优势,区块链社交APP如何搭建
- 如何做好工作中的思考沉淀?
- 长方形 java_JAVA实现矩形(长方形)的周长面积计算
- ISO 26262 ASIL安全等级,怎样划分和分解【转】
- PPT图表分享一:组织结构图
- 内容匹配广告投放技术2:网盟广告匹配(一)(百度文库课程)
热门文章
- 互联网日报 | 茅台市值突破2万亿;新浪收到非约束性私有化要约;OPPO参与英国首个5G SA网络建设...
- 记录一次nginx服务器签名证书过期的排查过程
- Pandas速查手册
- java新手练习项目_有哪些好的java项目适合新手练习?
- ubuntu18.04 nvidia gpu驱动与tensorflow-gpu以 docker方式安装
- Redis 键值设计使用总结
- 12、微信前端开发利器:WeUI
- 数据库与计算机辅助设计ER图,ER图对象联系图和UML类图
- MediaCodec硬编码成H264视频流
- Foxit Reader(福昕PDF阅读器) v4.3.1.218 绿色专业版