CrudRepository JpaRepository PagingAndSortingRepository之间的区别

1. 简介

本文介绍三种不同的Spring Data repository和它们的功能,包含以下三种:

  • CrudRepository
  • PagingAndSortingRepository
  • JpaRepository
    简单地说,Spring Data中的每个repository都继承自Repository接口,但是,除此之外,它们每个又有不同的功能。

2. Spring Data Repositories

首先介绍JpaRepository,它继承自PagingAndSortingRepository,而PagingAndSortingRepository又继承自CrudRepository
每个都有自己的功能:

  • CrudRepository提供CRUD的功能。
  • PagingAndSortingRepository提供分页和排序功能
  • JpaRepository提供JPA相关的方法,如刷新持久化数据、批量删除。

由于三者之间的继承关系,所以JpaRepository包含了CrudRepository和PagingAndSortingRepository所有的API

当我们不需要JpaRepository和PagingAndSortingRepository提供的功能时,可以简单使用CrudRepository。

下面我们通过例子更好地理解它们提供的API。
首先创建Product实体:

@Entity
public class Product {
 
    @Id
    private long id;
    private String name;
 
    // getters and setters
}

然后实现通过名称查询Product的操作:

@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {
    Product findByName(String productName);
}

这样就实现了通过名称查询Product的方法,Spring Data Repository根据方法名自动生成相应的实现。

3. CrudRepository

先看下CrudRepository接口的源码:

public interface CrudRepository<T, ID extends Serializable>
  extends Repository<T, ID> {
 
    <S extends T> S save(S entity);
 
    T findOne(ID primaryKey);
 
    Iterable<T> findAll();
 
    Long count();
 
    void delete(T entity);
 
    boolean exists(ID primaryKey);
}

方法功能介绍:

  • save(...) – 保存多个对象。这里,我们可以传多个对象批量保存。
  • findOne(...) – 根据传入的主键值获取单一对象。
  • findAll(...) – 查询数据库中所有对象。
  • count() – 返回表中记录总数。
  • delete(...) – 根据传入的对象删除记录。
  • exists(...) – 根据传入的主键值判断对象是否存在。
    CrudRepository接口看起来非常简单,但实际上它提供了所有基本查询保存等操作。

4. PagingAndSortingRepository

PagingAndSortingRepository接口的源码如下:

public interface PagingAndSortingRepository<T, ID extends Serializable> 
  extends CrudRepository<T, ID> {
 
    Iterable<T> findAll(Sort sort);
 
    Page<T> findAll(Pageable pageable);
}

该接口提供了findAll(Pageable pageable)这个方法,它是实现分页的关键。
使用Pageable时,需要创建Pageable对象并至少设置下面3个参数:

  • 1、 每页包含记录数
  • 2、 当前页数
  • 3、 排序
    假设我们要显示第一页的结果集,一页不超过5条记录,并根据lastName升序排序,下面代码展示如何使用PageRequest和Sort获取这个结果:
Sort sort = new Sort(new Sort.Order(Direction.ASC, "lastName"));
Pageable pageable = new PageRequest(0, 5, sort);

5. JpaRepository

JpaRepository接口源码:

public interface JpaRepository<T, ID extends Serializable> extends
  PagingAndSortingRepository<T, ID> {
 
    List<T> findAll();
 
    List<T> findAll(Sort sort);
 
    List<T> save(Iterable<? extends T> entities);
 
    void flush();
 
    T saveAndFlush(T entity);
 
    void deleteInBatch(Iterable<T> entities);
}

简单介绍下每个方法的作用:

  • findAll() – 获取数据库表中所有实体。
  • findAll(…) – 根据条件获取排序后的所有实体。
  • save(…) – 保存多个实体。这里可以传入多个对象批量保存。
  • flush() – 将所有挂起的任务刷新到数据库。
  • saveAndFlush(…) – 保存实体并实时刷新到数据库。
  • deleteInBatch(…) – 删除多个实体。这里可以传入多个对象并批量删除。
    显然,JpaRepository接口继承自PagingAndSortingRepository,PagingAndSortingRepository继承自CrudRepository,所以JpaRepository拥有CrudRepository所有的方法。

6. Spring Data Repositories的缺点

尽管Spring Data Repositories有很多优点,但是它们也有缺点:

  1. 这种方式把我们的代码和类库以及具体抽象(如:Page和Pageable)绑定。它们不是这个类库独有的,但是我们必须小心不要暴露这些内部实现的细节。
  2. 通过继承CrudRepository接口,我们暴露了所有方法。这可能满足大部分情况,但是我们可能会遇到这样的情况:我们希望获得对公开的方法的更细粒度的控制,例如创建一个不包含save(...)和delete(...)的ReadOnlyRepository,此时继承CrudRepository就不满足要求了。

参考文献:
CrudRepository, JpaRepository, and PagingAndSortingRepository in Spring Data

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,444评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,421评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,363评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,460评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,502评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,511评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,280评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,736评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,014评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,190评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,848评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,531评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,159评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,411评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,067评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,078评论 2 352