Spring Data Jpa 详解 （配置篇）
前言：
JPA全称Java Persistence API，即Java持久化API，它为Java开发人员提供了一种对象/关系映射工具来管理Java应用中的关系数据，结合其他ORM的使用，能达到简化开发流程的目的，使开发者能够专注于实现自己的业务逻辑上。
Spring Jpa 能够简化创建 JPA 数据访问层和跨存储的持久层功能，用户的持久层Dao接口只需要继承他自己定义好的（仓库）接口，无需再写实现类，就可以实现对象的CRUD操作，还有分页排序等功能。
写本章之前本来想写一个SpringMVC的，后来发现Jpa的配置可以大大简化MVC框架的配置，就先研究研究Spring Data Jpa。
准备工作：
- jar包支持（不用说都知道，本章jar包待我会放在115网盘供下载）
- web.xml配置（监听Spring容器的装载）
- 本章采用的是阿里连接池（Druid），所以web.xml要有相关的配置
- Spring容器的配置（主要为beans和jpa）
- Jpa的主要配置（实体类管理、数据源、连接池、事务等）
- 实体类、持久层接口、业务层的创建
- 测试放在下一章节中（因为采用了SpringJunit单元测试，点击前往）
先来看一下本章节用到的包结构--如下图：
实例代码演示：
****************最后我会把本章的项目打包供下载************注释部分我尽可能详细讲解****************
jar包导入.....（略）
web.xml配置
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0"> <display-name>springMVC</display-name> <!-- 同时加载多个spring配置文件可用 --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> classpath:spring-config/*.xml </param-value> </context-param> <!-- spring全局监听 --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <!-- 下面为Druid默认配置，过滤掉多余的url地址 --> <filter> <filter-name>DruidWebStatFilter</filter-name> <filter-class>com.alibaba.druid.support.http.WebStatFilter</filter-class> <init-param> <param-name>exclusions</param-name> <param-value>*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*</param-value> </init-param> <init-param> <param-name>principalSessionName</param-name> <param-value>_dest_login_</param-value> </init-param> </filter> <filter-mapping> <filter-name>DruidWebStatFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <!-- StatViewServlet是一个标准的Servlet --> <servlet> <servlet-name>DruidStatView</servlet-name> <servlet-class>com.alibaba.druid.support.http.StatViewServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>DruidStatView</servlet-name> <url-pattern>/druid/*</url-pattern> </servlet-mapping> <!-- Spring Servlet,由于把bean全部交给了SpringJap，所以Spring-mvc里面现在为空 --> <servlet> <servlet-name>springServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/spring-mvc.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>springServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> <!-- 首页 --> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> </web-app>
spring-mvc.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:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd"> <!-- bean配置在spring-jpa.xml里,所以这里暂为空，用来初始化spring容器--> </beans>
spring-jpa.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:tx="http://www.springframework.org/schema/tx" xmlns:context="http://www.springframework.org/schema/context" xmlns:jpa="http://www.springframework.org/schema/data/jpa" xmlns:task="http://www.springframework.org/schema/task" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.1.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.1.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa.xsd" default-lazy-init="true"> <description>SpringJpa配置</description> <!-- 如果spring用了jpa，并且类型为LocalContainerEntityManagerFactoryBean，则组件注册在此配置文件出现即可，其余配置文件可忽略 使用component来替代annotation 自动注册bean, 并保证@Required、@Autowired的属性被注入\ --> <context:component-scan base-package="com.spring.jpa"/> <!-- spring启动时扫描项目路径下的properties文件,后续用${key }方式取出对应值,这样可以代码解耦和，后续只需修改properties文件即可 --> <bean id="propertyPlaceholderConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"> <property name="locations"> <list> <!-- dataSourse连接池相关属性，代码不在此贴出，会放在打包好的项目里面 --> <value>classpath:db.properties</value> </list> </property> </bean> <!-- 定义实体管理器工厂 Jpa配置 LocalContainerEntityManagerFactoryBean这个选项Spring扮演了容器的角色。完全掌管JPA --> 点我查看 spring生成EntityManagerFactory的三种方式 <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean"> <!-- 指定数据源 --> <property name="dataSource" ref="dataSource"/> <!-- 指定Jpa持久化实现厂商类,这里以Hibernate为例 --> <property name="jpaVendorAdapter" ref="hibernateJpaVendorAdapter"/> <!-- 指定Entity实体类包路径 --> <property name="packagesToScan" > <array> <value>com.spring.jpa</value> </array> </property> <!-- 指定JPA属性；如Hibernate中指定是否显示SQL的是否显示、方言等 --> <property name="jpaProperties"> <props> <prop key="hibernate.dialect">org.hibernate.dialect.Oracle10gDialect</prop> <prop key="hibernate.ejb.naming_strategy">org.hibernate.cfg.ImprovedNamingStrategy</prop> <prop key="hibernate.cache.provider_class">org.hibernate.cache.NoCacheProvider</prop> <prop key="hibernate.show_sql">true</prop> <prop key="hibernate.format_sql">true</prop> <prop key="hibernate.hbm2ddl.auto">validate</prop> </props> </property> </bean> <!-- 重要配置：启用扫描并自动创建代理的功能 --> <jpa:repositories base-package="com.spring.jpa" transaction-manager-ref="transactionManager" entity-manager-factory-ref="entityManagerFactory"/> <!-- Hibernate对Jpa的实现 --> <bean id="hibernateJpaVendorAdapter" class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"/> <!-- Jpa 事务管理器 --> <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager"> <property name="entityManagerFactory" ref="entityManagerFactory"/> </bean> <!-- 开启注解事务 --> <tx:annotation-driven transaction-manager="transactionManager" proxy-target-class="true" /> <!-- 数据源配置,使用应用内的DBCP数据库连接池 --> <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close"> <!--property name="driverClassName" value="${db.driverClass}"/--> <property name="url" value="${db.jdbcUrl}" /> <property name="username" value="${db.user}" /> <property name="password" value="${db.password}" /> <!-- 配置初始化大小、最小、最大 --> <property name="initialSize" value="${db.initialSize}" /> <property name="minIdle" value="${db.minIdle}" /> <property name="maxActive" value="${db.maxActive}" /> <!-- 配置获取连接等待超时的时间 --> <property name="maxWait" value="${db.maxWait}" /> <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 --> <property name="timeBetweenEvictionRunsMillis" value="${db.timeBetweenEvictionRunsMillis}" /> <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 --> <property name="minEvictableIdleTimeMillis" value="${db.minEvictableIdleTimeMillis}" /> <property name="validationQuery" value="SELECT 'x' from dual" /> <property name="testWhileIdle" value="true" /> <property name="testOnBorrow" value="false" /> <property name="testOnReturn" value="false" /> <!-- 打开PSCache，并且指定每个连接上PSCache的大小 --> <property name="poolPreparedStatements" value="${db.poolPreparedStatements}" /> <property name="maxPoolPreparedStatementPerConnectionSize" value="${db.maxPoolPreparedStatementPerConnectionSize}" /> </bean> <!-- 启动对@AspectJ（面向切面）注解的支持 --> <aop:aspectj-autoproxy /> </beans>
配置好了配置文件后，我们该来写对应的实体类，Dao，和service了，下面给出简单的3个类：
User 实体类
package com.spring.jpa.user; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.Id; import javax.persistence.SequenceGenerator; import javax.persistence.Table; /** * User实体类 * @author liuyt * @date 2014-10-30 下午2:27:37 */ @Entity @Table(name="T_SPRINGJPA_USER") public class User { /** * 主键序列：DEFAULT_SUQUENCE 是我在oracle数据库中创建的一个序列 * MY_SUQUENCE 是给自定义的序列创建一个引用名称 * 指我的主键生成策略 MY_SUQUENCE 使用的是 DEFAULT_SUQUENCE 这个序列。 */ @SequenceGenerator(name = "MY_SUQUENCE", sequenceName = "DEFAULT_SUQUENCE") @Id @GeneratedValue(generator="MY_SUQUENCE") private Long id; @Column(name="USER_NAME") private String userName; @Column(name="USER_PASSWORD") private String passWord; /*************GET****************SET***************/ public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getUserName() { return userName; } public void setUserName(String userName) { this.userName = userName; } public String getPassWord() { return passWord; } public void setPassWord(String passWord) { this.passWord = passWord; } @Override public String toString() { return "User [id=" + id + ", userName=" + userName + ", passWord=" + passWord + "]"; } } User Entity
IUserDao 持久层（jpa对持久层简化的核心基础）
package com.spring.jpa.user; import org.springframework.data.repository.PagingAndSortingRepository; import org.springframework.stereotype.Repository; /** * 持久层接口 * @author liuyt * @date 2014-10-30 下午2:09:48 */ @Repository public interface IUserDao extends PagingAndSortingRepository<User, Long>{ /** * 通过前面的配置可以看出，Spring 对 JPA 的支持已经非常强大，开发者无需过多关注 EntityManager 的创建、事务处理等 JPA 相关的处理 * *********************************************************************** * 然而spring对Jpa的支持不止于此，它要从根本上来简化我们的业务代码 ** * 在没用使用jpa支持的时候，我们的代码应该是这样的： ** * 1、IUserDao 持久层接口 ** * 2、IUserDaoImpl 持久层实现类 ** * 3、IUserService 业务层接口.....后面不在列举 ** * 每写一个实体类，都要衍生出5、6个类来对他进行操作，即使有了注解，我们可以依赖注入方式来拿到实现类， ** * 但是通用的CRUD等操作却不免在每个实现类里声明，你又说，我可以定义一个父类，利用泛型反射原理就可以了， ** * 但那样你还需要为每个Dao声明自己的实现类来继承你的父类 ** * *********************************************************************** * 那么问题来了...（不是挖掘机技术）对持久层的简化技术哪家强？ Spring Data Jpa ** * 你唯一要做的就只是声明持久层的接口，来继承他自身已经封装好的持久层接口，正如本类IUserDao一样 ** * 可使用的接口有： ********** * Repository：是 Spring Data的一个核心接口，它不提供任何方法，开发者需要在自己定义的接口中声明需要的方法。** * CrudRepository：继承Repository，提供增删改查方法，可以直接调用。 ** * PagingAndSortingRepository：继承CrudRepository，具有分页查询和排序功能（本类实例） ** * JpaRepository： 继承PagingAndSortingRepository，针对JPA技术提供的接口 ** * JpaSpecificationExecutor： 可以执行原生SQL查询 ** * 继承不同的接口，有两个不同的泛型参数，他们是该持久层操作的类对象和主键类型。 ** ********************************************************************************* */ }
这里为了方便演示，就不写业务层接口了，直接上业务层service代码
UserService 业务层
package com.spring.jpa.user; import java.util.List; import javax.annotation.Resource; import org.springframework.data.domain.Page; import org.springframework.data.domain.PageRequest; import org.springframework.stereotype.Service; /** * User业务层，依赖持久层 IUserDao * @author liuyt * @date 2014-10-30 下午2:37:21 */ @Service public class UserService { // 推荐用Resource来替代AutoWrite注解 @Resource private IUserDao userDao; // 新增用户 public void saveUser(User user) { userDao.save(user); } // 删除用户，参数也可以为一个含有id的User对象 public void deleteUser(Long id) { userDao.delete(id); } // 查询所有user对象，findOne为查询单个 public List<User> findAllUsers() { return (List<User>) userDao.findAll(); } /** * 根据一个分页对象查询user集合（还可以添加一个Store排序属性） * PageRequest 是spring自己封装的请求分页类，实现了Pageable接口，包涵从请求中获得的分页属性（当前页和大小）和获取方法 * 通过调用分页方法，返回一个Page<>一个泛型集合的分页对象，里面包涵了通过查询计算出的各个属性和结果集 * 详细类结构和属性请参阅源码 * @param page * @return */ public Page<User> findAllUserByPage(PageRequest page) { return (Page<User>) userDao.findAll(page); } }
至此，整体SpringJpa框架就搭建好了，剩下的就是写页面和控制器进行测试了，这里不做演示，因为会在下一章节利用SpringJUnit单元测试，通过注解的方式进行方法测试，详情请移步：SpringJUnit4单元测试
项目源码下载：点我下载
总结：
- 在学习期间可能jar包的导入会很头疼，因为各类框架的jar有时候会出现不兼容的情况（点击下载本章节jar包）（目前所用百度云盘）到期请提醒
- 本章节用到的Druid连接池配置，详细配置请异步度娘
- spring-jpa.xml里面可以针对不同需求，可以选择不同的EntityManagerFactory实体类管理
- 别忘记<jpa:repositories />标签的配置，他用来声明Jpa涉及到的包路径
- SpringJpa集成了声明式事务，记得开启注解事务即可
- 持久层的实现接口有很多，根据需求灵活选择（本章演示有关分页的接口，因为网上对该接口的介绍都比较粗略）
- 未涉及：其他功能：如Query查询，Dao接口方法的新增
文章出处：http://www.cnblogs.com/liuyitian/p/4062748.html
