1 Spring Data JPA概述
Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架,可使开发者用极简的代码即可实现对数据库的访问和操作。它提供了包括增删改查等在内的常用功能,且易于扩展。
2 JPA、Spring Data JPA、Hibernate之间的关系
JPA是一套规范,内部是有接口和抽象类组成的。Hibernate是一套成熟的ORM框架,而且Hibernate实现了JPA规范,所以也可以称hibernate为JPA的一种实现方式,我们使用JPA的API编程,意味着站在更高的角度上看待问题(面向接口编程);Spring Data JPA是Spring提供的一套对JPA操作更加高级的封装,是在JPA规范下的专门用来进行数据持久化的解决方案。
JPA是一套规范,Hibernate是一套成熟的ORM框架,实现了JPA规范
Spring Data JPA是spring 提供的对JPA操作的更加高级的封装,实际工作的仍然是实现JPA规范的ORM框架
实际开发中,推荐使用Spring Data JPA + ORM(如:hibernate)完成操作,这样在切换不同的ORM框架时提供了极大的方便,同时也使数据库层操作更加简单,方便解耦。
3 Spring Data JPA入门案例
3.1 搭建开发环境
3.1.1 添加Spring Data JPA依赖
pom.xml增加相关依赖jar包坐标
<properties>
<spring.version>5.2.1.RELEASE</spring.version>
<hibernate.version>5.4.10.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.6</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>
<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>
3.1.2 整合Spring Data JPA和Spring
类路径下,创建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.jdbc.Driver"/>
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/db1"/>
<property name="user" value="root"/>
<property name="password" value="root"/>
</bean>
<!-- 2.配置entityManagerFactory,创建entityManagerFactory对象交给spring容器管理 -->
<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
<property name="dataSource" ref="dataSource"/>
<!-- 配置的扫描的包(实体类所在的包)-->
<property name="packagesToScan" value="q.perter.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>
</bean>
<!-- 3.事务管理器-->
<!-- JPA事务管理器 -->
<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
<property name="entityManagerFactory" ref="entityManagerFactory"/>
</bean>
<!-- 整合spring data jpa-->
<!-- base-package="q.perter.dao" 对此包下的dao接口进行动态代理增强-->
<jpa:repositories base-package="q.perter.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(* q.perter.service.*.*(..))"/>
<aop:advisor advice-ref="txAdvice" pointcut-ref="pointcut"/>
</aop:config>
<!-- 6. 配置包扫描-->
<context:component-scan base-package="q.perter"></context:component-scan>
<!--组装其它 配置文件-->
</beans>
3.1.3 使用JPA注解配置映射关系
在实体类对象中,使用@Entity和@Table注解配置映射关系
3.2 使用Spring Data JPA
3.2.1 编写符合Spring Data JPA规范的dao接口
在Spring Data JPA中,对于定义符合规范的Dao层接口,需要遵循以下几点:
- 创建一个Dao层接口,并实现JpaRepository和JpaSpecificationExecutor
- 提供相应的泛型
JpaRepository<实体类类型,主键类型>:用来完成基本CRUD操作
JpaSpecificationExecutor<实体类类型>:用于复杂查询(分页等查询操作)
3.2.1 实现CRUD操作
通过编写测试类,实现CRUD
- findOne:根据ID查询(立即加载)
- save:保存或者更新,如果传递的对象存在主键ID,则进行更新;如果没有主键ID则进行保存
- delete:删除
- findAll:查询所有
- count:统计总条数
- exists:判断用户是否存在
- getOne:根据ID查询(通过em.getReference实现延迟加载)
4 Spring Data JPA的原理
对于我们自定义的Dao接口,由于继承了JpaRepository和JpaSpecificationExecutor,所以即使我们在接口中一个方法都没写也可以使用这两个接口的所有方法
4.1 Spring Data JPA实现过程
- 通过对测试类中方法的断点调试,可以发现注入的userDao对象,本质上是通过JdkDynamicAopProxy生成的一个代理对象
- 当程序执行时,会通过JdkDynamicAopProxy的invoke方法,对userDao对象生成动态代理对象SimpleJpaRepository
-
通过SimpleJpaRepository的源码,它实现了JpaRepository和JpaSpecificationExecutor接口,找到对应的findOne方法,返回em.find();也就是通过EntityManager对象进行查找
5 Spring Data JPA的查询方式
5.1 使用Spring Data JPA中接口定义的方法查询
通过JpaRepository继承的方法列表:通过JpaSpecificationExecutor继承方法列表:
5.2 使用JPQL的方式查询
使用@Query注解,结合jpql语句方式实现查询
如需进行更新,可以使用@Modifying注解
如:
@Query(value="from User where id = ?1")
public User findJpql(Integer id);
@Query("from User where id = ?1 and username = ?2")
public User findIdAndName(Integer id, String username);
@Query("update User set username = ?2 where id = ?1")
@Modifying
public void updateUser(Integer id, String username);
注意:
- jpql语句存在参数时,需要给参数指定方法中参数的索引,从1开始
- 更新方法在使用时,需要增加事务支持,即@Transactional,否则提示no Session异常;同时增加@Rollback(false)注解支持,取消默认回滚
5.3 使用SQL语句查询
使用SQL语句查询同样是使用@Query注解,属性nativeQuery设置为true,即使用sql语句进行查询
如:
@Query(value = "select * from User where username = ?", nativeQuery = true)
public List<Object[]> findSql(String username);
5.4 使用方法命名规则查询
方法名的约定:
- findBy:查询
- 对象中的属性名(首字母大写): 查询的条件
查询方式:Like、IsNull等,默认使用等于的方式查询
多条件查询:findBy + 属性名 + “查询方式” + “多条件的连接符(And|Or)” + 属性名 + “查询方式”
如:
public User findById(Integer id);
public List<User> findByUsername(String username);
public List<User> findByUsernameLikeAndSex(String username, String sex);