对于最新的稳定版本,请使用 Spring Data Relational 3.4.0! |
核心概念
Spring Data 存储库抽象中的中心接口是 。
它需要 domain 类来管理,并将 domain 类的标识符类型作为类型参数。
此接口主要用作标记接口,用于捕获要使用的类型,并帮助您发现扩展此接口的接口。Repository
Spring Data 将域类型视为实体,更具体地说是聚合。 因此,您将看到整个文档中使用的术语 “entity” 可以与术语 “domain type” 或 “aggregate” 互换。 你可能已经注意到,在引言中,它已经暗示了域驱动的概念。 我们从 DDD 的意义上考虑域对象。 域对象具有标识符(否则这些将是无标识的值对象),当使用某些模式访问数据时,我们需要以某种方式引用标识符。 当我们讨论存储库和查询方法时,引用标识符将变得更加有意义。 |
CrudRepository
和 ListCrudRepository
接口为正在管理的实体类提供复杂的 CRUD 功能。
CrudRepository
接口public interface CrudRepository<T, ID> extends Repository<T, ID> {
<S extends T> S save(S entity); (1)
Optional<T> findById(ID primaryKey); (2)
Iterable<T> findAll(); (3)
long count(); (4)
void delete(T entity); (5)
boolean existsById(ID primaryKey); (6)
// … more functionality omitted.
}
1 | 保存给定的实体。 |
2 | 返回由给定 ID 标识的实体。 |
3 | 返回所有实体。 |
4 | 返回实体数。 |
5 | 删除给定的实体。 |
6 | 指示是否存在具有给定 ID 的实体。 |
此接口中声明的方法通常称为 CRUD 方法。 提供等效的方法,但它们返回的方法返回 .ListCrudRepository
List
CrudRepository
Iterable
存储库接口意味着一些保留方法,例如以域类型标识符属性为目标,而不管其属性名称如何。
在 “定义查询方法” 中阅读更多相关信息。 如果 name 的属性未引用标识符,则可以对查询方法进行批注以提供自定义查询。
遵循这条路径很容易导致混淆,并且不鼓励这样做,因为如果类型和属性的类型不一致,您很快就会达到类型限制。 |
我们还提供特定于持久性技术的抽象,例如 或 。
这些接口扩展并公开了底层持久化技术的功能,以及相当通用的与持久化技术无关的接口,例如。JpaRepository MongoRepository CrudRepository CrudRepository |
除了 之外,还有 PagingAndSortingRepository
和 ListPagingAndSortingRepository
,它们添加了其他方法来简化对实体的分页访问:CrudRepository
PagingAndSortingRepository
接口public interface PagingAndSortingRepository<T, ID> {
Iterable<T> findAll(Sort sort);
Page<T> findAll(Pageable pageable);
}
扩展接口以实际 store 模块支持为准。 虽然本文档解释了一般方案,但请确保您的 store 模块支持您要使用的接口。 |
要按页面大小 20 访问第二个页面,您可以执行以下操作:User
PagingAndSortingRepository<User, Long> repository = // … get access to a bean
Page<User> users = repository.findAll(PageRequest.of(1, 20));
ListPagingAndSortingRepository
提供等效方法,但返回 a,其中方法返回 .List
PagingAndSortingRepository
Iterable
除了查询方法之外,还可以使用 count 和 delete 查询的查询派生。 以下列表显示了派生计数查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long countByLastname(String lastname);
}
下面的清单显示了派生的 delete 查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long deleteByLastname(String lastname);
List<User> removeByLastname(String lastname);
}
实体状态检测策略
下表描述了 Spring Data 提供的用于检测实体是否为新实体的策略:
|
默认情况下, Spring Data 检查给定实体的 identifier 属性。
如果 identifier 属性是 or if 是基元类型,则假定该实体是新的。
否则,将假定它不是 new。 |
|
如果存在带注释的属性,则 和 ,或者如果是基元类型的 version 属性,则该实体被视为新实体。
如果 version 属性存在但具有不同的值,则认为该实体不是新实体。
如果不存在version属性,则 Spring Data 将回退到对标识符属性的检查。 |
实施 |
如果实体实现,则 Spring Data 会将新检测委托给实体的方法。
有关详细信息,请参阅 Javadoc。 注意:如果您使用 |
提供自定义实现 |
您可以通过创建特定于模块的 repository factory 的子类并覆盖该方法来自定义 repository base 实现中使用的抽象。
然后,您必须将特定于模块的存储库工厂的自定义实现注册为 Spring Bean。
请注意,这很少是必需的。 |