如果我的博客能夠幫到大家能夠點個贊,關注一下,以後還會更新更過JavaWeb的高級技術,大家的支持就是我繼續更新的動力。謝謝。
以下來演示一下,JPA的一些接口的使用。首先創建一個Java Project。在當前工程下創建一個lib 目錄,導入以下Jar 包:
-
項目工程結構:
- applicationContext.xml 配置文件:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:jpa="http://www.springframework.org/schema/data/jpa"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa-1.3.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">
<!-- 配置自動掃面的包 -->
<context:component-scan base-package="com.nyist.SpringData"></context:component-scan>
<!-- 1.配置數據源 -->
<context:property-placeholder location="classpath:db.properties"/>
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="user" value="${jdbc.user}"></property>
<property name="password" value="${jdbc.password}"></property>
<property name="jdbcUrl" value="${jdbc.jdbcUrl}"></property>
<property name="driverClass" value="${jdbc.driverClass}"></property>
<!-- 配置其他屬性 -->
</bean>
<!-- 2.配置JPA的EntityManagerFactory -->
<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
<property name="dataSource" ref="dataSource"></property>
<!-- 配置適配器 -->
<property name="jpaVendorAdapter">
<bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"></bean>
</property>
<!-- 配置掃描 -->
<property name="packagesToScan" value="com.nyist.SpringData"></property>
<!-- 配置JPa屬性 -->
<property name="jpaProperties">
<props>
<!-- 二級緩存相關 -->
<!--
<prop key="hibernate.cache.region.factory_class">org.hibernate.cache.ehcache.EhCacheRegionFactory</prop>
<prop key="net.sf.ehcache.configurationResourceName">ehcache-hibernate.xml</prop>
-->
<!-- 生成的數據表的列的映射策略 -->
<prop key="hibernate.ejb.naming_strategy">org.hibernate.cfg.ImprovedNamingStrategy</prop>
<!-- hibernate 基本屬性 -->
<prop key="hibernate.dialect">org.hibernate.dialect.MySQL5InnoDBDialect</prop>
<prop key="hibernate.show_sql">true</prop>
<prop key="hibernate.format_sql">true</prop>
<prop key="hibernate.hbm2ddl.auto">update</prop>
</props>
</property>
</bean>
<!-- 3.配置事務管理容器 -->
<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
<property name="entityManagerFactory" ref="entityManagerFactory"></property>
</bean>
<!-- 4.配置支持註解的事務 -->
<tx:annotation-driven transaction-manager="transactionManager"/>
<!-- 5.配置SpringData -->
<!-- 加入jpa的命名空間 -->
<!-- base-package 自動掃面Repostiory bean 所在的位置 自動放在IOC容器中 自動掃描 -->
<jpa:repositories base-package="com.nyist.SpringData" entity-manager-factory-ref="entityManagerFactory"></jpa:repositories>
</beans>
-
db.properties
jdbc.user=root
jdbc.password=root
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.jdbcUrl=jdbc:mysql:///jpa
-
創建實體
- Person.class
package com.nyist.SpringData.Entity;
import java.util.Date;
import javax.persistence.Table;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
@Table(name="JPA_PERSON")
@Entity
public class Person {
//@GeneratedVale 自動生成主鍵
@GeneratedValue
@Id //指定ID
private Integer id;
private String lastName;
private String email;
private Date birth;
//@ManyToOne 多對1 一個人對應多個地址
@JoinColumn(name="ADDRESS")
@ManyToOne
private Address address;
@Column(name="ADD_ID")
private Integer addressId;
public Integer getAddressId() {
return addressId;
}
public void setAddressId(Integer addressId) {
this.addressId = addressId;
}
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;
}
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 + ", birth=" + birth + "]";
}
}
- Address.class
package com.nyist.SpringData.Entity;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;
@Table(name="JPA_ADDEESS")
@Entity
public class Address {
@GeneratedValue
@Id
private Integer id;
private String province;
private String city;
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;
}
@Override
public String toString() {
return "Address [id=" + id + ", province=" + province + ", city=" + city + ", getId()=" + getId()
+ ", getProvince()=" + getProvince() + ", getCity()=" + getCity() + ", getClass()=" + getClass()
+ ", hashCode()=" + hashCode() + ", toString()=" + super.toString() + "]";
}
}
- 創建PersonRepository.class 接口,內容如下:
package com.nyist.SpringData.Repostiory;
import java.util.Date;
import java.util.List;
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.query.Param;
import com.nyist.SpringData.Entity.Person;
/*
* 1.Repositiory 是一個空接口,即是一個標記接口。
* 2.若我們的接口繼承了Repository,則該接口會被IOC容器識別爲一個Repository Bean
* 納入到IOC容器中,進而可以在該接口中定義滿足一定的規範方法。
* 3.實際上 也可以通過一個註解 @RepositoryDefinition 來代替繼承Repository 接口
*/
//Repostiory<Person,Integer> 需要處理的類型 主鍵類型
//@RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)
/**
* 在 Repository 子接口中聲明方法
* 1.不是隨便聲明的,而需要符合一定的規範
* 2.按照 Spring Data 的規範,查詢方法以 find | read | get 開頭,
* 3.涉及條件查詢時,條件的屬性用條件關鍵字連接,
* 4.要注意的是:條件屬性以首字母大寫。
* 5.若當前類又符合條件的屬性優先使用,而不是用級聯屬性,若需要使用級聯屬性,則屬性之間使用 _ 連接
* @author LHG
*
*/
public interface PersonRepostory extends Repository<Person,Integer>{
//使用SpringData的給定的關鍵字 來查詢
Person getByLastName(String lastName);
//WHERE lastName Like ?% And id < ?
List<Person> getByLastNameStartingWithAndIdLessThan(String lastName,Integer id);
//WHERE lastName Like %? and id < ?
List<Person> getByLastNameEndingWithAndIdGreaterThan(String lastName,Integer id);
//WHERE email IN(?,?,?) OR birth < ?
List<Person> getByEmailInOrBirthLessThan(String email,Date birth);
//WHERE a.id>?
//級聯屬性 AddressId 首先在Person類中 找AddressId 如果找不到 去Address下找ID 級聯屬性
List<Person> 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();
//爲Qeury 註解傳遞參數的方式 :使用佔位符
@Query("SELECT p FROM Person p WHERE p.lastName = ?1 AND p.email = ?2")
List<Person> testQueryAnnotationParms(String lastName,String email);
//爲Query 註解傳遞參數的方式:命名參數的方式
@Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")
List<Person> testQueryAnnotationParms1(@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<Person> testQueryAnnotationLikeParm(String lastName,String email);
//SpringData 允許在佔位符上添加 命名參數的形式
@Query("SELECT p FROM Person p WHERE p.lastName LIKE %:lastName% OR p.email LIKE %:email%")
List<Person> testQueryAnnotationLikeParm2(@Param("email")String email,@Param("lastName")String lastName);
//本地SQL查詢
//設置 nativeQuer=true 即可以使用原生的SQL查詢
@Query(value="SELECT count(id) FROM jpa_person",nativeQuery=true)
long getTotalCount();
//Modifying 標明 要做修改
//可以通過自定義的JPQL 完成 UPDATE 和 DELETE 操作,注意:JPQL 不支持使用INSERT
//在Query註解中編寫JPQL語句 但必須使用Modifying 註解,這是update 或 delete 操作
//在 update 或 delete 操作時候需要使用事務,次似需要定義Service 層,在Service層的方法上添加事務操作。
//默認情況下 SpringData 的每個方法上有事務,但都是隻讀事務,他們不能完成修改操作。
@Modifying
@Query("update Person p set p.email = :email where p.id = :id")
void updatePersonEmail(@Param("id")Integer id,@Param("email")String email);
}
2.測試PersonRepository類如下:
package com.nyist.SpringData.Test;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.List;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.nyist.SpringData.Entity.Person;
import com.nyist.SpringData.Repostiory.PersonRepostory;
import com.nyist.SpringData.Service.PersonService;
public class TestPersonRepository {
private static ApplicationContext ctx=null;
private static PersonRepostory personRepostory = null;
private static PersonService personService = null;
static{
ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
personRepostory = ctx.getBean(PersonRepostory.class);
personService = ctx.getBean(PersonService.class);
}
@Test
public void testJpa(){}
@Test
public void testDataSource(){
Object dataSource = ctx.getBean("dataSource");
System.out.println("DataSource:"+dataSource);
}
@Test
public void testHelloWorldSpringData(){
PersonRepostory personRepostiory = ctx.getBean(PersonRepostory.class);
System.out.println(personRepostiory.getClass().getName());
Person person = personRepostiory.getByLastName("AA");
System.out.println(person);
}
@Test
public void testgetByLastNameStaringWithAndIdLessThan(){
PersonRepostory personRepostory = ctx.getBean(PersonRepostory.class);
List<Person> repostory = personRepostory.getByLastNameStartingWithAndIdLessThan("h",10);
System.out.println(repostory);
}
@Test
public void testgetByLastNameEndingWithAndIdGreaterThan(){
PersonRepostory personRepostory = ctx.getBean(PersonRepostory.class);
List<Person> list = personRepostory.getByLastNameEndingWithAndIdGreaterThan("o", 10);
System.out.println(list);
}
@Test
public void testgetByEmailInOrBirthLessThan() throws ParseException{
PersonRepostory personRepostory = ctx.getBean(PersonRepostory.class);
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");
String s = "2019-02-01";
List<Person> list = personRepostory.getByEmailInOrBirthLessThan("@qq.com",simpleDateFormat.parse(s));
System.out.println(list);
}
@Test
public void testgetByAddressIdGreaterThan(){
PersonRepostory personRepostory = ctx.getBean(PersonRepostory.class);
List<Person> list = personRepostory.getByAddress_IdGreaterThan(5);
System.out.println(list);
}
@Test
public void testQueryAnnotation(){
PersonRepostory personRepostory = ctx.getBean(PersonRepostory.class);
Person person = personRepostory.getMaxIdPerson();
System.out.println(person);
}
@Test
public void testQueryAnnotationParms(){
PersonRepostory personRepostory = ctx.getBean(PersonRepostory.class);
List<Person> person =personRepostory.testQueryAnnotationParms("AA","[email protected]");
System.out.println(person);
}
@Test
public void testQueryAnnotationParms1(){
List<Person> list = personRepostory.testQueryAnnotationParms1("[email protected]","AA");
System.out.println(list);
}
@Test
public void testQueryAnnotationListParm(){
List<Person> list = personRepostory.testQueryAnnotationLikeParm("AA","qq");
System.out.println(list);
}
@Test
public void testQueryAnnotationLikeParm2(){
List<Person> list = personRepostory.testQueryAnnotationLikeParm2("AA","qq");
System.out.println(list);
}
@Test
public void testgetTotalCoung(){
long l = personRepostory.getTotalCount();
System.out.println(l);
}
@Test
public void testupdatePersonEmail(){
personService.updatePersonEmail("[email protected]", 1);
}
}
3.CRUDRepository.java 內容如下:
package com.nyist.SpringData.Repostiory;
import org.springframework.data.repository.CrudRepository;
import com.nyist.SpringData.Entity.Person;
public interface CRUDRepostory extends CrudRepository<Person,Integer>{
/**
* 所有接口:
*
* T save(T entity);//保存單個實體
*
Iterable<T> save(Iterable<? extends T> entities);//保存集合
*
T findOne(ID id);//根據id查找實體
*
boolean exists(ID id);//根據id判斷實體是否存在
*
Iterable<T> findAll();//查詢所有實體,不用或慎用!
*
long count();//查詢實體數量
*
void delete(ID id);//根據Id刪除實體
*
void delete(T entity);//刪除一個實體
*
void delete(Iterable<? extends T> entities);//刪除一個實體的集合
*
void deleteAll();//刪除所有實體,不用或慎用!
*/
}
4.因爲做增刪改需要依賴事務,事務一般時在業務邏輯上進行的,所以編寫了一個CrudRepository.java,內容如下:
package com.nyist.SpringData.Service;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import com.nyist.SpringData.Entity.Person;
import com.nyist.SpringData.Repostiory.CRUDRepostory;
@Service
public class CrudRepositoryService {
@Autowired
private CRUDRepostory crudRepository;
@Transactional
public void savePerson(List<Person> persons){
crudRepository.save(persons);
}
//開啓事務
@Transactional
public Person getById(Integer id){
return crudRepository.findOne(id);
}
@Transactional
public boolean isExistsId(Integer id){
return crudRepository.exists(id);
}
@Transactional
public List<Person> selectAll(){
return (List<Person>) crudRepository.findAll();
}
@Transactional
public int deleteById(Integer id){
crudRepository.delete(id);
return 0;
}
}
5.測試TestCrudRepository類如下:
package com.nyist.SpringData.Test;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.nyist.SpringData.Entity.Person;
import com.nyist.SpringData.Service.CrudRepositoryService;
public class TestCrudRepository {
private static ApplicationContext ctx = null;
private static CrudRepositoryService crudRepositoryService;
static{
ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
crudRepositoryService = ctx.getBean(CrudRepositoryService.class);
}
@Test
public void testCrudRepository(){
List<Person> list = new ArrayList<Person>();
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+"@nyist.com");
person.setLastName((char)i+""+(char)i);
list.add(person);
}
crudRepositoryService.savePerson(list);
}
@Test
public void testgetById(){
Person person = crudRepositoryService.getById(1);
System.out.println("查詢單個實體:"+person);
}
@Test
public void testisExistsId(){
boolean bol = crudRepositoryService.isExistsId(5);
System.out.println("是否存在:"+bol);
}
@Test
public void testSelectAll(){
List<Person> persons = crudRepositoryService.selectAll();
System.out.println("總實體:"+persons);
}
@Test
public void testDeleteById(){
System.out.println(crudRepositoryService.deleteById(20));
}
}
6.PagingAndSortingRepository.java 內容如下:
package com.nyist.SpringData.Repostiory;
import com.nyist.SpringData.Entity.Person;
public interface PagingAndSortingRepository extends org.springframework.data.repository.PagingAndSortingRepository<Person,Integer>{
/***
* Iterable<T> findAll(Sort sort); //排序
Page<T> findAll(Pageable pageable); //分頁查詢(含排序功能)
*/
}
7.TestPagingAndSortingRepository測試類
package com.nyist.SpringData.Test;
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.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.domain.Sort.Direction;
import org.springframework.data.domain.Sort.Order;
import org.springframework.data.repository.PagingAndSortingRepository;
import com.nyist.SpringData.Entity.Person;
public class TestPaginAndSortingRepository {
private static ApplicationContext ctx = null;
private static PagingAndSortingRepository pagingAndSortingRepository;
static{
ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
pagingAndSortingRepository = ctx.getBean(PagingAndSortingRepository.class);
}
@Test
public void testPagingAndSortingRepository(){
//pageNo 從 0 開始
int pageNo = 5 - 1;
int pageSize = 5;
//Pageable 接口通常使用的是PageRequest 實現類,其中封裝了實現分頁的信息
//排序相關
//Order 是具體針對某一個屬性進行升序還是降序
Order order1 = new Order(Direction.DESC,"id");
Order order2 = new Order(Direction.ASC,"email");
Sort sort = new Sort(order1,order2);
PageRequest pageRequest = new PageRequest(pageNo, pageSize,sort);
Page<Person> page = pagingAndSortingRepository.findAll(pageRequest);
System.out.println("總記錄數:"+page.getTotalElements());
System.out.println("當前第幾頁:"+Integer.valueOf(page.getNumber())+1);
System.out.println("當前頁面的List:"+page.getContent());
System.out.println("總頁數:"+page.getTotalPages());
System.out.println("當前頁面的記錄數:"+page.getNumberOfElements());
}
}
8.JpaRepostory.java 內容如下:
package com.nyist.SpringData.Repostiory;
import org.springframework.data.jpa.repository.JpaRepository;
import com.nyist.SpringData.Entity.Person;
public interface SpringDataJpaRepository extends JpaRepository<Person,Integer>{
}
9.測試類如下:
package com.nyist.SpringData.Test;
import java.util.Date;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.nyist.SpringData.Entity.Person;
import com.nyist.SpringData.Repostiory.SpringDataJpaRepository;
public class TestJpaRepository {
private static ApplicationContext ctx = null;
private static SpringDataJpaRepository jpaRepository = null;
static{
ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
jpaRepository = ctx.getBean(SpringDataJpaRepository.class);
}
@Test
public void testJapRepository(){
Person person = new Person();
person.setBirth(new Date());
person.setEmail("[email protected]");
person.setLastName("XY");
person.setId(27);
Person person2 = jpaRepository.saveAndFlush(person);
System.out.println(person==person2);
}
}
10.SpringDataJpaSpecificationExecutor.java 內容如下:
package com.nyist.SpringData.Repostiory;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import com.nyist.SpringData.Entity.Person;
public interface SpringDataJpaSpecificationExecutor extends PagingAndSortingRepository,JpaSpecificationExecutor<Person>{
}
11.測試類如下:
package com.nyist.SpringData.Test;
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 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.jpa.domain.Specification;
import com.nyist.SpringData.Entity.Person;
import com.nyist.SpringData.Repostiory.SpringDataJpaSpecificationExecutor;
public class TestJpaSpecificationExecutor {
private static ApplicationContext ctx = null;
private static SpringDataJpaSpecificationExecutor specificationExecutor = null;
static{
ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
specificationExecutor = ctx.getBean(SpringDataJpaSpecificationExecutor.class);
}
//分頁排序
@Test
public void testJpaSpecificationExecutor(){
int pageNo = 3-1;
int pageSize = 5;
PageRequest pageable = new PageRequest(pageNo,pageSize);
//Specification 是查詢條件
Specification<Person> specification = new Specification<Person>() {
/**
* @Param *root:代表查詢的實體類
* @Param query:可以從中得到Root對象,即告知JPA Criteria 查詢要查詢哪一個實體類,還可以來添加查詢條件,
* 還可以結合EntityManager 對象最終查詢的TypeQuery 對象。
* @Param *cb: CriteriaBuilder 對象。用於創建Criteria 相關對象的工廠,當然可以從中獲取Predicate 對象
* @return *Predicate 類型:代表一個查詢條件。
*/
@Override
public Predicate toPredicate(Root<Person> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
//獲得 實體類得 某個屬性 eg:獲得Id 按照Id 屬性排列
Path path = root.get("id");
//cb.get()調用get方法 獲得查詢條件
Predicate predicate = cb.gt(path,20);
//返回查詢條件
return predicate;
}
};
Page<Person> page = specificationExecutor.findAll(specification, pageable);
System.out.println("總記錄數:"+page.getTotalElements());
System.out.println("當前第幾頁:"+(page.getNumber()+1));
System.out.println("當前頁面的List:"+page.getContent());
System.out.println("總頁數:"+page.getTotalPages());
System.out.println("當前頁面的記錄數:"+page.getNumberOfElements());
}
}
以上是JPA的幾個接口的使用和測試方法。
================================================================================================
最後輻上JPAxia相關的筆記,僅供大家參考
SpringData JPA
一、SpringData
1.Spring Data
Spring 的一個子項目。用於簡化數據庫訪問,支持NoSQL 和 關係數據存儲。其主要目標是使數據庫的訪問變得方便快捷。
-
SpringData 項目所支持 NoSQL 存儲:
-
MongoDB (文檔數據庫)
-
Neo4j(圖形數據庫)
-
Redis(鍵/值存儲)
-
Hbase(列族數據庫)
-
-
SpringData 項目所支持的關係數據存儲技術:
-
JDBC
-
JPA
-
2. JPA Spring Data 概述
-
JPA Spring Data : 致力於減少數據訪問層 (DAO) 的開發量. 開發者唯一要做的,就只是聲明持久層的接口,其他都交給 Spring Data JPA 來幫你完成!
-
框架怎麼可能代替開發者實現業務邏輯呢?比如:當有一個 UserDao.findUserById() 這樣一個方法聲明,大致應該能判斷出這是根據給定條件的 ID 查詢出滿足條件的 User 對象。Spring Data JPA 做的便是規範方法的名字,根據符合規範的名字來確定方法需要實現什麼樣的邏輯。
-
使用 Spring Data JPA 進行持久層開發需要的四個步驟:
-
配置 Spring 整合 JPA
-
在 Spring 配置文件中配置 Spring Data,讓 Spring 爲聲明的接口創建代理對象。配置了 <jpa:repositories> 後,Spring 初始化容器時將會掃描 base-package 指定的包目錄及其子目錄,爲繼承 Repository 或其子接口的接口創建代理對象,並將代理對象註冊爲 Spring Bean,業務層便可以通過 Spring 自動封裝的特性來直接使用該對象。
-
聲明持久層的接口,該接口繼承 Repository,Repository 是一個標記型接口,它不包含任何方法,如必要,Spring Data 可實現 Repository 其他子接口,其中定義了一些常用的增刪改查,以及分頁相關的方法。
-
在接口中聲明需要的方法。Spring Data 將根據給定的策略(具體策略稍後講解)來爲其生成實現代碼。
-
3. 搭建環境
-
同時下載 Spring Data Commons 和 Spring Data JPA 兩個發佈包:
-
Commons 是 Spring Data 的基礎包
-
並把相關的依賴 JAR 文件加入到 CLASSPATH 中
-
-
在 Spring 的配置文件中配置 Spring Data
-
示例代碼:
4. Repository 接口概述
-
Repository 接口是 Spring Data 的一個核心接口,它不提供任何方法,開發者需要在自己定義的接口中聲明需要的方法
-
Spring Data可以讓我們只定義接口,只要遵循 Spring Data的規範,就無需寫實現類。
-
與繼承 Repository 等價的一種方式,就是在持久層接口上使用 @RepositoryDefinition 註解,併爲其指定 domainClass 和 idClass 屬性。如下兩種方式是完全等價的
public interface Repository<T, ID extends Serializable> { }
-
Repository 的子接口
-
基礎的 Repository 提供了最基本的數據訪問功能,其幾個子接口則擴展了一些功能。它們的繼承關係如下:
-
Repository: 僅僅是一個標識,表明任何繼承它的均爲倉庫接口類
-
CrudRepository: 繼承 Repository,實現了一組 CRUD 相關的方法
-
PagingAndSortingRepository: 繼承 CrudRepository,實現了一組分頁排序相關的方法
-
JpaRepository: 繼承 PagingAndSortingRepository,實現一組 JPA 規範相關的方法
-
自定義的 XxxxRepository 需要繼承 JpaRepository,這樣的 XxxxRepository 接口就具備了通用的數據訪問控制層的能力。
-
JpaSpecificationExecutor: 不屬於Repository體系,實現一組 JPA Criteria 查詢相關的方法
-
-
二、SpringData 方法定義規範
-
簡單條件查詢
-
簡單條件查詢: 查詢某一個實體類或者集合
-
按照 Spring Data 的規範,查詢方法以 find | read | get 開頭,
涉及條件查詢時,條件的屬性用條件關鍵字連接,要注意的是:條件屬性以首字母大寫。
-
例如:定義一個 Entity 實體類
class User{
private String firstName;
private String lastName;
}
使用And條件連接時,應這樣寫:
findByLastNameAndFirstName(String lastName,String firstName);
條件的屬性名稱與個數要與參數的位置與個數一一對應
-
-
支持的關鍵字
-
直接在接口中定義查詢方法,如果是符合規範的,可以不用寫實現,目前支持的關鍵字寫法如下:
-
3. 查詢方法解析流程
-
假如創建如下的查詢:findByUserDepUuid(),框架在解析該方法時,首先剔除 findBy,然後對剩下的屬性進行解析,假設查詢實體爲Doc
-
先判斷 userDepUuid (根據 POJO 規範,首字母變爲小寫)是否爲查詢實體的一個屬性,如果是,則表示根據該屬性進行查詢;如果沒有該屬性,繼續第二步;
-
從右往左截取第一個大寫字母開頭的字符串(此處爲Uuid),然後檢查剩下的字符串是否爲查詢實體的一個屬性,如果是,則表示根據該屬性進行查詢;如果沒有該屬性,則重複第二步,繼續從右往左截取;最後假設 user 爲查詢實體的一個屬性;
-
接着處理剩下部分(DepUuid),先判斷 user 所對應的類型是否有depUuid屬性,如果有,則表示該方法最終是根據 “ Doc.user.depUuid” 的取值進行查詢;否則繼續按照步驟 2 的規則從右往左截取,最終表示根據 “Doc.user.dep.uuid” 的值進行查詢。
-
可能會存在一種特殊情況,比如 Doc包含一個 user 的屬性,也有一個 userDep 屬性,此時會存在混淆。可以明確在屬性之間加上 "_" 以顯式表達意圖,比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"
-
-
特殊的參數: 還可以直接在方法的參數上加入分頁或排序的參數,比如:
-
Page<UserModel> findByName(String name, Pageable pageable);
-
List<UserModel> findByName(String name, Sort sort);
-
4.使用@Query
-
使用@Query自定義查詢
-
這種查詢可以聲明在 Repository 方法中,擺脫像命名查詢那樣的約束,將查詢直接在相應的接口方法中聲明,結構更爲清晰,這是 Spring data 的特有實現。
-
索引參數與命名參數
-
索引參數如下所示,索引值從1開始,查詢中 ”?X” 個數需要與方法定義的參數個數相一致,並且順序也要一致
-
命名參數(推薦使用這種方式):可以定義好參數名,賦值時採用@Param("參數名"),而不用管順序。
-
如果是 @Query 中有 LIKE 關鍵字,後面的參數需要前面或者後面加 %,這樣在傳遞參數值的時候就可以不加 %:
-
@Query("select o from UserModel o where o.name like ?1%")
-
@Query("select o from UserModel o where o.name like %?1")
-
@Query("select o from UserModel o where o.name like %?1%")
-
public List<UserModel> findByUuidOrAge(String name);
-
public List<UserModel> findByUuidOrAge(String name);
-
public List<UserModel> findByUuidOrAge(String name);
-
-
用@Query來指定本地查詢
-
還可以使用@Query來指定本地查詢,只要設置nativeQuery爲true,比如:
-
@Query(value="select * from tbl_user where name like %?1" ,nativeQuery=true)
-
public List<UserModel> findByUuidOrAge(String name);
-
5. @Modifying 註解和事務
-
@Query 與 @Modifying 執行更新操作
-
@Query 與 @Modifying 這兩個 annotation一起聲明,可定義個性化更新操作,例如只涉及某些字段更新時最爲常用,示例如下:
-
-
注意:
-
方法的返回值應該是 int,表示更新語句所影響的行數
-
在調用的地方必須加事務,沒有事務不能正常執行
-
6.事務
-
Spring Data 提供了默認的事務處理方式,即所有的查詢均聲明爲只讀事務。
-
對於自定義的方法,如需改變 Spring Data 提供的事務默認方式,可以在方法上註解 @Transactional 聲明
-
進行多個 Repository 操作時,也應該使它們在同一個事務中處理,按照分層架構的思想,這部分屬於業務邏輯層,因此,需要在 Service 層實現對多個 Repository 的調用,並在相應的方法上聲明事務。
7. CrudRepository 接口
-
CrudRepository
-
T save(T entity);//保存單個實體
-
Iterable<T> save(Iterable<? extends T> entities);//保存集合
-
T findOne(ID id);//根據id查找實體
-
boolean exists(ID id);//根據id判斷實體是否存在
-
Iterable<T> findAll();//查詢所有實體,不用或慎用!
-
long count();//查詢實體數量
-
void delete(ID id);//根據Id刪除實體
-
void delete(T entity);//刪除一個實體
-
void delete(Iterable<? extends T> entities);//刪除一個實體的集合
-
void deleteAll();//刪除所有實體,不用或慎用!
-
8. PagingAndSortingRepository接口
-
該接口提供了分頁與排序功能
-
Iterable<T> findAll(Sort sort); //排序
-
Page<T> findAll(Pageable pageable); //分頁查詢(含排序功能)
-
9.JpaRepository接口
-
該接口提供了JPA的相關功能
-
List<T> findAll(); //查找所有實體
-
List<T> findAll(Sort sort); //排序、查找所有實體
-
List<T> save(Iterable<? extends T> entities);//保存集合
-
void flush();//執行緩存與數據庫同步
-
T saveAndFlush(T entity);//強制執行持久化
-
void deleteInBatch(Iterable<T> entities);//刪除一個實體集合
-
10. JpaSpecificationExecutor接口
-
不屬於Repository體系,實現一組 JPA Criteria 查詢相關的方法
-
Specification:封裝 JPA Criteria 查詢條件。通常使用匿名內部類的方式來創建該接口的對象
-
下載源碼:下載