SpringData组件之Repository接口方法定义规范

发表于 阅读次数： Valine： 本文字数： 4k 阅读时长 ≈ 4 分钟

简单条件查询

简单条件查询,查询某一个实体类或者集合,按照 Spring Data 的规范，查询方法以 find | read | get 开头，涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性以首字母大写。
例如：定义一个 Entity 实体类：

1
2
3
4
class User{
    private String firstName;
    private String lastName;
}

使用And条件连接时，应这样写：

1
2
//条件的属性名称与个数要与参数的位置与个数一一对应
findByLastNameAndFirstName(String lastName,String firstName);

支持的关键字

直接在接口中定义查询方法，如果是符合规范的，可以不用写实现，目前支持的关键字写法如下：
支持的关键字
支持的关键字

查询方法解析流程

假如创建查询：findByUserDepUuid()，假设查询实体为Doc，框架在解析该方法时，步骤如下：

  • 首先剔除 findBy，然后对剩下的属性进行解析；
  • 先判断 userDepUuid （根据 POJO 规范，首字母变为小写）是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，继续下一步；
  • 从右往左截取第一个大写字母开头的字符串(此处为Uuid)，然后检查剩下的字符串是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，则重复步骤，继续从右往左截取；最后假设 user 为查询实体的一个属性；
  • 接着处理剩下部分（DepUuid），先判断 user 所对应的类型是否有depUuid属性，如果有，则表示该方法最终是根据 “ Doc.user.depUuid” 的取值进行查询；否则继续按照上一步骤的规则从右往左截取，最终表示根据 “Doc.user.dep.uuid” 的值进行查询；
  • 可能会存在一种特殊情况，比如 Doc包含一个 user 的属性，也有一个 userDep 属性，此时会存在混淆。可以明确在属性之间加上 “_” 以显式表达意图，比如 “findByUser_DepUuid()” 或者 “findByUserDep_uuid()”。即支持属性的级联查询， 若当前类有符合条件的属性, 则优先使用, 而不使用级联属性；若需要使用级联属性, 则属性之间使用 _ 进行连接。

使用 @Query 注解

使用@Query自定义查询

这种查询可以声明在 Repository 方法中，摆脱像命名查询那样的约束，将查询直接在相应的接口方法中声明，结构更为清晰，这是 Spring data 的特有实现。例如：

1
2
3
4
//查询 id 值最大的那个 Person
//使用 @Query 注解可以自定义 JPQL 语句以实现更灵活的查询
@Query("SELECT p FROM Person p WHERE p.id = (SELECT max(p2.id) FROM Person p2)")
Person getMaxIdPerson();

索引参数与命名参数

  • 索引参数如下所示，索引值从1开始，查询中 ”?X” 个数需要与方法定义的参数个数相一致，并且顺序也要一致。
1
2
3
//为 @Query 注解传递参数的方式1: 使用占位符.
@Query("SELECT p FROM Person p WHERE p.lastName = ?1 AND p.email = ?2")
List<Person> testQueryAnnotationParams1(String lastName, String email);
  • 命名参数（推荐使用这种方式）：可以定义好参数名，赋值时采用@Param(“参数名”)，而不用管顺序。
1
2
3
//为 @Query 注解传递参数的方式1: 命名参数的方式.
@Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")
List<Person> testQueryAnnotationParams2(@Param("email") String email, @Param("lastName") String lastName);
  • 如果是 @Query 中有 LIKE 关键字，后面的参数需要前面或者后面加 %，这样在传递参数值的时候就可以不加 %
1
2
3
4
5
6
7
//SpringData 允许在占位符上添加 %%.
@Query("SELECT p FROM Person p WHERE p.lastName LIKE %?1% OR p.email LIKE %?2%")
List<Person> testQueryAnnotationLikeParam(String lastName, String email);

//SpringData 允许在占位符上添加 %%.
@Query("SELECT p FROM Person p WHERE p.lastName LIKE %:lastName% OR p.email LIKE %:email%")
List<Person> testQueryAnnotationLikeParam2(@Param("email") String email, @Param("lastName") String lastName);
  • 还可以使用@Query来指定本地查询，只要设置nativeQuery为true，比如：
1
2
3
4
5
6
//设置 nativeQuery=true 即可以使用原生的 SQL 查询
@Query(value="SELECT count(id) FROM jpa_persons", nativeQuery=true)
long getTotalCount();

@Query(value="select * from tbl_user where name like %?1" ,nativeQuery=true)
public List<UserModel> findByUuidOrAge(String name);

@Modifying 注解和事务

@Query 与 @Modifying 执行更新操作

  • @Query 与 @Modifying 这两个 annotation一起声明，可定义个性化更新操作，例如只涉及某些字段更新时最为常用，示例如下：
1
2
3
4
5
6
7
8
9
10
11
12
/**
*
* 可以通过自定义的 JPQL 完成 UPDATE 和 DELETE 操作. 注意: JPQL 不支持使用 INSERT
* 在 @Query 注解中编写 JPQL 语句, 但必须使用 @Modifying 进行修饰. 以通知 SpringData, 这是一个
* UPDATE 或 DELETE 操作
* UPDATE 或 DELETE 操作需要使用事务, 此时需要定义 Service 层. 在 Service 层的方法上添加事务操作.
* 默认情况下, SpringData 的每个方法上有事务, 但都是一个只读事务. 他们不能完成修改操作!
*/

@Modifying
@Query("UPDATE Person p SET p.email = :email WHERE id = :id")
void updatePersonEmail(@Param("id") Integer id, @Param("email") String email);

注意：方法的返回值应该是 int，表示更新语句所影响的行数；在调用的地方必须加事务，没有事务不能正常执行

事务

  • Spring Data 提供了默认的事务处理方式，即所有的查询均声明为只读事务。
  • 对于自定义的方法，如需改变 Spring Data 提供的事务默认方式，可以在方法上注解 @Transactional 声明 。
  • 进行多个 Repository 操作时，也应该使它们在同一个事务中处理，按照分层架构的思想，这部分属于业务逻辑层，因此，需要在 Service 层实现对多个 Repository 的调用，并在相应的方法上声明事务。

PersonRepsotory.java

PersonRepsotory.java
1
2
3
4
5
6
7
8
9

public interface PersonRepsotory extends
    JpaRepository<Person, Integer>,
	JpaSpecificationExecutor<Person>, PersonDao{

	@Modifying
	@Query("UPDATE Person p SET p.email = :email WHERE id = :id")
	void updatePersonEmail(@Param("id") Integer id, @Param("email") String email);
}

PersonService.java

PersonService.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

@Service
public class PersonService {

	@Autowired
	private PersonRepsotory personRepsotory;

	@Transactional
	public void savePersons(List<Person> persons){
		personRepsotory.save(persons);
	}

	@Transactional
	public void updatePersonEmail(String email, Integer id){
		personRepsotory.updatePersonEmail(id, email);
	}
}