通过 RedisTemplate 操作对象
RedisTemplate
大多数用户很可能会使用 RedisTemplate 及其对应的包 org.springframework.data.redis.core,或其响应式变体 ReactiveRedisTemplate。事实上,由于其丰富的功能集,该模板是 Redis 模块的核心类。模板为 Redis 交互提供了高层抽象。虽然 [Reactive]RedisConnection 提供接受并返回二进制值(byte 数组)的低层方法,但模板负责序列化和连接管理,使用户免于处理这些细节。
RedisTemplate 类实现了 RedisOperations 接口,其响应式变体 ReactiveRedisTemplate 实现了 ReactiveRedisOperations。
引用一个 [Reactive]RedisTemplate 实例上的操作,首选方式是通过 [Reactive]RedisOperations 接口。
此外,模板提供操作视图(遵循 Redis 命令参考中的分组),它们为针对某一类型或某一键操作提供了丰富的、泛型化的接口(通过 KeyBound 接口),如下表所述:
操作视图
- Imperative
- Reactive
| 接口 | 说明 |
|---|---|
| Key 类型操作 | |
| GeoOperations | Redis 地理空间操作,如 GEOADD、GEORADIUS 等 |
| HashOperations | Redis 哈希操作 |
| HyperLogLogOperations | Redis HyperLogLog 操作,如 PFADD、PFCOUNT 等 |
| ListOperations | Redis 列表操作 |
| SetOperations | Redis 集合操作 |
| ValueOperations | Redis 字符串(或值)操作 |
| ZSetOperations | Redis zset(或有序集合)操作 |
| Key 绑定操作 | |
| BoundGeoOperations | Redis key 绑定的地理空间操作 |
| BoundHashOperations | Redis 哈希 key 绑定操作 |
| BoundKeyOperations | Redis key 绑定操作 |
| BoundListOperations | Redis 列表 key 绑定操作 |
| BoundSetOperations | Redis 集合 key 绑定操作 |
| BoundValueOperations | Redis 字符串(或值)key 绑定操作 |
| BoundZSetOperations | Redis zset(或有序集合)key 绑定操作 |
| 接口 | 说明 |
|---|---|
| Key 类型操作 | |
| ReactiveGeoOperations | Redis 地理空间操作,如 GEOADD、GEORADIUS 等 |
| ReactiveHashOperations | Redis 哈希操作 |
| ReactiveHyperLogLogOperations | Redis HyperLogLog 操作,如(PFADD、PFCOUNT 等) |
| ReactiveListOperations | Redis 列表操作 |
| ReactiveSetOperations | Redis 集合操作 |
| ReactiveValueOperations | Redis 字符串(或值)操作 |
| ReactiveZSetOperations | Redis zset(或有序集合)操作 |
配置好之后,模板是线程安全的,可以在多个实例间复用。
RedisTemplate 的大多数操作使用基于 Java 的序列化器。这意味着由模板写入或读取的任何对象都通过 Java 进行序列化和反序列化。
你可以更改模板上的序列化机制,Redis 模块提供了若干实现,它们位于 org.springframework.data.redis.serializer 包中。更多信息请参见序列化器。你也可以把任意序列化器设为 null,并通过把 enableDefaultSerializer 属性设为 false,让 RedisTemplate 使用原始字节数组。请注意,模板要求所有 key 都不能为 null。不过,只要底层序列化器接受 value,value 就可以为 null。更多信息请阅读各个序列化器的 Javadoc。
对于需要某个特定模板视图的场景,可以把该视图声明为一个依赖并注入模板。容器会自动执行转换,省去 opsFor[X] 调用,如下例所示:
- Java Imperative
- Java Reactive
- XML
@Configuration
class MyConfig {
@Bean
LettuceConnectionFactory connectionFactory() {
return new LettuceConnectionFactory();
}
@Bean
RedisTemplate<String, String> redisTemplate(RedisConnectionFactory connectionFactory) {
RedisTemplate<String, String> template = new RedisTemplate<>();
template.setConnectionFactory(connectionFactory);
return template;
}
}
@Configuration
class MyConfig {
@Bean
LettuceConnectionFactory connectionFactory() {
return new LettuceConnectionFactory();
}
@Bean
ReactiveRedisTemplate<String, String> ReactiveRedisTemplate(ReactiveRedisConnectionFactory connectionFactory) {
return new ReactiveRedisTemplate<>(connectionFactory, RedisSerializationContext.string());
}
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="redisConnectionFactory" class="org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory"/>
<!-- redis template definition -->
<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate" p:connection-factory-ref="redisConnectionFactory"/>
...
</beans>
- Imperative
- Reactive
public class Example {
// inject the actual operations
@Autowired
private RedisOperations<String, String> operations;
// inject the template as ListOperations
@Resource(name="redisTemplate")
private ListOperations<String, String> listOps;
public void addLink(String userId, URL url) {
listOps.leftPush(userId, url.toExternalForm());
}
}
public class Example {
// inject the actual template
@Autowired
private ReactiveRedisOperations<String, String> operations;
public Mono<Long> addLink(String userId, URL url) {
return operations.opsForList().leftPush(userId, url.toExternalForm());
}
}
面向 String 的便利类 {#redis:string}
由于存储在 Redis 中的 key 和 value 为 java.lang.String 相当常见,Redis 模块为 RedisConnection 和 RedisTemplate 提供了两个扩展,分别是 StringRedisConnection(及其 DefaultStringRedisConnection 实现)和 StringRedisTemplate,作为密集 String 操作的一站式便利解决方案。除了绑定到 String key 之外,模板和连接在底层还使用 StringRedisSerializer,这意味着存储的 key 和 value 是人类可读的(前提是 Redis 与你的代码使用相同的编码)。下面的列表给出一个例子:
- Java Imperative
- Java Reactive
- XML
@Configuration
class RedisConfiguration {
@Bean
LettuceConnectionFactory redisConnectionFactory() {
return new LettuceConnectionFactory();
}
@Bean
StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
StringRedisTemplate template = new StringRedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
}
@Configuration
class RedisConfiguration {
@Bean
LettuceConnectionFactory redisConnectionFactory() {
return new LettuceConnectionFactory();
}
@Bean
ReactiveStringRedisTemplate reactiveRedisTemplate(ReactiveRedisConnectionFactory factory) {
return new ReactiveStringRedisTemplate<>(factory);
}
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="redisConnectionFactory" class="org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory"/>
<bean id="stringRedisTemplate" class="org.springframework.data.redis.core.StringRedisTemplate" p:connection-factory-ref="redisConnectionFactory"/>
</beans>
- Imperative
- Reactive
public class Example {
@Autowired
private StringRedisTemplate redisTemplate;
public void addLink(String userId, URL url) {
redisTemplate.opsForList().leftPush(userId, url.toExternalForm());
}
}
public class Example {
@Autowired
private ReactiveStringRedisTemplate redisTemplate;
public Mono<Long> addLink(String userId, URL url) {
return redisTemplate.opsForList().leftPush(userId, url.toExternalForm());
}
}
与其他 Spring 模板一样,RedisTemplate 和 StringRedisTemplate 让你可以通过 RedisCallback 接口直接与 Redis 通信。这个功能把完全的控制权交给你,因为它直接与 RedisConnection 通信。请注意,当使用 StringRedisTemplate 时,回调会收到一个 StringRedisConnection 实例。下例展示如何使用 RedisCallback 接口:
public void useCallback() {
redisOperations.execute(new RedisCallback<Object>() {
public Object doInRedis(RedisConnection connection) throws DataAccessException {
Long size = connection.dbSize();
// Can cast to StringRedisConnection if using a StringRedisTemplate
((StringRedisConnection)connection).set("key", "value");
}
});
}
序列化器 {#redis:serializer}
从框架的角度看,存储在 Redis 中的数据只是字节。虽然 Redis 本身支持多种类型,但在大多数情况下,这些类型指的是数据的存储方式,而非数据所代表的内容。信息是否被转换为字符串或任何其他对象,由用户决定。
在 Spring Data 中,用户(自定义)类型与原始数据之间(以及反向)的转换,由 Spring Data Redis 在 org.springframework.data.redis.serializer 包中处理。
顾名思义,这个包包含两类负责序列化过程的序列化器:
- 基于 RedisSerializer 的双向序列化器。
- 使用
RedisElementReader和RedisElementWriter的元素读写器。
这些变体之间的主要区别在于,RedisSerializer 主要序列化为 byte[],而读写器使用 ByteBuffer。
有多种实现可用(包括本文档中已经提到的两种):
- JdkSerializationRedisSerializer,它默认被 RedisCache 和 RedisTemplate 使用。
StringRedisSerializer。
不过,也可以通过 Spring OXM 支持使用 OxmSerializer 进行对象/XML 映射,或使用 JacksonJsonRedisSerializer 或 GenericJacksonJsonRedisSerializer 把数据存储为 JSON 格式。
请注意,存储格式并不仅限于值。它可以无差别地用于 key、value 或哈希。
默认情况下,RedisCache 和 RedisTemplate 被配置为使用 Java 原生序列化。众所周知,Java 原生序列化会允许被利用易受攻击的库和类、注入未验证字节码的载荷引发远程代码运行。被篡改的输入可能导致在反序列化步骤期间在应用中运行不想要的代码。因此,请不要在不可信环境中使用序列化。一般而言,我们强烈建议改用任何其他消息格式(例如 JSON)。
如果你担心 Java 序列化带来的安全漏洞,请考虑 JVM 核心层面的通用序列化过滤器机制: