对于最新的稳定版本，请使用 Spring Data Relational 3.4.0！spring-doc.cn

持久化实体

R2dbcEntityTemplate是 Spring Data R2DBC 的中心入口点。 它为典型的临时用例（如查询、插入、更新和删除数据）提供直接的面向实体的方法和更窄、更流畅的界面。spring-doc.cn

入口点（、、 、 和其他）遵循基于要运行的操作的自然命名架构。 从入口点开始，API 旨在仅提供依赖于上下文的方法，这些方法会导致创建和运行 SQL 语句的终止方法。 Spring Data R2DBC 使用抽象来确定绑定标记、分页支持和底层驱动程序原生支持的数据类型。insert()select()update()R2dbcDialectspring-doc.cn

所有终端方法始终返回表示所需操作的类型。 实际的对账单在订阅时发送到数据库。Publisher

插入和更新实体的方法

有几种方便的方法可以保存和插入您的对象。 要对转换过程进行更精细的控制，可以使用 — 例如 和 注册 Spring 转换器。R2dbcEntityTemplateR2dbcCustomConversionsConverter<Person, OutboundRow>Converter<Row, Person>spring-doc.cn

使用 save 操作的简单情况是保存一个 POJO。 在这种情况下，table name 由类的名称（非完全限定）确定。 您还可以使用特定的集合名称调用 save 操作。 您可以使用映射元数据覆盖用于存储对象的集合。spring-doc.cn

在插入或保存时，如果未设置该属性，则假定其值将由数据库自动生成。 因此，要自动生成，类中属性或字段的类型必须是 、 或 。IdIdLongIntegerspring-doc.cn

下面的示例演示如何插入行并检索其内容：spring-doc.cn

使用R2dbcEntityTemplate
Person person = new Person("John", "Doe");

Mono<Person> saved = template.insert(person);
Mono<Person> loaded = template.selectOne(query(where("firstname").is("John")),
		Person.class);

可以使用以下 insert 和 update 操作：spring-doc.cn

也可以使用一组类似的 insert 操作：spring-doc.cn

  • Mono<T> insert ：将对象插入默认表。(T objectToSave)spring-doc.cn

  • Mono<T> update ：将对象插入默认表。(T objectToSave)spring-doc.cn

可以使用 Fluent API 自定义表名称。spring-doc.cn

选择数据

和 方法 on 用于从表中选择数据。 这两种方法都采用一个 Query 对象，该对象定义字段投影、子句、子句和 limit/offset 分页。 限制/偏移功能对应用程序是透明的，无论底层数据库如何。 R2dbcDialect 抽象支持此功能，以满足各个 SQL 风格之间的差异。select(…)selectOne(…)R2dbcEntityTemplateWHEREORDER BYspring-doc.cn

使用R2dbcEntityTemplate
Flux<Person> loaded = template.select(query(where("firstname").is("John")),
		Person.class);

Fluent API

本节介绍 Fluent API 的用法。 请考虑以下简单查询：spring-doc.cn

Flux<Person> people = template.select(Person.class) (1)
		.all(); (2)
1 Using with the method 映射结果对象上的表格结果。Personselect(…)Person
2 获取行将返回无限制的结果。all()Flux<Person>

以下示例声明了一个更复杂的查询，该查询按名称、条件和子句指定表名：WHEREORDER BYspring-doc.cn

Mono<Person> first = template.select(Person.class)	(1)
	.from("other_person")
	.matching(query(where("firstname").is("John")			(2)
		.and("lastname").in("Doe", "White"))
	  .sort(by(desc("id"))))													(3)
	.one();																						(4)
1 按名称从表中选择将返回使用给定域类型的行结果。
2 发出的查询声明了 on 和 columns 的条件以筛选结果。WHEREfirstnamelastname
3 结果可以按单个列名排序，从而生成子句。ORDER BY
4 选择一个结果仅获取一行。 这种使用行的方式期望查询只返回一个结果。 如果查询生成多个结果，则发出 A。MonoIncorrectResultSizeDataAccessException
您可以通过 提供目标类型，直接将 Projections 应用于结果。select(Class<?>)

您可以通过以下终止方法在检索单个实体和检索多个实体之间切换：spring-doc.cn

  • first()：仅使用第一行，返回 . 如果查询未返回任何结果，则返回的将完成而不发出对象。MonoMonospring-doc.cn

  • one()：只使用一行，返回一个 . 如果查询未返回任何结果，则返回的将完成而不发出对象。 如果查询返回多行，则完成异常发出 。MonoMonoMonoIncorrectResultSizeDataAccessExceptionspring-doc.cn

  • all()：使用返回的所有返回行。Fluxspring-doc.cn

  • count()：应用返回 的计数投影。Mono<Long>spring-doc.cn

  • exists()：通过返回 返回 来返回查询是否产生任何行。Mono<Boolean>spring-doc.cn

您可以使用入口点来表达您的查询。 生成的查询支持常用子句 （ 和 ） 并支持分页。 Fluent API 样式允许您将多个方法链接在一起，同时拥有易于理解的代码。 为了提高可读性，您可以使用静态导入，从而避免使用 'new' 关键字来创建实例。select()SELECTSELECTWHEREORDER BYCriteriaspring-doc.cn

Criteria 类的方法

该类提供以下方法，所有这些方法都对应于 SQL 运算符：Criteriaspring-doc.cn

  • Criteria 和 ：将具有指定链接的 intag 添加到当前 URL 并返回新创建的 URL。(String column)CriteriapropertyCriteriaspring-doc.cn

  • Criteria 或 ：将具有指定链接的 链接到当前 并返回新创建的 链接。(String column)CriteriapropertyCriteriaspring-doc.cn

  • Criteria greaterThan ：使用运算符创建标准。(Object o)>spring-doc.cn

  • Criteria greaterThanOrEquals ：使用运算符创建标准。(Object o)>=spring-doc.cn

  • Criteria in ：使用 varargs 参数的运算符创建标准。(Object…​ o)INspring-doc.cn

  • Criteria in ：使用运算符和集合创建标准。(Collection<?> collection)INspring-doc.cn

  • Criteria is ：使用列匹配 （） 创建标准。(Object o)property = valuespring-doc.cn

  • Criteria isNull ：使用运算符创建标准。()IS NULLspring-doc.cn

  • Criteria isNotNull ：使用运算符创建标准。()IS NOT NULLspring-doc.cn

  • Criteria lessThan ：使用运算符创建标准。(Object o)<spring-doc.cn

  • Criteria lessThanOrEquals ：使用运算符创建标准。(Object o)⇐spring-doc.cn

  • Criteria like ：使用运算符创建标准，而不进行转义字符处理。(Object o)LIKEspring-doc.cn

  • Criteria not ：使用运算符创建标准。(Object o)!=spring-doc.cn

  • Criteria notIn ：使用 varargs 参数的运算符创建标准。(Object…​ o)NOT INspring-doc.cn

  • Criteria notIn ：使用运算符和集合创建标准。 您可以与 、 和 查询一起使用。(Collection<?> collection)NOT INCriteriaSELECTUPDATEDELETEspring-doc.cn

插入数据

您可以使用入口点插入数据。insert()spring-doc.cn

请考虑以下简单的类型化插入操作：spring-doc.cn

Mono<Person> insert = template.insert(Person.class)	(1)
		.using(new Person("John", "Doe")); (2)
1 Using with the method 根据映射元数据设置表。 它还准备 insert 语句以接受要插入的对象。Personinto(…)INTOPerson
2 提供标量对象。 或者，您可以提供 a 来运行语句流。 此方法提取所有非值并插入它们。PersonPublisherINSERTnull

更新数据

您可以使用入口点更新行。 更新数据首先通过接受指定分配来指定要更新的表。 它还接受 create 子句。update()UpdateQueryWHEREspring-doc.cn

请考虑以下简单的类型化 update 操作：spring-doc.cn

Person modified = …

		Mono<Long> update = template.update(Person.class)	(1)
				.inTable("other_table")														(2)
				.matching(query(where("firstname").is("John")))		(3)
				.apply(update("age", 42));												(4)
1 更新对象并根据映射元数据应用映射。Person
2 通过调用该方法设置不同的表名。inTable(…)
3 指定转换为子句的查询。WHERE
4 应用对象。 在本例中设置为 并返回受影响的行数。Updateage42

删除数据

您可以使用入口点删除行。 删除数据从要从中删除的表的规范开始，并选择性地接受 a to create 子句。delete()CriteriaWHEREspring-doc.cn

请考虑以下简单的 insert 操作：spring-doc.cn

		Mono<Long> delete = template.delete(Person.class)	(1)
				.from("other_table")															(2)
				.matching(query(where("firstname").is("John")))		(3)
				.all();																						(4)
1 删除对象并根据映射元数据应用映射。Person
2 通过调用该方法设置不同的表名。from(…)
3 指定转换为子句的查询。WHERE
4 应用 delete 操作并返回受影响的行数。

使用 Repositories 时，可以使用该方法保存实体。 如果实体是新实体，则会导致实体的插入。ReactiveCrudRepository.save(…)spring-doc.cn

如果实体不是新实体，则会更新该实体。 请注意，实例是否为新实例是实例状态的一部分。spring-doc.cn

这种方法有一些明显的缺点。 如果实际只更改了很少的引用实体，则删除和插入是浪费。 虽然这个过程可以而且可能会得到改进，但 Spring Data R2DBC 可以提供的功能存在一定的限制。 它不知道聚合的先前状态。 因此，任何更新过程都必须获取它在数据库中找到的任何内容，并确保将其转换为传递给 save 方法的实体的状态。

ID 生成

Spring Data 使用 identifer 属性来标识实体。 实体的 ID 必须使用 Spring Data 的 @Id 注释进行注释。spring-doc.cn

当您的数据库具有 ID 列的自动增量列时，在将生成的值插入数据库后，将在实体中设置该值。spring-doc.cn

当实体是新实体并且标识符值默认为其初始值时，Spring Data 不会尝试插入标识符列的值。 这适用于基元类型，并且 identifier 属性使用数字包装器类型，例如 .0nullLongspring-doc.cn

实体状态检测 详细介绍了检测实体是新实体还是应存在于数据库中的策略。spring-doc.cn

一个重要的约束是，在保存实体后，该实体不能再是新的。 请注意，实体是否为 new 是实体状态的一部分。 对于自增列，这会自动发生，因为 ID 是由 Spring Data 使用 ID 列中的值设置的。spring-doc.cn

乐观锁定

Spring Data 通过在聚合根上用 @Version 注释的 numeric 属性来支持乐观锁定。 每当 Spring Data 保存具有此类 version 属性的聚合时，都会发生两种情况：spring-doc.cn

  • 聚合根的 update 语句将包含一个 where 子句，用于检查存储在数据库中的版本是否实际保持不变。spring-doc.cn

  • 如果不是这种情况，就会被抛出。OptimisticLockingFailureExceptionspring-doc.cn

此外，version 属性在实体和数据库中都会增加，因此并发操作将注意到更改并引发如上所述的 if 适用。OptimisticLockingFailureExceptionspring-doc.cn

此过程也适用于插入新聚合，其中 a 或 version 表示新实例，随后增加的实例将该实例标记为不再是新的，这使得这在对象构建期间生成 id 的情况（例如使用 UUID 时）非常有效。null0spring-doc.cn

在删除期间，版本检查也适用，但不会增加版本。spring-doc.cn

@Table
class Person {

  @Id Long id;
  String firstname;
  String lastname;
  @Version Long version;
}

R2dbcEntityTemplate template = …;

Mono<Person> daenerys = template.insert(new Person("Daenerys"));                      (1)

Person other = template.select(Person.class)
                 .matching(query(where("id").is(daenerys.getId())))
                 .first().block();                                                    (2)

daenerys.setLastname("Targaryen");
template.update(daenerys);                                                            (3)

template.update(other).subscribe(); // emits OptimisticLockingFailureException        (4)
1 最初插入行。 设置为 。version0
2 加载刚刚插入的行。 仍然是 。version0
3 使用 更新行。将 and bump 设置为 。version = 0lastnameversion1
4 尝试更新以前加载的行，该行仍具有 .操作失败并显示 ，因为电流为 。version = 0OptimisticLockingFailureExceptionversion1