最新的稳定版本请使用 Spring Data Elasticsearch 5.3.1! |
最新的稳定版本请使用 Spring Data Elasticsearch 5.3.1! |
Spring Data 存储库抽象中的中心接口是 。
它需要管理域类以及域类的标识符类型作为类型参数。
此接口主要充当标记接口,用于捕获要使用的类型,并帮助您发现扩展此接口的接口。
CrudRepository
和 ListCrudRepository
接口为正在管理的实体类提供复杂的 CRUD 功能。Repository
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
我们还提供特定于持久性技术的抽象,例如 或 .
这些接口扩展并公开了底层持久性技术的功能,以及相当通用的持久性技术无关的接口,例如 。JpaRepository MongoRepository CrudRepository CrudRepository |
除了 之外,还有 PagingAndSortingRepository
和 ListPagingAndSortingRepository
,它们添加了其他方法来简化对实体的分页访问:CrudRepository
PagingAndSortingRepository
接口public interface PagingAndSortingRepository<T, ID> {
Iterable<T> findAll(Sort sort);
Page<T> findAll(Pageable pageable);
}
扩展接口以实际存储模块为准。 虽然本文档介绍了一般方案,但请确保存储模块支持要使用的接口。 |
要以 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
除了查询方法之外,还可以对计数和删除查询进行查询派生。 以下列表显示了派生计数查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long countByLastname(String lastname);
}
以下列表显示了派生删除查询的接口定义:
interface UserRepository extends CrudRepository<User, Long> {
long deleteByLastname(String lastname);
List<User> removeByLastname(String lastname);
}
1 | 保存给定的实体。 |
2 | 返回由给定 ID 标识的实体。 |
3 | 返回所有实体。 |
4 | 返回实体数。 |
5 | 删除给定实体。 |
6 | 指示是否存在具有给定 ID 的实体。 |
我们还提供特定于持久性技术的抽象,例如 或 .
这些接口扩展并公开了底层持久性技术的功能,以及相当通用的持久性技术无关的接口,例如 。JpaRepository MongoRepository CrudRepository CrudRepository |
扩展接口以实际存储模块为准。 虽然本文档介绍了一般方案,但请确保存储模块支持要使用的接口。 |
实体状态检测策略
下表描述了 Spring Data 提供的用于检测实体是否为新实体的策略:
|
默认情况下,Spring Data 会检查给定实体的标识符属性。
如果标识符属性是 或 如果是基元类型,则假定该实体是新的。
否则,假定它不是新的。 |
|
如果带有 和 注释的属性存在,或者如果是基元类型的 version 属性,则该实体被视为新实体。
如果 version 属性存在但具有不同的值,则该实体被视为不是新的。
如果不存在版本属性,Spring Data 会回退到标识符属性的检查。 |
实施 |
如果实体实现,Spring Data会将新检测委托给实体的方法。
有关详细信息,请参阅 Javadoc。 注意:如果使用 |
提供自定义实现 |
您可以通过创建特定于模块的存储库工厂的子类并重写该方法来自定义存储库库实现中使用的抽象。
然后,您必须将特定于模块的存储库工厂的自定义实现注册为 Spring Bean。
请注意,这很少是必要的。 |
|
默认情况下,Spring Data 会检查给定实体的标识符属性。
如果标识符属性是 或 如果是基元类型,则假定该实体是新的。
否则,假定它不是新的。 |
|
如果带有 和 注释的属性存在,或者如果是基元类型的 version 属性,则该实体被视为新实体。
如果 version 属性存在但具有不同的值,则该实体被视为不是新的。
如果不存在版本属性,Spring Data 会回退到标识符属性的检查。 |
实施 |
如果实体实现,Spring Data会将新检测委托给实体的方法。
有关详细信息,请参阅 Javadoc。 注意:如果使用 |
提供自定义实现 |
您可以通过创建特定于模块的存储库工厂的子类并重写该方法来自定义存储库库实现中使用的抽象。
然后,您必须将特定于模块的存储库工厂的自定义实现注册为 Spring Bean。
请注意,这很少是必要的。 |