|
对于最新的稳定版本，请使用 Spring Data Relational 3.4.0！ |
映射
丰富的映射支持由MappingR2dbcConverter.MappingR2dbcConverter具有丰富的元数据模型，允许将域对象映射到数据行。
映射元数据模型是通过在域对象上使用注释来填充的。
但是，基础架构不仅限于使用注释作为元数据信息的唯一来源。
这MappingR2dbcConverter还允许您通过遵循一组约定将对象映射到行，而无需提供任何其他元数据。
本节介绍MappingR2dbcConverter，包括如何使用约定将对象映射到行，以及如何使用基于注释的映射元数据覆盖这些约定。
在继续阅读本章之前，请先阅读有关对象映射基础知识的基础知识。
基于约定的映射
MappingR2dbcConverter在未提供其他映射元数据时，有一些用于将对象映射到行的约定。
约定是：
-
短 Java 类名按以下方式映射到表名。 这
com.bigbank.SavingsAccount类映射到SAVINGS_ACCOUNTtable name 的 相同的名称映射适用于将字段映射到列名称。 例如，firstNamefield 映射到FIRST_NAME列。 您可以通过提供自定义NamingStrategy. 有关更多详细信息，请参阅 映射配置 。 默认情况下，从属性或类名称派生的表名和列名在 SQL 语句中使用，不带引号。 您可以通过设置RelationalMappingContext.setForceQuote(true). -
不支持嵌套对象。
-
该转换器使用任何注册的 Spring Converter
CustomConversions以覆盖对象属性到行列和值的默认映射。 -
对象的字段用于与行中的列相互转换。 公共
JavaBean属性。 -
如果你有一个非零参数构造函数，其构造函数参数名称与行的顶级列名匹配，则使用该构造函数。 否则，使用零参数构造函数。 如果有多个非零参数构造函数，则会引发异常。 请参阅 对象创建 以了解更多详细信息。
映射配置
默认情况下，（除非显式配置）MappingR2dbcConverter在您创建DatabaseClient.
您可以创建自己的MappingR2dbcConverter.
通过创建自己的实例，您可以注册 Spring 转换器以将特定类映射到数据库或从数据库映射特定类。
您可以配置MappingR2dbcConverter以及DatabaseClient和ConnectionFactory通过使用基于 Java 的元数据。
以下示例使用 Spring 基于 Java 的配置：
如果您将setForceQuote的R2dbcMappingContext totrue，则从 classes 和 properties 派生的 table 和 column 名称与特定于数据库的引号一起使用。
这意味着可以在这些名称中使用保留的 SQL 字（例如 order）。
您可以通过覆盖r2dbcMappingContext(Optional<NamingStrategy>)之AbstractR2dbcConfiguration.
Spring Data 将此类名称的字母大小写转换为在不使用引号时配置的数据库也使用的形式。
因此，您可以在创建表时使用不带引号的名称，只要您在名称中不使用关键字或特殊字符即可。
对于遵循 SQL 标准的数据库，这意味着名称将转换为大写。
引号字符和名称大写的方式由使用的Dialect.
有关如何配置自定义方言的信息，请参阅 R2DBC 驱动程序。
@Configuration
public class MyAppConfig extends AbstractR2dbcConfiguration {
public ConnectionFactory connectionFactory() {
return ConnectionFactories.get("r2dbc:…");
}
// the following are optional
@Override
protected List<Object> getCustomConverters() {
return List.of(new PersonReadConverter(), new PersonWriteConverter());
}
}AbstractR2dbcConfiguration要求您实现一个定义ConnectionFactory.
您可以通过覆盖r2dbcCustomConversions方法。
您可以配置自定义NamingStrategy通过将其注册为 Bean。
这NamingStrategy控制如何将类和属性的名称转换为表和列的名称。
AbstractR2dbcConfiguration创建一个DatabaseClientinstance 并将其注册到名为databaseClient. |
基于元数据的映射
要充分利用 Spring Data R2DBC 支持中的对象映射功能，您应该使用@Table注解。
尽管 Map 框架不需要具有此 Comments（即使没有任何 Comments，您的 POJO 也被正确映射），但它允许 Classpath 扫描器查找并预处理您的域对象以提取必要的元数据。
如果不使用此注释，则应用程序在首次存储域对象时的性能会受到轻微影响，因为映射框架需要构建其内部元数据模型，以便它了解域对象的属性以及如何持久保存它们。
以下示例显示了一个域对象：
package com.mycompany.domain;
@Table
public class Person {
@Id
private Long id;
private Integer ssn;
private String firstName;
private String lastName;
}这@Idannotation 告诉 Mapper 您要将哪个属性用作主键。 |
默认类型映射
下表说明了实体的属性类型如何影响映射：
| 源类型 | 目标类型 | 言论 |
|---|---|---|
基元类型和包装类型 |
直通 |
可以使用 Explicit Converters 进行自定义。 |
JSR-310 日期/时间类型 |
直通 |
可以使用 Explicit Converters 进行自定义。 |
|
直通 |
可以使用 Explicit Converters 进行自定义。 |
|
字符串 |
可以通过注册 Explicit Converters 进行自定义。 |
|
直通 |
可以使用 Explicit Converters 进行自定义。 |
|
直通 |
被视为二进制负载。 |
|
数组 |
转换为 Array 类型（如果配置的驱动程序支持），否则不支持。 |
原始类型、包装器类型和 |
包装器类型的数组（例如 |
转换为 Array 类型（如果配置的驱动程序支持），否则不支持。 |
特定于驱动程序的类型 |
直通 |
由 used |
复杂对象 |
目标类型取决于已注册 |
需要 A Explicit Converters，否则不支持。 |
| 列的本机数据类型取决于 R2DBC 驱动程序类型映射。 驱动程序可以提供其他简单类型，例如 Geometry 类型。 |
映射注释概述
这RelationalConverter可以使用元数据来驱动对象到行的映射。
可以使用以下注释：
-
@Id：在字段级别应用以标记主键。 -
@Table：在类级别应用，以指示此类是映射到数据库的候选项。 您可以指定存储数据库的表的名称。 -
@Transient：默认情况下，所有字段都映射到该行。 此 Comments 将应用它的字段排除在数据库中。 瞬态属性不能在持久性构造函数中使用，因为转换器无法实现构造函数参数的值。 -
@PersistenceCreator：标记给定的构造函数或静态工厂方法（甚至是受包保护的方法）在从数据库中实例化对象时使用。 构造函数参数按名称映射到检索到的行中的值。 -
@Value：此注释是 Spring 框架的一部分。 在 Map 框架中，它可以应用于构造函数参数。 这允许你在使用 Spring Expression Language 语句来转换在数据库中检索到的键的值，然后再用于构造域对象。 为了引用给定行的列，必须使用如下表达式：@Value("#root.myProperty")其中 root 引用给定Row. -
@Column：在字段级别应用，以描述列在行中表示的名称，使名称与类的字段名称不同。 使用@Columnannotation 在 SQL 语句中使用时，始终引用。 对于大多数数据库，这意味着这些名称区分大小写。 这也意味着您可以在这些名称中使用特殊字符。 但是，不建议这样做，因为它可能会导致其他工具出现问题。 -
@Version：在字段级别应用用于乐观锁定，并检查保存作的修改。 值为null(zero）被视为新实体的标记。 初始存储值为zero(one对于原始类型）。 版本在每次更新时都会自动递增。 有关进一步的参考，请参见 Optimistic Locking。
映射元数据基础架构在单独的spring-data-commons与技术无关的项目。
R2DBC 支持中使用了特定的子类来支持基于 Comments 的元数据。
也可以制定其他策略（如果有需求）。
命名策略
按照惯例， Spring Data 应用NamingStrategy确定默认为 Snake 大小写的表、列和架构名称。
名为firstName成为first_name.
您可以通过提供NamingStrategy在您的应用程序上下文中。
覆盖表名称
当表命名策略与数据库表名不匹配时，您可以使用Table注解。
元素value提供自定义表名。
以下示例映射MyEntity类添加到CUSTOM_TABLE_NAME表中：
@Table("CUSTOM_TABLE_NAME")
class MyEntity {
@Id
Integer id;
String name;
}您可以使用 Spring Data 的 SPEL 支持来动态创建表名。 生成后，表名将被缓存，因此它仅根据映射上下文是动态的。
覆盖列名称
当列命名策略与数据库表名不匹配时，您可以使用Column注解。
元素value提供自定义列名称。
以下示例映射name属性的MyEntity类添加到CUSTOM_COLUMN_NAME列中：
class MyEntity {
@Id
Integer id;
@Column("CUSTOM_COLUMN_NAME")
String name;
}您可以使用 Spring Data 的 SPEL 支持来动态创建列名。 生成后，名称将被缓存，因此它仅对每个映射上下文是动态的。
只读属性
注释@ReadOnlyProperty不会被 Spring Data 写入数据库，但它们会在加载实体时被读取。
Spring Data 在写入实体后不会自动重新加载实体。 因此，如果要查看数据库中为此类列生成的数据，则必须显式重新加载它。
如果带注释的属性是实体或实体集合，则它由单独表中的一个或多个单独行表示。 Spring Data 不会对这些行执行任何插入、删除或更新。
Insert Only 属性
注释@InsertOnlyProperty将仅在插入作期间由 Spring Data 写入数据库。
对于更新，将忽略这些属性。
@InsertOnlyProperty仅支持聚合根。
自定义对象构造
映射子系统允许通过使用@PersistenceConstructor注解。要用于 constructor 参数的值按以下方式解析：
-
如果参数使用
@Valueannotation 中，将计算给定的表达式，并将结果用作参数值。 -
如果 Java 类型具有其名称与 input 行的给定字段匹配的属性，则其属性信息用于选择要将 input 字段值传递到的相应构造函数参数。 仅当 Java 中存在参数名称信息时，此选项才有效
.class文件，您可以通过使用调试信息编译源或使用-parameters的命令行开关javac在 Java 8 中。 -
否则，一个
MappingException的 S MissAV.com 的 S Alpha 参数，以指示无法绑定给定的 constructor 参数。
class OrderItem {
private @Id final String id;
private final int quantity;
private final double unitPrice;
OrderItem(String id, int quantity, double unitPrice) {
this.id = id;
this.quantity = quantity;
this.unitPrice = unitPrice;
}
// getters/setters omitted
}使用显式转换器覆盖映射
在存储和查询对象时，通常有一个R2dbcConverter实例来处理所有 Java 类型到OutboundRow实例。
但是，您有时可能需要R2dbcConverter实例来完成大部分工作，但允许您有选择地处理特定类型的转换 — 也许是为了优化性能。
要有选择地自行处理转换，请注册一个或多个org.springframework.core.convert.converter.Converter实例中具有R2dbcConverter.
您可以使用r2dbcCustomConversionsmethod 中AbstractR2dbcConfiguration配置转换器。
本章开头的示例显示了如何使用 Java 执行配置。
自定义顶级实体转换需要非对称类型进行转换。
入站数据是从 R2DBC 的Row.
出站数据（用于INSERT/UPDATEstatements） 表示为OutboundRow后来汇编了一份声明。 |
以下 Spring Converter 实现示例从Row更改为PersonPOJO：
@ReadingConverter
public class PersonReadConverter implements Converter<Row, Person> {
public Person convert(Row source) {
Person p = new Person(source.get("id", String.class),source.get("name", String.class));
p.setAge(source.get("age", Integer.class));
return p;
}
}请注意，转换器应用于单个属性。
集合属性（例如Collection<Person>） 进行迭代和转换。
集合转换器（例如Converter<List<Person>>, OutboundRow） 不受支持。
R2DBC 使用盒装基元 （Integer.class而不是int.class） 返回基元值。 |
以下示例将Person更改为OutboundRow:
@WritingConverter
public class PersonWriteConverter implements Converter<Person, OutboundRow> {
public OutboundRow convert(Person source) {
OutboundRow row = new OutboundRow();
row.put("id", Parameter.from(source.getId()));
row.put("name", Parameter.from(source.getFirstName()));
row.put("age", Parameter.from(source.getAge()));
return row;
}
}使用 Explicit Converters 覆盖 Enum Mapping
某些数据库（如 Postgres）可以使用其特定于数据库的枚举列类型本机写入枚举值。
Spring Data 转换Enum值默认设置为String值以实现最大可移植性。
要保留实际的枚举值，请注册一个@Writingconverter 的源类型和目标类型使用实际的枚举类型，以避免使用Enum.name()转换。
此外，您需要在驱动程序级别配置枚举类型，以便驱动程序知道如何表示枚举类型。
以下示例显示了要读取和写入的涉及组件Colorenum 值：
enum Color {
Grey, Blue
}
class ColorConverter extends EnumWriteSupport<Color> {
}
class Product {
@Id long id;
Color color;
// …
}