SpringData系列四：方法定义规范

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

class User｛
	private String firstName; 
    private String lastName; 
｝

使用And条件连接时，应这样写：findByLastNameAndFirstName(String lastName,String firstName); 条件的属性名称与个数要与参数的位置与个数一一对应。
2、支持的关键字写法如下：
在这里插入图片描述

3、查询流程：
假如创建如下的查询：findByUserDepUuid()，框架在解析该方法时，首先剔除 findBy，然后对剩下的属性进行解析，假设查询实体为Doc。
（1）、先判断 userDepUuid （根据 POJO 规范，首字母变为小写）是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，继续第二步；
（2）、从右往左截取第一个大写字母开头的字符串(此处为Uuid)，然后检查剩下的字符串是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，则重复第二步，继续从右往左截取；最后假设 user 为查询实体的一个属性；
（3）、接着处理剩下部分（DepUuid），先判断 user 所对应的类型是否有depUuid属性，如果有，则表示该方法最终是根据 “ Doc.user.depUuid” 的取值进行查询；否则继续按照步骤 2 的规则从右往左截取，最终表示根据 “Doc.user.dep.uuid” 的值进行查询。
（4）、可能会存在一种特殊情况，比如 Doc包含一个 user 的属性，也有一个 userDep 属性，此时会存在混淆。可以明确在属性之间加上 “_” 以显式表达意图，比如 “findByUser_DepUuid()” 或者 “findByUserDep_uuid()”
特殊的参数：还可以直接在方法的参数上加入分页或排序的参数，比如：

Page<UserModel> findByName(String name, Pageable pageable);
List<UserModel> findByName(String name, Sort sort);

测试：
创建实体类Address

@Table(name="JPA_ADDRESSES")
@Entity
public class Address {

	private Integer id;
	private String province;
	private String city;

	@GeneratedValue
	@Id
	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	public String getProvince() {
		return province;
	}

	public void setProvince(String province) {
		this.province = province;
	}

	public String getCity() {
		return city;
	}

	public void setCity(String city) {
		this.city = city;
	}

}

在实体类Person中添加address属性及其getter和setter方法

private Address address;
	
@JoinColumn(name="ADDRESS_ID")
@ManyToOne
public Address getAddress() {
	return address;
}

public void setAddress(Address address) {
	this.address = address;
}

在PersonRepsotory定义方法

//WHERE lastName LIKE ?% AND id < ?
List<Person> getByLastNameStartingWithAndIdLessThan(String lastName, Integer id);

//WHERE lastName LIKE %? AND id < ?
List<Person> getByLastNameEndingWithAndIdLessThan(String lastName, Integer id);

//WHERE email IN (?, ?, ?) OR birth < ?
List<Person> getByEmailInAndBirthLessThan(List<String> emails, Date birth);

//WHERE a.id > ?
List<Person> getByAddress_IdGreaterThan(Integer id);

编写测试方法

@Test
public void testKeyWords(){
	List<Person> persons = personRepsotory.getByLastNameStartingWithAndIdLessThan("X", 10);
	System.out.println(persons);
	persons = personRepsotory.getByLastNameEndingWithAndIdLessThan("X", 10);
	System.out.println(persons);
	persons = personRepsotory.getByEmailInAndBirthLessThan(Arrays.asList("[email protected]", "[email protected]",
			"[email protected]"), new Date());
	System.out.println(persons.size());
}

@Test
public void testKeyWords2(){
	List<Person> persons = personRepsotory.getByAddress_IdGreaterThan(1);
	System.out.println(persons);
}

控制台输出：

Hibernate: 
    select
        person0_.id as id0_,
        person0_.birth as birth0_,
        person0_.email as email0_,
        person0_.last_name as last4_0_ 
    from
        jpa_persons person0_ 
    where
        (
            person0_.last_name like ?
        ) 
        and person0_.id<?
[Person [id=1, lastName=AA, [email protected], brith=2018-11-17 00:00:00.0]]
Hibernate: 
    select
        person0_.id as id0_,
        person0_.birth as birth0_,
        person0_.email as email0_,
        person0_.last_name as last4_0_ 
    from
        jpa_persons person0_ 
    where
        (
            person0_.last_name like ?
        ) 
        and person0_.id<?
[Person [id=1, lastName=AA, [email protected], brith=2018-11-17 00:00:00.0]]
Hibernate: 
    select
        person0_.id as id0_,
        person0_.birth as birth0_,
        person0_.email as email0_,
        person0_.last_name as last4_0_ 
    from
        jpa_persons person0_ 
    where
        (
            person0_.email in (
                ? , ? , ?
            )
        ) 
        and person0_.birth<?
1

在这里插入图片描述

SpringData系列四：方法定义规范

猜你喜欢