Spring Data Jpa --- 入门
一、概述
Spring Data是Spring下的一个子项目，用于简化数据库访问，并支持云服务的开源框架。Spring Data支持NoSQL和 关系数据存储，其主要目标是使得数据库的访问变得方便快捷。并支持map-reduce框架和云计算数据服务。对于拥有海量数据的项目，可以用Spring Data来简化项目的开发。 然而针对不同的数据储存访问使用相对的类库来操作访问。Spring Data中已经为我们提供了很多业务中常用的一些接口和实现类来帮我们快速构建项目，比如分页、排序、DAO一些常用的操作。
二、环境搭建
1.1 导入jar包
1.2 applicationContext.xml配置
org.hibernate.cfg.ImprovedNamingStrategy
org.hibernate.dialect.Oracle10gDialect
true
true
update
三、Repository接口
Repository 接口是 Spring Data 的一个核心接口，它不提供任何方法，开发者需要在自己定义的接口中声明需要的方法。
public interface Repository {} - Repository是一个空接口，即是一个标记接口
- 若我们定义的接口继承了Repository，则该接口会被IOC容器识别为一个Repository Bean注入到IOC容器中，只要遵循Spring Data的方法定义规范，就无需写实现类。
- 与继承 Repository 等价的一种方式，就是在持久层接口上使用 @RepositoryDefinition 注解，并为其指定 domainClass 和 idClass 属性。如下两种方式是完全等价的
@RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)基础的 Repository 提供了最基本的数据访问功能，其几个子接口则扩展了一些功能。它们的继承关系如下：
- Repository： 仅仅是一个标识，表明任何继承它的均为仓库接口类
- CrudRepository： 继承 Repository，实现了一组 CRUD 相关的方法
- PagingAndSortingRepository： 继承 CrudRepository，实现了一组分页排序相关的方法
- JpaRepository： 继承 PagingAndSortingRepository，实现一组 JPA 规范相关的方法
3.2 Spring Data方法定义规范
查询方法以find | read | get开头，设计条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性以首字母大写。
例如：定义一个 Entity 实体类
class User｛
private String firstName;
private String lastName;
｝使用And条件连接时，应这样写：
findByLastNameAndFirstName(String lastName,String firstName); 条件的属性名称与个数要与参数的位置与个数一一对应
三、CrudRepository接口
CrudRepository 接口提供了最基本的对实体类的添删改查操作
- T save(T entity);//保存单个实体
- Iterable
save(Iterable entities);//保存集合 - T findOne(ID id);//根据id查找实体
- boolean exists(ID id);//根据id判断实体是否存在
- Iterable
findAll();//查询所有实体,不用或慎用! - long count();//查询实体数量
- void delete(ID id);//根据Id删除实体
- void delete(T entity);//删除一个实体
- void delete(Iterable entities);//删除一个实体的集合
- void deleteAll();//删除所有实体,不用或慎用!
四、PagingAndSortingRepository接口
PagingAndSortingRepository接口提供了分页与排序的功能：
- Iterable
findAll(Sort sort); //排序 - Page
findAll(Pageable pageable); //分页查询（含排序功能）
五、JpaRepository接口
JpaRepository接口提供了JPA的相关功能：
- List
findAll(); //查找所有实体 - List
findAll(Sort sort); //排序、查找所有实体 - List
save(Iterable entities);//保存集合 - void flush();//执行缓存与数据库同步
- T saveAndFlush(T entity);//强制执行持久化
- void deleteInBatch(Iterable
entities);//删除一个实体集合
示例代码
Person实体类
package com.test.springdata;
import java.util.Date;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.Table;
@Table(name="JPA_PERSONS")
@Entity
public class Person {
private Integer id;
private String lastName;
private String email;
private Date birth;
private Address address;
private Integer addressId;
@GeneratedValue
@Id
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
@Column(name="ADD_ID")
public Integer getAddressId() {
return addressId;
}
public void setAddressId(Integer addressId) {
this.addressId = addressId;
}
@JoinColumn(name="ADDRESS_ID")
@ManyToOne
public Address getAddress() {
return address;
}
public void setAddress(Address address) {
this.address = address;
}
@Override
public String toString() {
return "Person [id=" + id + ", lastName=" + lastName + ", email="
+ email + ", brith=" + birth + "]";
}
}
Address实体类
package com.test.springdata;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;
@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;
}
}
JpaRepsotory类 --- PersonRepsotory类
package com.test.springdata;
import java.util.Date;
import java.util.List;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.RepositoryDefinition;
import org.springframework.data.repository.query.Param;
/**
* 1、Repository 是一个空接口，即使一个标记接口
* 2、若我们定义的接口继承了Repository，则该接口会被IOC容器识别为一个Repository Bean
* 纳入到IOC容器中，进而可以在该接口中定义满足一定规范的方法
* 3、可以通过注解的方式标记Repository接口
*/
/**
* 方式一：继承Repository接口
* public interface PersonRepsotory extends Repository{
* */
/**
* 方式二：注解@RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)
*
*/
/**
* 在Repository子接口中声明方法
* 1、不是随便声明的，而需要符合一定的规范
* 2、查询方法以find | read | get开头
* 3、涉及条件查询时，条件的属性用条件关键字连接
* 4、要注意的是：条件属性以首字母大写
* 5、支持属性的级联查询，若当前类有符合条件的属性，则优先使用，而不使用级联属性。若需要使用级联属性，则属性之间使用_连接
*
*/
// @RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)
//public interface PersonRepsotory extends Repository{
//public interface PersonRepsotory extends CrudRepository{
//public interface PersonRepsotory extends JpaRepository,JpaSpecificationExecutor{
public interface PersonRepsotory extends Repository{
// 根据lastName来获取对应的Person
Person getByLastName(String lastName);
// Where lastName like ?% And id < ?
List getByLastNameStartingWithAndIdLessThan(String lastName, Integer id);
// Where lastName like %? And id < ?
List getByLastNameEndingWithAndIdLessThan(String lastName, Integer id);
//WHERE email IN (?, ?, ?) OR birth < ?
List getByEmailInAndBirthLessThan(List emails, Date birth);
//WHERE a.id > ?
List getByAddress_IdGreaterThan(Integer id);
//查询 id 值最大的那个 Person
//使用 @Query 注解可以自定义 JPQL 语句以实现更灵活的查询
@Query("SELECT p FROM Person p WHERE p.id = (SELECT max(p2.id) FROM Person p2)")
Person getMaxIdPerson();
//为 @Query 注解传递参数的方式1: 使用占位符.
@Query("SELECT p FROM Person p WHERE p.lastName = ?1 AND p.email = ?2")
List testQueryAnnotationParams1(String lastName, String email);
//为 @Query 注解传递参数的方式1: 命名参数的方式.
@Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")
List testQueryAnnotationParams2(@Param("email") String email, @Param("lastName") String lastName);
//SpringData 允许在占位符上添加 %%.
@Query("SELECT p FROM Person p WHERE p.lastName LIKE %?1% OR p.email LIKE %?2%")
List testQueryAnnotationLikeParam(String lastName, String email);
//SpringData 允许在占位符上添加 %%.
@Query("SELECT p FROM Person p WHERE p.lastName LIKE %:lastName% OR p.email LIKE %:email%")
List testQueryAnnotationLikeParam2(@Param("email") String email, @Param("lastName") String lastName);
//设置 nativeQuery=true 即可以使用原生的 SQL 查询
@Query(value="SELECT count(id) FROM jpa_persons", nativeQuery=true)
long getTotalCount();
//可以通过自定义的 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);
}
PersonService类
package com.test.springdata;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Service
public class PersonService {
@Autowired
private PersonRepsotory personRepsotory;
@Transactional
public void savePersons(List persons){
personRepsotory.save(persons);
}
@Transactional
public void updatePersonEmail(String email, Integer id){
personRepsotory.updatePersonEmail(id, email);
}
}
Test类
package com.test.springdata.test;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Path;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Root;
import javax.sql.DataSource;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Sort;
import org.springframework.data.domain.Sort.Direction;
import org.springframework.data.domain.Sort.Order;
import org.springframework.data.jpa.domain.Specification;
import com.test.springdata.Person;
import com.test.springdata.PersonRepsotory;
import com.test.springdata.PersonService;
public class SpringDataTest {
private ApplicationContext ctx = null;
private PersonRepsotory personRepsotory = null;
private PersonService personService;
{
ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
personRepsotory = ctx.getBean(PersonRepsotory.class);
personService = ctx.getBean(PersonService.class);
}
/*@Test
public void testCommonCustomRepositoryMethod(){
ApplicationContext ctx2 = new ClassPathXmlApplicationContext("classpath:com/atguigu/springdata/commonrepositorymethod/applicationContext2.xml");
AddressRepository addressRepository = ctx2.getBean(AddressRepository.class);
addressRepository.method();
}
@Test
public void testCustomRepositoryMethod(){
personRepsotory.test();
}*/
/**
* 目标: 实现带查询条件的分页. id > 5 的条件
*
* 调用 JpaSpecificationExecutor 的 Page findAll(Specification spec, Pageable pageable);
* Specification: 封装了 JPA Criteria 查询的查询条件
* Pageable: 封装了请求分页的信息: 例如 pageNo, pageSize, Sort
*/
/*@Test
public void testJpaSpecificationExecutor(){
int pageNo = 3 - 1;
int pageSize = 5;
PageRequest pageable = new PageRequest(pageNo, pageSize);
//通常使用 Specification 的匿名内部类
Specification specification = new Specification() {
*//**
* @param *root: 代表查询的实体类.
* @param query: 可以从中可到 Root 对象, 即告知 JPA Criteria 查询要查询哪一个实体类. 还可以
* 来添加查询条件, 还可以结合 EntityManager 对象得到最终查询的 TypedQuery 对象.
* @param *cb: CriteriaBuilder 对象. 用于创建 Criteria 相关对象的工厂. 当然可以从中获取到 Predicate 对象
* @return: *Predicate 类型, 代表一个查询条件.
*//*
@Override
public Predicate toPredicate(Root root,
CriteriaQuery query, CriteriaBuilder cb) {
Path path = root.get("id");
Predicate predicate = cb.gt(path, 5);
return predicate;
}
};
Page page = personRepsotory.findAll(specification, pageable);
System.out.println("总记录数: " + page.getTotalElements());
System.out.println("当前第几页: " + (page.getNumber() + 1));
System.out.println("总页数: " + page.getTotalPages());
System.out.println("当前页面的 List: " + page.getContent());
System.out.println("当前页面的记录数: " + page.getNumberOfElements());
}*/
/*@Test
public void testJpaRepository(){
Person person = new Person();
person.setBirth(new Date());
person.setEmail("[email protected]");
person.setLastName("xyz");
Person person2 = personRepsotory.saveAndFlush(person);
System.out.println(person == person2);
}*/
/*@Test
public void testPagingAndSortingRespository(){
//pageNo 从 0 开始.
int pageNo = 0;
int pageSize = 5;
//Pageable 接口通常使用的其 PageRequest 实现类. 其中封装了需要分页的信息
//排序相关的. Sort 封装了排序的信息
//Order 是具体针对于某一个属性进行升序还是降序.
Order order1 = new Order(Direction.DESC, "id");
Order order2 = new Order(Direction.ASC, "email");
Sort sort = new Sort(order1, order2);
PageRequest pageable = new PageRequest(pageNo, pageSize, sort);
Page page = personRepsotory.findAll(pageable);
System.out.println("总记录数: " + page.getTotalElements());
System.out.println("当前第几页: " + (page.getNumber() + 1));
System.out.println("总页数: " + page.getTotalPages());
System.out.println("当前页面的 List: " + page.getContent());
System.out.println("当前页面的记录数: " + page.getNumberOfElements());
}*/
@Test
public void testCrudReposiory(){
List persons = new ArrayList<>();
for(int i = 'a'; i <= 'z'; i++){
Person person = new Person();
person.setAddressId(i + 1);
person.setBirth(new Date());
person.setEmail((char)i + "" + (char)i + "@atguigu.com");
person.setLastName((char)i + "" + (char)i);
persons.add(person);
}
personService.savePersons(persons);
}
@Test
public void testModifying(){
// personRepsotory.updatePersonEmail(1, "[email protected]");
personService.updatePersonEmail("[email protected]", 1);
}
@Test
public void testNativeQuery(){
long count = personRepsotory.getTotalCount();
System.out.println(count);
}
@Test
public void testQueryAnnotationLikeParam(){
// List persons = personRepsotory.testQueryAnnotationLikeParam("%A%", "%bb%");
// System.out.println(persons.size());
// List persons = personRepsotory.testQueryAnnotationLikeParam("A", "bb");
// System.out.println(persons.size());
List persons = personRepsotory.testQueryAnnotationLikeParam2("bb", "A");
System.out.println(persons.size());
}
@Test
public void testQueryAnnotationParams2(){
List persons = personRepsotory.testQueryAnnotationParams2("[email protected]", "AA");
System.out.println(persons);
}
@Test
public void testQueryAnnotationParams1(){
List persons = personRepsotory.testQueryAnnotationParams1("AA", "[email protected]");
System.out.println(persons);
}
@Test
public void testQueryAnnotation(){
Person person = personRepsotory.getMaxIdPerson();
System.out.println(person);
}
@Test
public void testKeyWords2(){
List persons = personRepsotory.getByAddress_IdGreaterThan(1);
System.out.println(persons);
}
@Test
public void testKeyWords(){
List 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 testHelloWorldSpringData() throws FileNotFoundException, IOException, InstantiationException, IllegalAccessException{
System.out.println(personRepsotory.getClass().getName());
Person person = personRepsotory.getByLastName("AA");
System.out.println(person);
}
@Test
public void testJpa(){
}
@Test
public void testDataSource() throws SQLException {
DataSource dataSource = ctx.getBean(DataSource.class);
System.out.println(dataSource.getConnection());
}
}
六、JpaSpecificationExecutor接口
不属于Repository体系，实现一组 JPA Criteria 查询相关的方法 
Specification：封装 JPA Criteria 查询条件。
通常使用匿名内部类的方式来创建该接口的对象
示例代码：
Test代码，其他代码参考JpaRepository
/**
* 目标: 实现带查询条件的分页. id > 5 的条件
*
* 调用 JpaSpecificationExecutor 的 Page findAll(Specification spec, Pageable pageable);
* Specification: 封装了 JPA Criteria 查询的查询条件
* Pageable: 封装了请求分页的信息: 例如 pageNo, pageSize, Sort
*/
@Test
public void testJpaSpecificationExecutor(){
int pageNo = 3 - 1;
int pageSize = 5;
PageRequest pageable = new PageRequest(pageNo, pageSize);
//通常使用 Specification 的匿名内部类
Specification specification = new Specification() {
/**
* @param *root: 代表查询的实体类.
* @param query: 可以从中可到 Root 对象, 即告知 JPA Criteria 查询要查询哪一个实体类. 还可以
* 来添加查询条件, 还可以结合 EntityManager 对象得到最终查询的 TypedQuery 对象.
* @param *cb: CriteriaBuilder 对象. 用于创建 Criteria 相关对象的工厂. 当然可以从中获取到 Predicate 对象
* @return: *Predicate 类型, 代表一个查询条件.
*/
@Override
public Predicate toPredicate(Root root,
CriteriaQuery query, CriteriaBuilder cb) {
Path path = root.get("id");
Predicate predicate = cb.gt(path, 5);
return predicate;
}
};
Page page = personRepsotory.findAll(specification, pageable);
System.out.println("总记录数: " + page.getTotalElements());
System.out.println("当前第几页: " + (page.getNumber() + 1));
System.out.println("总页数: " + page.getTotalPages());
System.out.println("当前页面的 List: " + page.getContent());
System.out.println("当前页面的记录数: " + page.getNumberOfElements());
} 七、自定义Repository接口
步骤：
- 定义一个接口: 声明要添加的, 并自实现的方法
- 提供该接口的实现类: 类名需在要声明的 Repository 后添加 Impl, 并实现方法
- 声明 Repository 接口, 并继承 1) 声明的接口使用。
示例代码：
PersonDao接口
package com.test.springdata;
public interface PersonDao {
void test();
}
PersonDao实现类
package com.test.springdata;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
public class PersonRepsotoryImpl implements PersonDao {
@PersistenceContext
private EntityManager entityManager;
@Override
public void test() {
Person person = entityManager.find(Person.class, 11);
System.out.println("-->" + person);
}
}
PersonRepository类需要继承PersonDao接口
Test方法
@Test
public void testCustomRepositoryMethod(){
personRepsotory.test();
}八、@Query注解
8.1 使用@Query自定义查询，这种查询可以声明在Repository方法中，摆脱像命名查询那样的约束，将查询直接在响应的接口方法中声明，结构更为清晰，这是Spring data的特有实现。
//为 @Query 注解传递参数的方式1: 命名参数的方式.
@Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")
List testQueryAnnotationParams2(@Param("email") String email, @Param("lastName") String lastName); 8.2 使用@Query的nativeQuery=true，这样可以使用原生的SQL查询
//设置 nativeQuery=true 即可以使用原生的 SQL 查询
@Query(value="SELECT count(id) FROM jpa_persons", nativeQuery=true)
long getTotalCount();注：详细内容参考JpaRepository示例代码
九、@Modifying注解
在 @Query 注解中编写 JPQL 语句, 但必须使用 @Modifying 进行修饰. 以通知 SpringData, 这是一个 UPDATE 或 DELETE 操作
//可以通过自定义的 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);注意： 在调用的地方必须加事务，没有事务不能正常执行