springDataJPA(二)


一. 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框架时提供了极大的方便,同时也使数据库层操作更加简单,方便解耦

特性

SpringData Jpa 极大简化了数据库访问层代码。使用SpringDataJpa,我们的dao层通过继承SpringData Jpa提供的接口,就自动具有了增删改查、分页查询等方法。

1.2 Spring Data JPA 与 JPA和hibernate之间的关系

  • JPA是一套规范,内部是有接口和抽象类组成的。

  • hibernate是一套成熟的ORM框架,而且Hibernate实现了JPA规范,所以也可以称hibernate为JPA的一种实现方式

  • 使用JPA的API编程,意味着站在更高的角度上看待问题(面向接口编程)

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

二. Spring Data JPA的快速入门

需求: Spring Data JPA完成客户的基本CRUD操作

2.1 搭建Spring Data JPA的开发环境

2.1.1 引入Spring Data JPA的坐标

使用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>
   <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 begin -->
   <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 begin -->
   <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 begin -->
   <dependency>
       <groupId>c3p0</groupId>
       <artifactId>c3p0</artifactId>
       <version>${c3p0.version}</version>
   </dependency>
   <!-- c3p0 end -->

   <!-- log beg -->
   <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.1.2 整合Spring Data JPA与Spring

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://http://cdn.xiongsihao.com.springframework.org/schema/beans"
       xmlns:xsi="http://http://cdn.xiongsihao.com.w3.org/2001/XMLSchema-instance" xmlns:aop="http://http://cdn.xiongsihao.com.springframework.org/schema/aop"
       xmlns:context="http://http://cdn.xiongsihao.com.springframework.org/schema/context"
       xmlns:jdbc="http://http://cdn.xiongsihao.com.springframework.org/schema/jdbc" xmlns:tx="http://http://cdn.xiongsihao.com.springframework.org/schema/tx"
       xmlns:jpa="http://http://cdn.xiongsihao.com.springframework.org/schema/data/jpa" xmlns:task="http://http://cdn.xiongsihao.com.springframework.org/schema/task"
       xsi:schemaLocation="
		http://http://cdn.xiongsihao.com.springframework.org/schema/beans http://http://cdn.xiongsihao.com.springframework.org/schema/beans/spring-beans.xsd
		http://http://cdn.xiongsihao.com.springframework.org/schema/aop http://http://cdn.xiongsihao.com.springframework.org/schema/aop/spring-aop.xsd
		http://http://cdn.xiongsihao.com.springframework.org/schema/context http://http://cdn.xiongsihao.com.springframework.org/schema/context/spring-context.xsd
		http://http://cdn.xiongsihao.com.springframework.org/schema/jdbc http://http://cdn.xiongsihao.com.springframework.org/schema/jdbc/spring-jdbc.xsd
		http://http://cdn.xiongsihao.com.springframework.org/schema/tx http://http://cdn.xiongsihao.com.springframework.org/schema/tx/spring-tx.xsd
		http://http://cdn.xiongsihao.com.springframework.org/schema/data/jpa
		http://http://cdn.xiongsihao.com.springframework.org/schema/data/jpa/spring-jpa.xsd">

    <!--spring 和 spring data jpa的配置-->

    <!-- 1.创建entityManagerFactory对象交给spring容器管理-->
    <bean id="entityManagerFactoty" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!--配置的扫描的包(实体类所在的包) -->
        <property name="packagesToScan" value="com.xsh.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>

    <!--2.创建数据库连接池 -->
    <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <property name="user" value="root"></property>
        <property name="password" value="123456"></property>
        <property name="jdbcUrl" value="jdbc:mysql:///springdatajpa" ></property>
        <property name="driverClass" value="com.mysql.jdbc.Driver"></property>
    </bean>

    <!--3.整合spring dataJpa,base-package指定接口层包路径-->
    <jpa:repositories base-package="com.xsh.dao" transaction-manager-ref="transactionManager"
                      entity-manager-factory-ref="entityManagerFactoty" ></jpa:repositories>

    <!--4.配置事务管理器 -->
    <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="entityManagerFactoty"></property>
    </bean>

    <!-- 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.xsh.service.*.*(..))" />
        <aop:advisor advice-ref="txAdvice" pointcut-ref="pointcut" />
    </aop:config>


    <!--5.声明式事务 -->

    <!-- 6. 配置包扫描-->
    <context:component-scan base-package="com.xsh" ></context:component-scan>
</beans>

2.1.3 使用JPA注解配置映射关系

