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()方法可以返回已删除记录的列表，而自定义查询只能返回已删除记录的数量。