1. 什么是JPA

JPA是Java Persistence API的简称，是针对POJO类的ORM Java规范。

• Spring Data JPA
  Spring Data JPA和JPA及Hibernate之间是紧密关联的。
  JPA是Java ORM的规范API。
  Hibernate则实现了JPA的这种规范。
  Spring Data JPA是通用JPA规范的一种补充实现，它不仅提供了JPA的实现，同时还基于Spring的特性提供了额外的辅助功能。

 

2. Spring Data JPA的功能

• Spring Data JPA并没有完整地实现JPA
  Spring Data JPA的底层实现可以使用不同的服务提供者，
  包括但不限于Hibernate, Eclipse Link和Open JPA等，这些服务提供者才是真正的JPA规范实现者。
  Spring Data JPA只是提供了一种上层封装，为开发者提供了顶层接口规范。

• 支持Repositories模式(具体什么是Repository请参考领域驱动设计DDD相关的概念)

• 提供了audit功能

• 支持Querydsl断言(Predicate)

• 分页，排序，动态查询语句执行

• 支持@Query注解

• 支持xml映射定义

Spring Data JPA提供了一种约定大于配置的repositories实现，开发者可以减少大部分简单而又重复的CRUD操作，在传统的开发方式(eg: mybatis)中，开发者需要针对每个entity实体编写不用的CRUD操作。
Spring Data JPA提供的repositories机制为所有的entity实体提供了通用的解决方案，开发者只需要继承
Repository<T, ID>, CrudRepository<T, ID>或者JpaRepository<T, ID>接口即可。
此处，T是entity的泛型类，ID是该entity的主键类型。

• 几个主要的Repository

public interface CrudRepository<T, ID> extends Repository<T, ID>;

public interface PagingAndSortingRepository<T, ID> extends CrudRepository<T, ID>;

public interface JpaRepository<T, ID> extends PagingAndSortingRepository<T, ID>;

注:
JpaRepository在CRUD之外提供了一些额外的功能:

• flush()
  将所有没有与数据库同步的entity刷新到数据库中。
• saveAndFlush()
  保存并立即flush。
• deleteInBatch()
  批量删除。

 

3. 约定俗成的派生查询方法

Spring Data JPA虽然引入了一些系统的Repository，它们中的一些方法能满足大部分的应用开发需求。
但是在实际开发过程中，业余需求是远远多于通用操作的，那么Spring Data JPA是如何解决这些问题的呢?

答案是派生查询方法

派生查询方法是指开发者在继承某一种Repository之后，再自定义一些方法，通用一些约定俗成的方法名(eg: find...By，read...By，query...By，count...By，get...By)，当符合这些命名规范以后，当其它类调用这些方法时，Spring Data会根据方法名自动生成相应的JPQL查询语句。
需要注意的是: 方法的参数名要与entity定义的属性一致。

超过一个参数的情况:

• And连接方法参数名
  如果方法中以And连接参数名，则生成的SQL中以and连接条件。

eg: 
findAllByAvailableAndExpired(Boolean available, Boolean expired);

---

• Or连接方法参数名
  如果方法中以Or连接参数名，则生成的SQL中以or连接条件。

eg: 
findAllByAvailableOrExpired(Boolean available, Boolean expired);

代码示例:

public interface CouponTemplateRepository
        extends JpaRepository<CouponTemplateEntity, Long> {

    CouponTemplateEntity findByName(String name);

    List<CouponTemplateEntity> findAllByAvailable(Boolean available);


    List<CouponTemplateEntity> findAllByAvailableAndExpired(
            Boolean available, Boolean expired
    );

    /**
     * <h2>根据 expired 标记查找模板记录</h2>
     * where expired = ...
     * */
    List<CouponTemplateEntity> findAllByExpired(Boolean expired);

    /**
     * 根据shop ID + 可用状态查询店铺有多少券模板
     */
    Integer countByShopIdAndAvailable(Long shopId, Boolean available);

    ...
}

其它方法关键字:

除了以上的And和Or方法关键字以外，Spring Data JPA也提供了下列关键字来进行辅助定义。

