Spring Data JPA的概述
Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架,可以极大的简化JPA的写法,是在JPA规范下的专门用来进行数据持久化的解决方案。使用它开发者只需要简单的代码就可以实现对数据库的访问和操作。
SpringData Jpa 极大简化了数据库访问层代码,让我们解脱了DAO层的操作。它提供了包括增删改查等在内的常用功能,我们只需要实现DAO接口,就自动具有了增删改查、分页查询等方法。
Spring Data JPA的快速入门
通过Spring Data JPA完成客户的基本CRUD操作
项目结构:
1.创建Maven项目,导入相关pom.xml依赖
使用Spring Data JPA,需要整合Spring与Spring Data JPA,并且需要提供JPA的服务提供者hibernate,所以需要导入spring相关坐标,hibernate坐标,数据库驱动坐标等
<properties>
<spring.version>4.2.4.RELEASE</spring.version>
<hibernate.version>5.0.7.Final</hibernate.version>
<c3p0.version>0.9.1.2</c3p0.version>
<mysql.version>8.0.11</mysql.version>
</properties>
<dependencies>
<!-- junit单元测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.9</version>
<scope>test</scope>
</dependency>
<!-- spring -->
<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>
<!-- hibernate -->
<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>
<!-- c3p0-->
<dependency>
<groupId>c3p0</groupId>
<artifactId>c3p0</artifactId>
<version>${c3p0.version}</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<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>4.2.4.RELEASE</version>
</dependency>
<!-- el 使用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>
</dependencies>
2.搭建Spring Data JPA的开发环境
新建applicationContext.xml文件,整合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">
<!-- 1.dataSource 配置数据库连接池-->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="com.mysql.cj.jdbc.Driver" />
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/jpa?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8" />
<property name="user" value="root" />
<property name="password" value="520992" />
</bean>
<!-- 2.配置entityManagerFactory -->
<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
<!--注入数据库连接池-->
<property name="dataSource" ref="dataSource" />
<!--配置扫描的包(实体类所在的包)-->
<property name="packagesToScan" value="com.ly.domain" />
<!--jpa的实现厂家-->
<property name="persistenceProvider">
<bean class="org.hibernate.jpa.HibernatePersistenceProvider" />
</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" />
<!--是否显示sql-->
<property name="showSql" value="true" />
</bean>
</property>
<!--jpa方言:高级的特性-->
<property name="jpaDialect">
<bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect" />
</property>
<!--注入jpa的配置信息
加载jpa的基本配置信息和jpa实现方式(hibernate)的配置信息
hibernate.hbm2ddl.auto:自动创建数据库表
create:每次都会重新创建数据库表
update:有表不会重新创建,没有表会重新创建-->
<property name="jpaProperties">
<props>
<prop key="hibernate.hbm2ddl.auto">create</prop>
</props>
</property>
</bean>
<!-- 3.事务管理器-->
<!-- JPA事务管理器 -->
<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
<property name="entityManagerFactory" ref="entityManagerFactory" />
</bean>
<!-- 整合spring data jpa-->
<jpa:repositories base-package="com.ly.dao"
transaction-manager-ref="transactionManager"
entity-manager-factory-ref="entityManagerFactory"></jpa:repositories>
<!-- 4.txAdvice-->
<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>
<!-- 5.aop-->
<aop:config>
<aop:pointcut id="pointcut" expression="execution(* com.ly.service.*.*(..))" />
<aop:advisor advice-ref="txAdvice" pointcut-ref="pointcut" />
</aop:config>
<!--配置包扫描-->
<context:component-scan base-package="com.ly"></context:component-scan>
<!--组装其它 配置文件-->
</beans>
3. 创建Customer实体类对象,使用JPA注解配置映射关系
实体类与表的映射关系:
- @Entity:声明实体类
- @Table:建立实体类和表的映射关系
类中属性与表中字段的映射关系:
- @Id:声明当前私有属性为主键
- @GeneratedValue:配置主键的生成策略
- @Column:配置与表中字段的映射关系
/**
* 所有的注解都是使用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;
/**
* GET、SET、toString
*/
}
3. 编写符合Spring Data JPA规范的Dao层接口
Spring Data JPA是spring提供的一款对于数据访问层(Dao层)的框架,使用Spring Data JPA,只需要按照框架的规范提供dao接口,不需要实现类就可以完成数据库的增删改查、分页查询等方法的定义,极大的简化了我们的开发过程。
定义符合规范的Dao层接口:
- 1. 创建一个Dao层接口,不需要实现类
- 2. 继承JpaRepository和JpaSpecificationExecutor,提供相应的泛型
JpaRepository<操作实体的类型,实体类中主键属性的类型>
JpaSpecificationExecutor<操作实体的类型>
/**
* @Author: Ly
* @Date: 2020-11-28 16:17
*/
public interface CustomerDao extends JpaRepository<Customer,Long>, JpaSpecificationExecutor<Customer> {
}
4.测试代码:
完成了Spring Data JPA的环境搭建,并且编写了符合Spring Data JPA 规范的Dao层接口之后,就可以使用定义好的Dao层接口进行客户的基本CRUD操作。
4.1 定义测试类CustomerDaoTest,并配置spring单元测试的支持
/**
* @Author: Ly
* @Date: 2020-11-28 16:23
*/
@RunWith(SpringJUnit4ClassRunner.class) //声明spring提供的单元测试
@ContextConfiguration(locations = "classpath:applicationContext.xml")//指定spring容器的配置信息
public class CustomerDaoTest {
@Autowired
private CustomerDao customerDao;
}
4.2 测试根据id查询
根据id从数据库查询:
- findOne:立即加载
- getOne:延迟加载,返回的是一个客户端的动态代理对象, 什么时候用什么时候查询
/**
* findOne:根据id查询
*/
@Test
public void testFindOne(){
Customer customer=customerDao.findOne(1l);
System.out.println(customer);
}
/**
* getOne: 根据id查询
* @Transactional: 保证getOne正常运行
*/
@Test
@Transactional
public void testGetOne(){
Customer customer =customerDao.getOne(1l);
System.out.println(customer);
}
4.3 测试添加与更新数据
save用来保存或者更新,当传递的对象不存在主键id时是保存用户,存在主键id时执行更新操作。
/**
* save:测试更新数据
*/
@Test
public void testSave(){
Customer customer=new Customer();
customer.setCustLevel("vip");
customer.setCustIndustry("IT教育");
customerDao.save(customer);
}
4.4 测试根据id删除用户
/**
* delete:根据id删除
*/
@Test
public void testDelete(){
customerDao.delete(3l);
}
4.5 测试查询所有
/**
* 查询所有
*/
@Test
public void testFindAll(){
List<Customer> list= customerDao.findAll();
for (Customer customer:list) {
System.out.println(customer);
}
}
4.6 测试查询客户的总数量
/**
* count:统计总条数
*/
@Test
public void testCount(){
long count=customerDao.count();//查询所有客户数量
System.out.println(count);
}
4.7 测试判断用户是否存在
/**
* exists:判断用户是否存在
*/
@Test
public void testExists(){
boolean exists =customerDao.exists(1l);
System.out.println("id为1的客户 是否存在:"+exists);
}
Spring Data JPA的内部原理剖析
Spring Data JPA的实现过程
在自定义的CustomerDao中,我们发现并没有提供任何方法。但是我们却实现了增删改查等方法,这些方法来自于我们自定义的Dao接口所继承的JpaRepository和JpaSpecificationExecutor,我们可以使用这两个接口的所有方法。
1. 代理子类的实现
注入customerDao,通过JdkDynamicAopProxy生成的一个动态代理对象
2.调用方法
当程序执行的时候,会通过JdkDynamicAopProxy的invoke方法,对customerDao对象生成动态代理对象。在执行方法时,底层代码都隐藏在通过JdkDynamicAopProxy生成的动态代理对象当中,而这个动态代理对象就是SimpleJpaRepository。
在SimpleJpaRepository类中我们可以看到各种方法的的源码,在findOne方法中,我们可以看到返回了em.find()的返回结果。而em就是EntityManager对象,它是JPA原生的实现方式。
结论:Spring Data JPA只是对标准JPA操作进行了进一步封装,简化了Dao层代码的开发