SpringDataJpa

SpringDataJpa概述

Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架，可使开发者用极简的代码即可实现对数据库的访问和操作。
它提供了包括增删改查等在内的常用功能，且易于扩展

Spring Data JPA是Spring提供的一套对JPA操作更加高级的封装，是在JPA规范下的专门用来进行数据持久化的解决方案

SpringDataJpa的入门操作

* 搭建环境
    1. 在pom文件中引入依赖
    <properties>
        <spring.version>4.2.4.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.6</mysql.version>
    </properties>

    <dependencies>
        <!-- junit单元测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.9</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>4.2.4.RELEASE</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. 创建spring核心配置文件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: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.配置数据库连接池-->
        <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
            <property name="driverClass" value="com.mysql.jdbc.Driver"/>
            <property name="jdbcUrl" value="jdbc:mysql:///springdata?characterEncoding=utf-8"/>
            <property name="user" value="root"/>
            <property name="password" value="root"/>
        </bean>
        <!-- 2.配置entityManagerFactory -->
        <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
            <!--配置一个数据库-->
            <property name="dataSource" ref="dataSource"/>
            <!--配置实体类的包扫描-->
            <property name="packagesToScan" value="com.qin.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.配置事务管理器-->
        <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
            <!--配置实体管理器工厂-->
            <property name="entityManagerFactory" ref="entityManagerFactory"/>
        </bean>

        <!--4.整合springdata Jpa-->
        <jpa:repositories base-package="com.qin.dao" transaction-manager-ref="transactionManager"
                          entity-manager-factory-ref="entityManagerFactory"/>

        <!--5.配置对事务控制的注解支持-->
        <tx:annotation-driven transaction-manager="transactionManager"/>

        <!--6.配置spring中的包扫描-->
        <context:component-scan base-package="com.qin"/>
    </beans>
    3. 编修实体类,使用jpa注解配置映射关系

    @Entity
    @Table(name = "cst_customer")
    public class Customer implements Serializable {

        @Id
        @Column(name = "cust_id")
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long custId;
        @Column(name = "cust_name")
        private String custName;
        @Column(name = "cust_source")
        private String custSource;
        @Column(name = "cust_industry")
        private String custIndustry;
        @Column(name = "cust_level")
        private String custLevel;
        @Column(name = "cust_address")
        private String custAddress;
        @Column(name = "cust_phone")
        private String custPhone;

        //getter and setter
        ...

        //toString
        ...
    }
* 编写一个符合springDataJpa的dao层接口
    1. 编写dao层接口,不需要编写dao层的实现类
    2. dao层接口规范
        1. 需要继承两个接口(JpaRepository,JpaSpecificationExecutor)
        2. 需要提供响应的泛型
    public interface ICustomerDao extends JpaRepository<Customer,Long>, JpaSpecificationExecutor<Customer> {
    }

* 方法
    1. findOne(id):根据id查询        
    2. save(实体类对象):保存或者更新(依据:传递的实体类对象中,是否包含id属性)
    3. delete(id):根据id删除
    4. findAll():查询全部

* 测试类(简单的CRUD)
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:applicationContext.xml")
public class SpringdataJpaTest {
    @Autowired
    private ICustomerDao dao;

    /**
     * 测试查询findOne
     * @throws Exception
     */
    @Test
    public void testFindOne() throws Exception{
        Customer customer = dao.findOne(1l);
        System.out.println(customer);
    }

    /**
     * 测试save保存
     */
    @Test
    public void testSave() throws Exception{
        Customer customer = new Customer();
        customer.setCustName("Levi222");
        customer.setCustIndustry("it");
        dao.save(customer);
    }

    /**
     * 测试save更新
     */
    @Test
    public void testSave1() throws Exception{
        Customer customer = dao.findOne(1l);
        customer.setCustName("hello");
        dao.save(customer);
    }

    /**
     * 删除
     */
    @Test
    public void testDelete() throws Exception{
        dao.delete(2l);
    }
}

SpringDataJpa的运行过程以及原理分析

 

