JPA02
1、 Spring Data JPA的概述
1.1 Spring Data JPA概述
![]()
Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架，可使开发者用极简的代码即可实现对数据库的访问和操作。它提供了包括增删改查等在内的常用功能，且易于扩展！学习并使用 Spring Data JPA 可以极大提高开发效率！
Spring Data JPA 让我们解脱了DAO层的操作，基本上所有CRUD都可以依赖于它来实现,在实际的工作工程中，推荐使用Spring Data JPA + ORM（如：hibernate）完成操作，这样在切换不同的ORM框架时提供了极大的方便，同时也使数据库层操作更加简单，方便解耦
1.2 Spring Data JPA的特性
![]()
SpringData Jpa 极大简化了数据库访问层代码。 如何简化的呢？ 使用了SpringDataJpa，我们的dao层中只需要写接口，就自动具有了增删改查、分页查询等方法。
1.3 Spring Data JPA 与 JPA和hibernate之间的关系
JPA是一套规范，内部是有接口和抽象类组成的。hibernate是一套成熟的ORM框架，而且Hibernate实现了JPA规范，所以也可以称hibernate为JPA的一种实现方式，我们使用JPA的API编程，意味着站在更高的角度上看待问题（面向接口编程）
Spring Data JPA是Spring提供的一套对JPA操作更加高级的封装，是在JPA规范下的专门用来进行数据持久化的解决方案。
2、 Spring Data JPA的快速入门
2.1需求说明
Spring Data JPA完成客户的基本CRUD操作
2.2 搭建Spring Data JPA的开发环境
2.2.1 引入Spring Data JPA的坐标
使用Spring Data JPA，需要整合Spring与Spring Data JPA，并且需要提供JPA的服务提供者hibernate，所以需要导入spring相关坐标，hibernate坐标，数据库驱动坐标等
|
<properties>
<spring.version>5.0.2.RELEASE</spring.version>
<hibernate.version>5.0.7.Final</hibernate.version>
<slf4j.version>1.6.6</slf4j.version>
<log4j.version>1.2.12</log4j.version>
<c3p0.version>0.9.1.2</c3p0.version>
<mysql.version>5.1.18</mysql.version>
</properties>
<dependencies>
<!-- junit单元测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!-- spring beg -->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.6.8</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- spring end -->
<!-- hibernate beg -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
<version>${hibernate.version}</version>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-entitymanager</artifactId>
<version>${hibernate.version}</version>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.1.Final</version>
</dependency>
<!-- hibernate end -->
<!-- c3p0 beg -->
<dependency>
<groupId>c3p0</groupId>
<artifactId>c3p0</artifactId>
<version>${c3p0.version}</version>
</dependency>
<!-- c3p0 end -->
<!-- log end -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
<!-- log end -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<!-- SpringDataJpa核心包 -->
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa</artifactId>
<version>1.9.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- el beg 使用spring data jpa 必须引入 -->
<dependency>
<groupId>javax.el</groupId>
<artifactId>javax.el-api</artifactId>
<version>2.2.4</version>
</dependency>
<dependency>
<groupId>org.glassfish.web</groupId>
<artifactId>javax.el</artifactId>
<version>2.2.4</version>
</dependency>
<!-- el end -->
</dependencies>
|
2.2.2 整合Spring Data JPA与Spring
|
<?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:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:jpa="http://www.springframework.org/schema/data/jpa" xmlns:task="http://www.springframework.org/schema/task"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd
http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
<!-- SpringDataJpa配置 -->
<!-- 1、EntityManagerFactory 交给spring管理-->
<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
<!-- 引用数据源 -->
<property name="dataSource" ref="dataSource"></property>
<!-- 扫描实体类所在的包-->
<property name="packagesToScan" value="com.itheima.domain"></property>
<!-- 指定JPA的提供商-->
<property name="persistenceProvider">
<bean class="org.hibernate.jpa.HibernatePersistenceProvider"></bean>
</property>
<!--jpa提供商的适配器-->
<property name="jpaVendorAdapter">
<bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
<property name="generateDdl" value="false" />
<property name="database" value="MYSQL" />
<property name="databasePlatform" value="org.hibernate.dialect.MySQLDialect" />
<property name="showSql" value="true" />
</bean>
</property>
<!-- JPA方言:可以使用jpa的高级特性 -->
<property name="jpaDialect">
<bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect"></bean>
</property>
</bean>
<!-- 2、配置数据源 -->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="com.mysql.jdbc.Driver"></property>
<property name="jdbcUrl" value="jdbc:mysql://dbnode01:3306/jpa?useUnicode=true&characterEncoding=UTF-8"></property>
<property name="user" value="root"></property>
<property name="password" value="passw0rd"></property>
</bean>
<!-- 3、平台事务管理器 -->
<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
<property name="entityManagerFactory" ref="entityManagerFactory"></property>
</bean>
<!-- 没有事务通知和切面：因为今天只有Dao层代码
<tx:advice id="txAdvice" transaction-manager="transactionManager">
<tx:attributes>
<tx:method name="save*" propagation="REQUIRED"/>
<tx:method name="insert*" propagation="REQUIRED"/>
<tx:method name="update*" propagation="REQUIRED"/>
<tx:method name="delete*" propagation="REQUIRED"/>
<tx:method name="get*" read-only="true"/>
<tx:method name="find*" read-only="true"/>
<tx:method name="*" propagation="REQUIRED"/>
</tx:attributes>
</tx:advice>
<aop:config>
<aop:pointcut id="pointcut" expression="execution(* com.itheima.service.*.*(..))" />
<aop:advisor advice-ref="txAdvice" pointcut-ref="pointcut" />
</aop:config>
-->
<!-- 4、SpringDataJpa的配置
base-package: 基础包，基包 DAO接口所在的包
entity-manager-factory-ref: 实体类管理器工厂的引用
transaction-manager-ref: 平台事务管理器的引用
-->
<jpa:repositories base-package="com.itheima.dao"
entity-manager-factory-ref="entityManagerFactory"
transaction-manager-ref="transactionManager"></jpa:repositories>
<!-- 5、开启组件的扫描-->
<context:component-scan base-package="com.itheima"></context:component-scan>
</beans>
|
2.2.3 使用JPA注解配置映射关系
我们使用昨天案例中的Customer实体类对象，已经配置好了映射关系
|
package com.ranhu.domain;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
/**
*
* 所有的注解都是使用JPA的规范提供的注解，
* 所以在导入注解包的时候，一定要导入javax.persistence下的
*/
@Entity //声明实体类
@Table(name="cst_customer") //建立实体类和表的映射关系
public class Customer {
@Id//声明当前私有属性为主键
@GeneratedValue(strategy=GenerationType.IDENTITY) //配置主键的生成策略
@Column(name="cust_id") //指定和表中cust_id字段的映射关系
private Long custId;
@Column(name="cust_name") //指定和表中cust_name字段的映射关系
private String custName;
@Column(name="cust_source")//指定和表中cust_source字段的映射关系
private String custSource;
@Column(name="cust_industry")//指定和表中cust_industry字段的映射关系
private String custIndustry;
@Column(name="cust_level")//指定和表中cust_level字段的映射关系
private String custLevel;
@Column(name="cust_address")//指定和表中cust_address字段的映射关系
private String custAddress;
@Column(name="cust_phone")//指定和表中cust_phone字段的映射关系
private String custPhone;
public Long getCustId() {
return custId;
}
public void setCustId(Long custId) {
this.custId = custId;
}
public String getCustName() {
return custName;
}
public void setCustName(String custName) {
this.custName = custName;
}
public String getCustSource() {
return custSource;
}
public void setCustSource(String custSource) {
this.custSource = custSource;
}
public String getCustIndustry() {
return custIndustry;
}
public void setCustIndustry(String custIndustry) {
this.custIndustry = custIndustry;
}
public String getCustLevel() {
return custLevel;
}
public void setCustLevel(String custLevel) {
this.custLevel = custLevel;
}
public String getCustAddress() {
return custAddress;
}
public void setCustAddress(String custAddress) {
this.custAddress = custAddress;
}
public String getCustPhone() {
return custPhone;
}
public void setCustPhone(String custPhone) {
this.custPhone = custPhone;
}
}
|
2.2 使用Spring Data JPA完成需求
2.3.1 编写符合Spring Data JPA规范的Dao层接口
Spring Data JPA是spring提供的一款对于数据访问层（Dao层）的框架，使用Spring Data JPA，只需要按照框架的规范提供dao接口，不需要实现类就可以完成数据库的增删改查、分页查询等方法的定义，极大的简化了我们的开发过程。
在Spring Data JPA中，对于定义符合规范的Dao层接口，我们只需要遵循以下几点就可以了：
1.创建一个Dao层接口，并实现JpaRepository和JpaSpecificationExecutor
2.提供相应的泛型
|
package com.ranhu.dao;
import com.itheima.domain.Customer;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
/**
* 编写符合SpringDataJpa规范的dao接口：
* 1）接口所在的包已经在核心配置文件中指定
* 2）我们编写的接口要继承两个接口：
* * JpaRepository<要操作的实体类,主键类型>
* * JpaSpecificationExecutor<要操作的实体类>
*/
public interface CustomerDao extends JpaRepository<Customer,Long>,JpaSpecificationExecutor<Customer>{
}
|
这样我们就定义好了一个符合Spring Data JPA规范的Dao层接口
2.3.2 完成基本CRUD操作
完成了Spring Data JPA的环境搭建，并且编写了符合Spring Data JPA 规范的Dao层接口之后，就可以使用定义好的Dao层接口进行客户的基本CRUD操作
|
@RunWith(SpringJUnit4ClassRunner.class)//替换运行器
@ContextConfiguration("classpath:/applicationContext.xml")//指定配置文件
public class Test01_SpringDataJpa_CRUD {
@Autowired
private CustomerDao customerDao;
/**
* 查询一个对象
*/
@Test
public void test1(){
Customer customer = customerDao.findOne(1L);
System.out.println(customer);
}
/**
* 保存
*/
@Test
public void test2(){
Customer c = new Customer();
c.setCustName("贝吉塔冲击钻公司");
customerDao.save(c);
}
/**
* 更新
* save方法：有保存和更新的功能
* 1）如果有id就更新
* 2）如果没有就保存
*/
@Test
public void test3(){
//new的方式，不推荐
/*Customer c = new Customer();
c.setCustId(7L);
c.setCustName("特兰克斯游戏公司");*/
//第二种
Customer c = customerDao.findOne(7L);
c.setCustName("布玛计算机公司");
customerDao.save(c);
}
/**
* 删除
*/
@Test
public void test4(){
customerDao.delete(7L);
}
/**
* 查询所有
*/
@Test
public void test5(){
List<Customer> customers = customerDao.findAll();
for (Customer customer : customers) {
System.out.println(customer);
}
}
}
|
2、 Spring Data JPA的内部原理剖析
3.1 Spring Data JPA的常用接口分析
在客户的案例中，我们发现在自定义的CustomerDao中，并没有提供任何方法就可以使用其中的很多方法，那么这些方法究竟是怎么来的呢？答案很简单，对于我们自定义的Dao接口，由于继承了JpaRepository和JpaSpecificationExecutor，所以我们可以使用这两个接口的所有方法。
![]()
在使用Spring Data JPA时，一般实现JpaRepository和JpaSpecificationExecutor接口，这样就可以使用这些接口中定义的方法，但是这些方法都只是一些声明，没有具体的实现方式，那么在 Spring Data JPA中它又是怎么实现的呢？
3.2 Spring Data JPA的实现过程
通过对客户案例，以debug断点调试的方式，通过分析Spring Data JPA的原来来分析程序的执行过程
我们以findOne方法为例进行分析
代理子类的实现过程
![]()
断点执行到方法上时，我们可以发现注入的customerDao对象，本质上是通过JdkDynamicAopProxy生成的一个代理对象
l 代理对象中方法调用的分析
当程序执行的时候，会通过JdkDynamicAopProxy的invoke方法，对customerDao对象生成动态代理对象。根据对Spring Data JPA介绍而知，要想进行findOne查询方法，最终还是会出现JPA规范的API完成操作，那么这些底层代码存在于何处呢？答案很简单，都隐藏在通过JdkDynamicAopProxy生成的动态代理对象当中，而这个动态代理对象就是SimpleJpaRepository
![]()
通过SimpleJpaRepository的源码分析，定位到了findOne方法，在此方法中，返回em.find()的返回结果，那么em又是什么呢？
![]()
带着问题继续查找em对象，我们发现em就是EntityManager对象，而他是JPA原生的实现方式，所以我们得到结论Spring Data JPA只是对标准JPA操作进行了进一步封装，简化了Dao层代码的开发
3.3 Spring Data JPA完整的调用过程分析
![]()
2、 Spring Data JPA的查询方式
4.1 使用Spring Data JPA中接口定义的方法进行查询
在继承JpaRepository，和JpaRepository接口后,我们就可以使用接口中定义的方法进行查询
l 继承JpaRepository后的方法列表
![]()
l 继承JpaSpecificationExecutor的方法列表![]()
测试代码：
|
@RunWith(SpringJUnit4ClassRunner.class)//替换运行器
@ContextConfiguration("classpath:/applicationContext.xml")//指定配置文件
public class Test02_Interface_Methods_Query {
@Autowired
private CustomerDao customerDao;
/**
* 查询一个对象
* findOne() : em.find(Class,Id) 立即加载
* getOne() : em.getReference(Class,Id) 延迟加载，用到的时候再去查询数据库
*/
@Test
@Transactional
public void test1(){
Customer customer = customerDao.getOne(1L);
System.out.println(customer);
}
/**
* 排序 和分页
*/
@Test
@Transactional
public void test2(){
/**
* 排序对象：
* 第一个参数：排序规则
* 第二个参数：排序的属性名称
*/
Sort sort = new Sort(Sort.Direction.DESC,"custId");
/**
* 分页对象：
* 第一个参数：当前页： 从0开始；0：第一页； 1：第二页 ......
* 第二个参数：页大小
* 第三个参数：排序对象【可选】
*/
Pageable p = new PageRequest(1,2,sort);
//查询
Page<Customer> page = customerDao.findAll(p);
System.out.println("总记录数："+page.getTotalElements());
System.out.println("总页数："+page.getTotalPages());
System.out.println("当前页数据：=========");
for (Customer customer : page.getContent()) {
System.out.println(customer);
}
}
/**
* 统计所有
*/
@Test
public void test3(){
long count = customerDao.count();
System.out.println(count);
}
/**
* 判断一个对象是否存在
* 1）select * from 表 where id = ?
* 2）select count(*) from 表 where id = ?
*
* Springdatajpa中使用的是那种？
* 第二种
*/
@Test
public void test4(){
boolean exists = customerDao.exists(1L);
System.out.println(exists);
}
}
|
4.2 使用JPQL的方式查询
使用Spring Data JPA提供的查询方法已经可以解决大部分的应用场景，但是对于某些业务来说，我们还需要灵活的构造查询条件，这时就可以使用@Query注解，结合JPQL的语句方式完成查询
@Query 注解的使用非常简单，只需在方法上面标注该注解，同时提供一个JPQL查询语句即可
|
public interface CustomerDao extends JpaRepository<Customer,Long>,JpaSpecificationExecutor<Customer>{
//JPQL: 查询所有
@Query(value="from Customer")
public List<Customer> findJPQL();
//JPQL: 精确查询
@Query(value="from Customer where custId = ?")
public Customer findJPQL2(Long id);
//JPQL: 模糊查询
@Query(value="from Customer where custName like ?")
public List<Customer> findJPQL3(String id);
/**
* JPQL: 多条件查询:
* 1）默认情况下：参数的索引等于占位符索引
* 2）我们可以JPQL中指定参数的索引：在问号后加入 索引
*/
@Query(value="from Customer where custId = ?2 or custName like ?1")
public List<Customer> findJPQL4(String name,Long id);
}
|
此外，也可以通过使用 @Query 来执行一个更新操作，为此，我们需要在使用 @Query 的同时，用 @Modifying 来将该操作标识为修改查询，这样框架最终会生成一个更新的操作，而非查询
|
/**
* 1）编写方法
* 2）使用@Query注解，value属性编写的JPQL的update的语句
* 3）加入一个注解： @Modifying ,标记是更新操作
*/
@Query(value = "update Customer set custName = ?2 where custId = ?1")
@Modifying
public void updateJPQL(Long id,String name);
|
测试方法中要加入两个注解
4.3 使用SQL语句查询
Spring Data JPA同样也支持sql语句的查询，如下：
|
/**
* SQL查询：
* 1）编写方法
* 2）使用@Query注解,value属性中编写的是sql语句，还需要使用另外属性：nativeQuery = true
*/
@Query(value="select * from cst_customer where cust_name like ?1 or cust_id = ?2",nativeQuery = true)
public List<Customer> findSQL(String name,Long id);
|
4.4 方法命名规则查询
顾名思义，方法命名规则查询就是根据方法的名字，就能创建查询。只需要按照Spring Data JPA提供的方法命名规则定义方法的名称，就可以完成查询工作。Spring Data JPA在程序执行的时候会根据方法名称进行解析，并自动生成查询语句进行查询
按照Spring Data JPA 定义的规则，查询方法以findBy开头，涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性首字母需大写。框架在进行方法名解析时，会先把方法名多余的前缀截取掉，然后对剩下部分进行解析。
|
//精确查询
public Customer findByCustName(String name);
//模糊查询
public List<Customer> findByCustNameLike(String name);
//多条件
public List<Customer> findByCustNameLikeOrCustLevel(String name ,String level);
|
具体的关键字，使用方法和生产成SQL如下表所示
|
Keyword
|
Sample
|
JPQL
|
|
And
|
findByLastnameAndFirstname
|
… where x.lastname = ?1 and x.firstname = ?2
|
|
Or
|
findByLastnameOrFirstname
|
… where x.lastname = ?1 or x.firstname = ?2
|
|
Is,Equals
|
findByFirstnameIs,
findByFirstnameEquals
|
… where x.firstname = ?1
|
|
Between
|
findByStartDateBetween
|
… where x.startDate between ?1 and ?2
|
|
LessThan
|
findByAgeLessThan
|
… where x.age < ?1
|
|
LessThanEqual
|
findByAgeLessThanEqual
|
… where x.age ⇐ ?1
|
|
GreaterThan
|
findByAgeGreaterThan
|
… where x.age > ?1
|
|
GreaterThanEqual
|
findByAgeGreaterThanEqual
|
… where x.age >= ?1
|
|
After
|
findByStartDateAfter
|
… where x.startDate > ?1
|
|
Before
|
findByStartDateBefore
|
… where x.startDate < ?1
|
|
IsNull
|
findByAgeIsNull
|
… where x.age is null
|
|
IsNotNull,NotNull
|
findByAge(Is)NotNull
|
… where x.age not null
|
|
Like
|
findByFirstnameLike
|
… where x.firstname like ?1
|
|
NotLike
|
findByFirstnameNotLike
|
… where x.firstname not like ?1
|
|
StartingWith
|
findByFirstnameStartingWith
|
… where x.firstname like ?1 (parameter bound with appended %)
|
|
EndingWith
|
findByFirstnameEndingWith
|
… where x.firstname like ?1 (parameter bound with prepended %)
|
|
Containing
|
findByFirstnameContaining
|
… where x.firstname like ?1 (parameter bound wrapped in %)
|
|
OrderBy
|
findByAgeOrderByLastnameDesc
|
… where x.age = ?1 order by x.lastname desc
|
|
Not
|
findByLastnameNot
|
… where x.lastname <> ?1
|
|
In
|
findByAgeIn(Collection ages)
|
… where x.age in ?1
|
|
NotIn
|
findByAgeNotIn(Collection age)
|
… where x.age not in ?1
|
|
TRUE
|
findByActiveTrue()
|
… where x.active = true
|
|
FALSE
|
findByActiveFalse()
|
… where x.active = false
|
|
IgnoreCase
|
findByFirstnameIgnoreCase
|
… where UPPER(x.firstame) = UPPER(?1)
|
浙公网安备 33010602011771号