• Like
  类似SQL中的like关键字。

• Containing
  属性是否包含了参数值。

• IgnoreCase
  在做值比较的时候忽略大小写。

eg:
findByNameContainingIgnoreCase

• Between
  属性值是否在一个区间范围内。

• LessThan/GreaterThan
  比较属性值和参数的大小。

 

4. JPQL定义Query查询

派生查询方法可以解决大部分简单查询需求，但是如果查询参数过多，就会导致方法签名过长，这种方法就不再合适，此时应当使用更轻量级的@Query功能。

Query注解可以支持JPQL和原生SQL。
使用Query注解的方式，开发者可以随意定义方法名，无需再遵循派生方法的命名规范。
只需要在Repository类中定义方法，并在方法上添加Query注解，再提供相应的JPQL或者原生SQL即可。

例子代码(JPQL语句)

public interface CouponTemplateRepository
        extends JpaRepository<CouponTemplateEntity, Long> {

    @Query("FROM CouponTemplate WHERE name = ?1")
    CouponTemplateEntity findByName(String name);

    @Query("FROM CouponTemplate WHERE available = ?1 AND expired = ?2")
    List<CouponTemplateEntity> findAllByAvailableAndExpired(Boolean available, Boolean expired);
}

---

例子代码(原生SQL语句)

public interface CouponTemplateRepository
        extends JpaRepository<CouponTemplateEntity, Long> {

    @Query("SELECT * FROM coupon_template WHERE name = :name")
    CouponTemplateEntity findByName(@Param("name")String name);

    @Query("SELECT * FROM coupon_template WHERE available = :available AND expired = :expired")
    List<CouponTemplateEntity> findAllByAvailableAndExpired(@Param("available")Boolean available, 
      @Param("expired")Boolean expired);
}

更新语句

那么对于UPDATE语句来说，应当如何实现数据修改呢?
答案还是使用@Query注解，但是需要添加一个额外的@Modifuing注解表明修改数据。

例子代码

public interface CouponTemplateRepository
        extends JpaRepository<CouponTemplateEntity, Long> {
    @Modifying
    @Query("update CouponTemplateEntity c set c.available = 0 where c.id = :id")
    int makeCouponUnavailable(@Param("id") Long id);
}

 

5. 命名查询(NamedQuery)

命名查询指的是为一段查询语句指定一个名称。

当我们执行这段语句的时候，只需通过这个名称就可以间接引用它对应的查询语句。
@NamedQuery注解支持JPQL语句，@NamedNativeQuery注解支持原生SQL语句。

例子代码

@Data
@NoArgsConstructor
@AllArgsConstructor
@Entity
@Builder
@EntityListeners(AuditingEntityListener.class)
@Table(name = "coupon_template")
@NamedQuery(name = "CouponTemplateEntity.findAllAvailable", query = "FROM CouponTemplateEntity where available=?1")
@NamedNativeQuery(name = "CouponTemplateEntity.findByShopId", query = "SELECT * FROM  coupon_template where shop_id=?", resultClass = CouponTemplateEntity.class)
public class CouponTemplateEntity implements Serializable {
    // 以下代码省略
}

使用命名查询

方法1(Java源代码方式)

Query q = em.createNamedQuery("CouponTemplateEntity.findAllAvailable");
q.setParameter(1, true);
List a = q.getResultList();

方法2(直接在Repository类中增加新的方法)

public interface CouponTemplateRepository
        extends JpaRepository<CouponTemplateEntity, Long> {
        List<CouponTemplate> findAllAvailable(Boolean available);
}

 

6. SpringBoot项目中使用JPA基本步骤

1. 添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

2. application.yml中增加jpa相关配置

spring:
  jpa:
    show-sql: true
    hibernate:
      # 在生产环境全部为none，防止ddl结构被自动执行
      ddl-auto: none
    properties:
      hibernate.format_sql: true
      hibernate.show_sql: true
      hibernate.dialect: org.hibernate.dialect.MySQLDialect
    open-in-view: false

3. 编写实体类，Repository注入到Service