跳到主要内容
版本:4.1.1

对象到 Hash 的映射

Doubao 中英对照 Object-to-Hash Mapping

Redis 仓库支持将对象持久化到 Hash。这需要对象到 Hash 的转换,该转换由 RedisConverter 完成。默认实现使用 Converter 在属性值与 Redis 原生 byte[] 之间进行映射。

对于前面章节中的 Person 类型,默认映射如下所示:

_class = org.example.Person                 // <1>
id = e2c7dcee-b8cd-4424-883e-736ce564363e
firstname = rand // <2>
lastname = al’thor
address.city = emond's field // <3>
address.country = andor
  • _class 属性包含在根级别,也包含在任何嵌套接口或抽象类型上。

  • 简单属性值按路径映射。

  • 复杂类型的属性按其点路径映射。

数据映射与类型转换​

本节介绍类型如何与 Hash 表示形式之间进行映射:

表 1. 默认映射规则

类型示例映射值
简单类型
(例如 String)
String firstname = "rand";firstname = "rand"
字节数组(byte[])byte[] image = "rand".getBytes();image = "rand"
复杂类型
(例如 Address)
Address address = new Address("emond’s field");address.city = "emond’s field"
简单类型 List
List<String> nicknames = asList("dragon reborn", "lews therin");nicknames.[0] = "dragon reborn",
nicknames.[1] = "lews therin"
简单类型 Map
Map<String, String> atts = asMap({"eye-color", "grey"}, {"…​atts.[eye-color] = "grey",
atts.[hair-color] = "…​
复杂类型 List
List<Address> addresses = asList(new Address("em…​addresses.[0].city = "emond’s field",
addresses.[1].city = "…​
复杂类型 Map
Map<String, Address> addresses = asMap({"home", new Address("em…​addresses.[home].city = "emond’s field",
addresses.[work].city = "…​
警告

由于扁平化的表示结构,Map 键必须是简单类型,例如 String 或 Number。

可以通过在 RedisCustomConversions 中注册相应的 Converter 来自定义映射行为。这些转换器可以处理单个 byte[] 的双向转换,也可以处理 Map<String, byte[]> 的转换。第一种适合(例如)将复杂类型转换为(例如)二进制 JSON 表示,同时仍使用默认映射的 hash 结构。第二种选项可对生成的 hash 进行完全控制。

注意

将对象写入 Redis hash 会删除 hash 中的内容并重新创建整个 hash,因此未映射的数据会丢失。

下面的示例展示了两个字节数组转换器示例:

示例 1. byte[] 转换器示例

@WritingConverter
public class AddressToBytesConverter implements Converter<Address, byte[]> {

private final JacksonJsonRedisSerializer<Address> serializer;

public AddressToBytesConverter() {

serializer = new JacksonJsonRedisSerializer<Address>(Address.class);
serializer.setObjectMapper(new ObjectMapper());
}

@Override
public byte[] convert(Address value) {
return serializer.serialize(value);
}
}

@ReadingConverter
public class BytesToAddressConverter implements Converter<byte[], Address> {

private final JacksonJsonRedisSerializer<Address> serializer;

public BytesToAddressConverter() {

serializer = new JacksonJsonRedisSerializer<Address>(Address.class);
serializer.setObjectMapper(new ObjectMapper());
}

@Override
public Address convert(byte[] value) {
return serializer.deserialize(value);
}
}

使用上面的字节数组 Converter 会产生类似如下的输出:

_class = org.example.Person
id = e2c7dcee-b8cd-4424-883e-736ce564363e
firstname = rand
lastname = al’thor
address = { city : "emond's field", country : "andor" }

下面的示例展示了两个 Map 转换器示例:

示例 2. Map<String, byte[]> 转换器示例

@WritingConverter
public class AddressToMapConverter implements Converter<Address, Map<String, byte[]>> {

@Override
public Map<String, byte[]> convert(Address source) {
return singletonMap("ciudad", source.getCity().getBytes());
}
}

@ReadingConverter
public class MapToAddressConverter implements Converter<Map<String, byte[]>, Address> {

@Override
public Address convert(Map<String, byte[]> source) {
return new Address(new String(source.get("ciudad")));
}
}

使用上面的 Map Converter 会产生类似如下的输出:

_class = org.example.Person
id = e2c7dcee-b8cd-4424-883e-736ce564363e
firstname = rand
lastname = al’thor
ciudad = "emond's field"
备注

自定义转换对索引解析没有影响。即使对于自定义转换的类型,仍会创建二级索引。

自定义类型映射​

如果你想避免将完整的 Java 类名写为类型信息,而更愿意使用一个键,可以在被持久化的实体类上使用 @TypeAlias 注解。如果你需要进一步自定义映射,请查看 TypeInformationMapper 接口。该接口的实例可以在 DefaultRedisTypeMapper 上配置,而后者又可以在 MappingRedisConverter 上配置。

下面的示例展示如何为实体定义类型别名:

示例 3. 为实体定义 @TypeAlias

@TypeAlias("pers")
class Person {

}

生成的文档在 _class 字段中包含 pers 作为值。

配置自定义类型映射​

下面的示例演示如何在 MappingRedisConverter 中配置自定义 RedisTypeMapper:

示例 4. 通过 Spring Java Config 配置自定义 RedisTypeMapper

class CustomRedisTypeMapper extends DefaultRedisTypeMapper {
//implement custom type mapping here
}
@Configuration
class SampleRedisConfiguration {

@Bean
public MappingRedisConverter redisConverter(RedisMappingContext mappingContext,
RedisCustomConversions customConversions, ReferenceResolver referenceResolver) {

MappingRedisConverter mappingRedisConverter = new MappingRedisConverter(mappingContext, null, referenceResolver,
customTypeMapper());

mappingRedisConverter.setCustomConversions(customConversions);

return mappingRedisConverter;
}

@Bean
public RedisTypeMapper customTypeMapper() {
return new CustomRedisTypeMapper();
}
}