1. 通过JdkDynamicAopProxy的invoke方法创建了一个动态代理对象
2. SimpleJpaRepository当中封装了JPA的操作(借助JPA的api完成数据库的CRUD)
3. 通过hibernate完成数据库操作(封装了jdbc)

SpringDataJpa的复杂查询

1. Spring Data JPA中接口定义的其他方法进行查询
    /**
     * 判断客户是否存在exists,这里使用的是查询用户的数量是否大于0
     * 判断id为2的客户是否存在
     *      1. 可以查询以下id为4的客户
     *          如果值为空，代表不存在，如果不为空，代表存在
     *      2. 判断数据库中id为4的客户的数量
     *          如果数量为0，代表不存在，如果大于0，代表存在
     */
    @Test
    public void testExists(){
        boolean exists = dao.exists(2l);
        System.out.println(exists?"存在":"不存在");
    }
    /**
     * getOne()根据id从数据库中查询
     * @Transactional
     *          : 保证getOne正常运行,否则延迟加载默认事务结束,no session错误
     *          : 一般不在test方法上声明事务,在service上加,并使用一次才会不报错
     * findOne：
     *     em.find()           :立即加载
     * getOne：
     *     em.getReference     :延迟加载
     *     * 返回的是一个客户的动态代理对象
     *     * 什么时候用，什么时候查询
     */
    @Test
    @Transactional
    public void testGetOne(){
        Customer customer = dao.getOne(1l);
        System.out.println(customer);
    }

2. 使用JPQL的方式进行查询
    1. 在dao中增加方法
        /**
         * Jpql形式
         * @param custName
         * @return
         */
        @Query(value = "from Customer where custName =?1")
        public Customer findJpql(String custName);

        @Query(value = "from Customer  where custName=?2 and id=?1")
        public Customer findCustNameAndId(Long id,String name);

        @Query(value = "update Customer set custName= ?2 where custId = ?1" )
        @Modifying
        public void updateCustomer(long custId,String custName);

    2. 在测试类中测试
        @Test
        public void testFindJpql(){
            Customer hello = dao.findJpql("hello");
            System.out.println(hello);
        }
        @Test
        public void  testFindMoreParam(){
            Customer hello = dao.findCustNameAndId(1l, "hello");
            System.out.println(hello);
        }

        /**
         * 不建议在测试方法中加事务以及不回滚,
         * 解决办法:在service中加事务
         */
        @Test
        @Transactional
        //在测试方法中默认是都回滚,所以要关闭否则修改无效
        @Rollback(value = false)
        public void testModify(){
            dao.updateCustomer(1l,"hehe");
        }
        @Test//在service中只需加事务就可以解决
        public void testModifyService(){
            service.updateCustomer(1l,"haha");
        }

 3. 使用SQL的方式进行查询
     1. 在dao中增加方法
         /**
         * 使用sql的形式查询：
         *     查询全部的客户
         *  sql ： select * from cst_customer;
         *  Query : 配置sql查询
         *      value ： sql语句
         *      nativeQuery ： 查询方式
         *          true ： sql查询
         *          false：jpql查询
         *
         */
        @Query(value="select * from cst_customer where cust_name like ?1",nativeQuery = true)
        public List<Object [] > findSql(String name);
     2. 测试类
         @Test
        public void testFindSql(){
            List<Object[]> list = dao.findSql("haha");
            for (Object[] objects : list) {
                System.out.println(Arrays.toString(objects));
            }
        }
     3. 注意返回值类型是Object[]类型

4. 方法命名规则查询(可以查询关键字对应生成语句表)
    按照Spring Data JPA 定义的规则，查询方法以findBy开头，涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性首字母需大写。
    框架在进行方法名解析时，会先把方法名多余的前缀截取掉，然后对剩下部分进行解析。

    * 示例:
        1. dao中的方法
        List<Customer> findByCustNameLikeAndCustAddressLike(String custName,String custAddress);
        2. 测试类
        @Test
        public void testFindByCustNameLikeAndCustAddressLike(){
            List<Customer> list = dao.findByCustNameLikeAndCustAddressLike("h%", "l%");
            for (Customer customer : list) {
                System.out.println(customer);
            }
        }