Spring Data JPA -- 删除方法

Spring Data JPA允许我们定义从数据库读取、更新或删除记录的派生方法。这非常有用,因为它减少了数据访问层的样板代码。接下来,将重点介绍如何定义和使用Spring Data JPA派生的delete方法以及实际的代码示例。

1、派生方法deleteBy():

首先定义一个水果实体以保存水果店中可用商品的名称和颜色:

@Entity
@Data
public class Fruit {
    @Id
    private long id;
    private String name;
    private String color;
}

​ 然后,新建JpaRepository接口并将派生的方法添加到此类,从而添加要在Fruit实体上运行的存储库。可以将派生的方法定义为实体中定义的动词+属性。一些允许的动词是findBy,deleteBy和removeBy。

接下来我们推导一种删除水果名称的方法:

@Repository
public interface FruitRepository extends JpaRepository<Fruit, Long> {
    Long deleteByName(String name);
}

在此示例中,deleteByName()方法返回的是已删除记录的计数。

同样,我们还可以导出以下形式的delete()方法:

List<Fruit> deleteByColor(String color);

在这里,deleteByColor()方法删除具有给定颜色的所有水果,并返回已删除记录的列表。

为了测试派生的删除方法。首先,通过在test-fruit-data.sql中定义数据,并在Fruit表中插入四条记录:

insert into fruit(id,name,color) values (1,'apple','red');
insert into fruit(id,name,color) values (2,'custard apple','green');
insert into fruit(id,name,color) values (3,'mango','yellow');
insert into fruit(id,name,color) values (4,'guava','green');

然后去删除所有“green”颜色的水果:

@Transactional
@Test
@Sql(scripts = { "/test-fruit-data.sql" })
public void givenFruits_WhenDeletedByColor_ThenDeletedFruitsShouldReturn() {
     List<Fruit> fruits = fruitRepository.deleteByColor("green");
     assertEquals("number of fruits are not matching", 2, fruits.size());
     fruits.forEach(fruit -> assertEquals("It's not a green fruit", "green", fruit.getColor()));
}

需要注意的是,需要在delete()方法上使用@Transactional注解

接下来,使用第二个deleteBy方法添加一个类似的测试用例:

@Transactional
@Test
@Sql(scripts = { "/test-fruit-data.sql" })
public void givenFruits_WhenDeletedByName_ThenDeletedFruitCountShouldReturn() {
    Long deletedFruitCount = fruitRepository.deleteByName("apple");
    assertEquals("deleted fruit count is not matching", 1, deletedFruitCount.intValue());
}

2、派生方法removeBy()

同样可以通过动词removeBy来派生delete()方法:

Long removeByName(String name);
List<Fruit> removeByColor(String color);

注:两种方法的行为没有区别。

最终接口展示如下所示:

@Repository
public interface FruitRepository extends JpaRepository<Fruit, Long> {
    Long deleteByName(String name);
    List<Fruit> deleteByColor(String color);
 
    Long removeByName(String name);
    List<Fruit> removeByColor(String color);
}

为removeBy方法添加类似的单元测试:

@Transactional
@Test
@Sql(scripts = { "/test-fruit-data.sql" })
public void givenFruits_WhenRemovedByColor_ThenDeletedFruitsShouldReturn() {
    List<Fruit> fruits = fruitRepository.removeByColor("green");
 
    assertEquals("number of fruits are not matching", 2, fruits.size());
}
@Transactional
@Test
@Sql(scripts = { "/test-fruit-data.sql" })
public void givenFruits_WhenRemovedByName_ThenDeletedFruitCountShouldReturn() {
    Long deletedFruitCount = fruitRepository.removeByName("apple");
 
    assertEquals("deleted fruit count is not matching", 1, deletedFruitCount.intValue());
}

3、删除功能的派生方法 VS @Query

​ 我们可能遇到一种情况,该情况会使派生方法的名称太大,或者在不相关实体之间涉及到SQL JOIN。在这种情况下,我们就可以通过使用@Query和@Modifying注释来实现删除操作。

接下来将使用自定义查询来查看派生的delete()方法的等效代码:

@Modifying
@Query("delete from Fruit f where f.name=:name or f.color=:color")
List<int> deleteFruits(@Param("name") String name, @Param("color") String color);

​ 尽管这两种解决方案看起来很相似,并且确实实现了相同的结果,但是它们采用的方法略有不同。@Query方法针对数据库创建单个JPQL查询。相比之下,deleteBy()方法执行读取查询,然后逐个删除每个项目。同时,deleteBy()方法可以返回已删除记录的列表,而自定义查询只能返回已删除记录的数量。

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

推荐阅读更多精彩内容