package com.xsh.domain;

import javax.persistence.*;

/**
 * 1.实体类和表的映射关系
 *      @Eitity
 *      @Table
 * 2.类中属性和表中字段的映射关系
 *      @Id
 *      @GeneratedValue
 *      @Column
 * 3.所有的注解都是使用JPA的规范提供的注解,
 *   所以在导入注解包的时候,一定要导入javax.persistence下的
 */
@Entity
@Table(name="cst_customer")
public class Customer {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name="cust_id")
    private Long custId;
    @Column(name="cust_address")
    private String custAddress;
    @Column(name="cust_industry")
    private String custIndustry;
    @Column(name="cust_level")
    private String custLevel;
    @Column(name="cust_name")
    private String custName;
    @Column(name="cust_phone")
    private String custPhone;
    @Column(name="cust_source")
    private String custSource;
	/*此处已省略getter,setter,toString方法...*/
}

2.2 使用Spring Data JPA完成需求

2.2.1 编写符合Spring Data JPA规范的Dao层接口

Spring Data JPA是spring提供的一款对于数据访问层(Dao层)的框架,使用Spring Data JPA,只需要按照框架的规范提供dao接口,不需要实现类就可以完成数据库的增删改查、分页查询等方法的定义,极大的简化了开发过程。

规范:

  • 创建一个Dao层接口,并实现JpaRepository和JpaSpecificationExecutor

  • 提供相应的泛型

package com.xsh.dao;

import java.util.List;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;

import com.xsh.domain.Customer;

/**
 * JpaRepository<实体类类型,主键类型>:用来完成基本CRUD操作
 * JpaSpecificationExecutor<实体类类型>:用于复杂查询(分页等查询操作)
 */
public interface CustomerDao extends JpaRepository<Customer, Long>, JpaSpecificationExecutor<Customer> {
    
}

这样就定义好了一个符合Spring Data JPA规范的Dao层接口

2.2.2 完成基本CRUD操作

完成了Spring Data JPA的环境搭建,并且编写了符合Spring Data JPA 规范的Dao层接口之后,就可以使用定义好的Dao层接口进行客户的基本CRUD操作

import com.xsh.dao.CustomerDao;
import com.xsh.domain.Customer;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

/**
 * @author : xsh
 * @create : 2019-09-09 - 10:38
 * @describe:可直接调用一些封装的基本CRUD操作,不用自己定义SQL语句
 */
@RunWith(SpringJUnit4ClassRunner.class)//声明spring提供的单元测试环境
@ContextConfiguration(locations = "classpath:applicationContext.xml")//指定spring容器的配置信息
public class CustomerDaoTest {

    @Autowired
    private CustomerDao customerDao;

    /**
    * 根据id查询数据
    * findOne:立即加载    getOne:延迟加载(什么时候用,什么时候加载)
    */
    @Test
    public void testFindOne(){
        Customer one = customerDao.findOne(2L);
        System.out.println(one);
    }
    @Test
    @Transactional//事务管理,确保getOne能正常延迟加载
    public void testGetOne(){
        Customer one = customerDao.getOne(2L);
        //此处未使用one,所以不会执行getOne
        //System.out.println(one);
    }

    /**
     * save : 保存或者更新
     *      根据传递的对象是否存在主键id,
     *      如果没有id主键属性:保存
     *      存在id主键属性,根据id查询数据,更新数据
     */
    @Test
    public void testSave(){
        Customer c=new Customer();
        c.setCustName("testSave");
        c.setCustAddress("徐汇区");
        c.setCustLevel("一级");
        customerDao.save(c);//因为此处没有传递id,所以为保存操作
    }
    @Test
    public void testUpdate(){
        Customer c=new Customer();
        c.setCustName("Update");
        c.setCustAddress("徐汇区");
        c.setCustLevel("二级");
        c.setCustId(11L);
        customerDao.save(c);//因为此处传递了id,且id存在,所以为更新操作
    }

    /*delete 根据id删除数据*/
    @Test
    public void testDelete(){
        customerDao.delete(11L);
    }

    /*findAll  查询所有数据*/
    @Test
    public void testFindAll(){
        List<Customer> customers = customerDao.findAll();
        for(Customer customer:customers){
            System.out.println(customer);
        }
    }

    /*count  查询表中字段条数*/
    @Test
    public void testCount(){
        long count = customerDao.count();
        System.out.println(count);
    }

    /**
     * 用关键字exists查询判断主键值是否存在,返回一个布尔值
     */
    @Test
    public void testExists(){
        boolean flag = customerDao.exists(2L);
        System.out.println(flag);
    }
}

三. Spring Data JPA的查询方式

3.1 使用Spring Data JPA中接口定义的方法进行查询

在继承JpaRepository,和JpaRepository接口后,我们就可以使用接口中定义的方法进行查询

  • 继承JpaRepository后的方法列表:

  • 继承JpaSpecificationExecutor的方法列表:

3.2 使用JPQL的方式查询

使用Spring Data JPA提供的查询方法已经可以解决大部分的应用场景,但是对于某些业务来说,还需要灵活的构造查询条件,这时就可以使用**@Query**注解,结合JPQL的语句方式完成查询

@Query 注解的使用非常简单,只需在方法上面标注该注解,同时提供一个JPQL查询语句即可

public interface CustomerDao extends JpaRepository<Customer,Long> ,JpaSpecificationExecutor<Customer> {
    /*
    根据名字查询数据
    mysql语句:select*from cst_customer where cust_name=?   操作数据库表名和字段名
    jpql语句:from Customer where custName=?      操作实体类名和属性名
    */
    @Query(value="from Customer where custName = ?")
    public Customer findJpql(String custName);

    /*对于多个占位符参数
     *  赋值的时候,默认的情况下,占位符的位置需要和方法参数中的位置保持一致
     *  当不一致时,可以指定占位符参数的位置
     *      ?后加索引的方式,指定此占位的取值来源,如custName=?2取第二个参数*/
    @Query(value = "from Customer where custName=?2 and custId=?1")
    public Customer findCustNameAndId(Long id,String name);

    /*用 @Modifying 来将该操作标识为修改查询,这样框架最终会生成一个更新的操作,而非查询*/
    @Query(value = "update Customer set custName = ?2 where custId = ?1")
    @Modifying
    public void UpdateCustomer(long custId,String custName);
}

更新操作使用:

@Test
@Transactional//添加事务的支持,更新操作必须添加事务支持
@Rollback(value = false) //将事物回滚关闭,默认开启;因为要执行更新操作,所以关闭
public void testUpdateCustomer(){
    customerDao.UpdateCustomer(7L,"update77/");
}

3.3 使用SQL语句查询

Spring Data JPA同样也支持sql语句的查询

/**
 * nativeQuery : 是否使用本地sql的方式查询
 * false(使用jpql查询) | true(使用本地查询:sql查询)
 */
@Query(value="select * from cst_customer",nativeQuery=true)
public void findSql();

3.4 方法命名规则查询

顾名思义,方法命名规则查询就是根据方法的名字,就能创建查询。只需要按照Spring Data JPA提供的方法命名规则定义方法的名称,就可以完成查询工作。Spring Data JPA在程序执行的时候会根据方法名称进行解析,并自动生成查询语句进行查询。

按照Spring Data JPA 定义的规则:

  • 查询方法以findBy开头,后面直接**拼接对象中的属性名(首字母大写)**作为查询条件,默认使用 等于的方式查询

    //根据属性名custName查询
    Customer findByCustName(String custName);
    
  • findBy + 属性名称 + 查询方式(Like | isnull)

    //根据custName模糊查询
    List<Customer> findByCustNameLike(String custName);
    
  • 多条件查询

    findBy + 属性名 + 查询方式 + 多条件的连接符(and|or) + 属性名 + 查询方式

    //使用客户名称模糊匹配和客户所属行业精准匹配的查询
    Customer findByCustNameLikeAndCustIndustry(String custName,String custIndustry);
    

    具体的关键字,使用方法和生产成SQL如下表所示:

    KeywordSampleJPQL
    AndfindByLastnameAndFirstname… where x.lastname = ?1 and x.firstname = ?2
    OrfindByLastnameOrFirstname… where x.lastname = ?1 or x.firstname = ?2
    Is,EqualsfindByFirstnameIs, findByFirstnameEquals… where x.firstname = ?1
    BetweenfindByStartDateBetween… where x.startDate between ?1 and ?2
    LessThanfindByAgeLessThan… where x.age < ?1
    LessThanEqualfindByAgeLessThanEqual… where x.age ⇐ ?1
    GreaterThanfindByAgeGreaterThan… where x.age > ?1
    GreaterThanEqualfindByAgeGreaterThanEqual… where x.age >= ?1
    AfterfindByStartDateAfter… where x.startDate > ?1
SpringDataJPA

评论