JPA_SpringData

SpringData概述

1. Spring Data : Spring 的一个子项目。用于简化数据库访问，支持NoSQL 和 关系数据存储。其主要目标是使数据库的访问变得方便快捷。
2. SpringData 项目所支持 NoSQL 存储：

• MongoDB （文档数据库）
• Neo4j（图形数据库）
• Redis（键/值存储）
• Hbase（列族数据库）

1. SpringData 项目所支持的关系数据存储技术：

• JDBC
• JPA

1. JPA Spring Data : 致力于减少数据访问层 (DAO) 的开发量. 开发者唯一要做的，就只是声明持久层的接口，其他都交给 Spring Data JPA 来帮你完成！
2. 框架怎么可能代替开发者实现业务逻辑呢？比如：当有一个 UserDao.findUserById() 这样一个方法声明，大致应该能判断出这是根据给定条件的 ID 查询出满足条件的 User 对象。Spring Data JPA 做的便是规范方法的名字，根据符合规范的名字来确定方法需要实现什么样的逻辑。

Springboot 环境搭建

1. POM依赖

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

2. application.yml

spring:
  devtools:
    restart:
      enabled: true
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mytest?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&serverTimezone=GMT%2B8&useSSL=false
    username: root
    password: 123456
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true

3. 创建实体类

@Table(name="persons")
@Entity
@ToString
public class Person {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;
    private String lastName;
    private String email;
    private Date birth;
}

4. 创建接口

@Component
public interface PersonDao  extends JpaRepository<Person,Integer> {
    Person getByLastName(String lastName);
}

Repository 接口

Repository接口概述

• Repository 接口是 Spring Data 的一个核心接口，它不提供任何方法，开发者需要在自己定义的接口中声明需要的方法

public interface Repository<T, ID extends Serializable> { }

• Spring Data可以让我们只定义接口，只要遵循 Spring Data的规范，就无需写实现类。
• 与继承 Repository 等价的一种方式，就是在持久层接口上使用 @RepositoryDefinition 注解，并为其指定 domainClass 和 idClass 属性。如下两种方式是完全等价的

@RepositoryDefinition(domainClass = Person.class,idClass = Integer.class)
public interface PersonDao {.....}

public interface PersonDao extends Repository<Person,Integer> {

Repository 的子接口

1. 基础的 Repository 提供了最基本的数据访问功能，其几个子接口则扩展了一些功能。它们的继承关系如下：

• Repository： 仅仅是一个标识，表明任何继承它的均为仓库接口类
• CrudRepository： 继承 Repository，实现了一组 CRUD 相关的方法
• PagingAndSortingRepository： 继承 CrudRepository，实现了一组分页排序相关的方法
• JpaRepository： 继承 PagingAndSortingRepository，实现一组 JPA 规范相关的方法
• 自定义的 XxxxRepository 需要继承 JpaRepository，这样的 XxxxRepository 接口就具备了通用的数据访问控制层的能力。
• JpaSpecificationExecutor： 不属于Repository体系，实现一组 JPA Criteria 查询相关的方法

SpringData方法定义规范

简单条件查询

• 简单条件查询: 查询某一个实体类或者集合
• 按照 Spring Data 的规范，查询方法以 find | read | get 开头， 涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性以首字母大写。
• 例如：定义一个 Entity 实体类

class User｛
	private String firstName; 
	private String lastName; 
｝

使用And条件连接时，应这样写： findByLastNameAndFirstName(String lastName,String firstName); 条件的属性名称与个数要与参数的位置与个数一一对应

支持的关键字

• 直接在接口中定义查询方法，如果是符合规范的，可以不用写实现，目前支持的关键字写法如下：
• 
  
•  

查询方法解析流程

1. 假如创建如下的查询：findByUserDepUuid()，框架在解析该方法时，首先剔除 findBy，然后对剩下的属性进行解析，假设查询实体为Doc

• 先判断 userDepUuid （根据 POJO 规范，首字母变为小写）是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，继续第二步；
• 从右往左截取第一个大写字母开头的字符串(此处为Uuid)，然后检查剩下的字符串是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，则重复第二步，继续从右往左截取；最后假设 user 为查询实体的一个属性；
• 接着处理剩下部分（DepUuid），先判断 user 所对应的类型是否有depUuid属性，如果有，则表示该方法最终是根据 “ Doc.user.depUuid” 的取值进行查询；否则继续按照步骤 2 的规则从右往左截取，最终表示根据 “Doc.user.dep.uuid” 的值进行查询。
• 可能会存在一种特殊情况，比如 Doc包含一个 user 的属性，也有一个 userDep 属性，此时会存在混淆。可以明确在属性之间加上 "_" 以显式表达意图，比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"

1. 特殊的参数： 还可以直接在方法的参数上加入分页或排序的参数，比如： Page<UserModel> findByName(String name, Pageable pageable); List<UserModel> findByName(String name, Sort sort);

使用@Query注解

使用@Query自定义查询

• 这种查询可以声明在 Repository 方法中，摆脱像命名查询那样的约束，将查询直接在相应的接口方法中声明，结构更为清晰，这是 Spring data 的特有实现。

索引参数与命名参数

• 索引参数如下所示，索引值从1开始，查询中 ”?X” 个数需要与方法定义的参数个数相一致，并且顺序也要一致
• 命名参数（推荐使用这种方式）：可以定义好参数名，赋值时采用@Param("参数名")，而不用管顺序。
• 如果是 @Query 中有 LIKE 关键字，后面的参数需要前面或者后面加 %，这样在传递参数值的时候就可以不加 %：

@Query("select o from UserModel o where o.name like ?1%")
public List<UserModel> findByUuidOrAge(String name);
@Query("select o from UserModel o where o.name like %?1")
public List<UserModel> findByUuidOrAge(String name);
@Query("select o from UserModel o where o.name like %?1%")
public List<UserModel> findByUuidOrAge(String name);

用@Query来指定本地查询

• 还可以使用@Query来指定本地查询，只要设置nativeQuery为true，比如：

@Query(value="select * from tbl_user where name like %?1" ,nativeQuery=true)
public List<UserModel> findByUuidOrAge(String name);

@Modifying 注解和事务

@Query 与 @Modifying 执行更新操作

1. @Query 与 @Modifying 这两个 annotation一起声明，可定义个性化更新操作，例如只涉及某些字段更新时最为常用，示例如下：

 dao：添加Modifying

    /*
    * key通过自定义的JPQL完成Update和Delete操作：注意JPQL不支持使用Insert
    * 在Query注解中编写JPQL语句，必须使用Modifying注解进行修饰，
    *   以通知SpringData,这是一个Update或Delete操作
    *   Update或Delete操作需要使用事务，此时需要在Service层的方法上使用事务操作。
    * 默认情况下，SpringData的每个方法上有事务，但都是一个只读事务，他们不能完成修改操作
    * */
    @Modifying
    @Query("UPDATE Person p set p.email=:email where p.id=:id")
    void updatePersonEmail(Integer id,String email);

 service：添加事务

import com.zhl.jpa.dao.PersonDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class PersonService {
    @Autowired
    private PersonDao personDao;

    @Transactional
    public void upddatePersonEmail(String email,Integer id){
        personDao.updatePersonEmail(id, email);
    }
}

测试：

    @Test
    public void test13(){
        personService.upddatePersonEmail("[email protected]",1);
    }

1. 注意

• 方法的返回值应该是 int，表示更新语句所影响的行数
• 在调用的地方必须加事务，没有事务不能正常执行

事务

• Spring Data 提供了默认的事务处理方式，即所有的查询均声明为只读事务。
• 对于自定义的方法，如需改变 Spring Data 提供的事务默认方式，可以在方法上注解 @Transactional 声明
• 进行多个 Repository 操作时，也应该使它们在同一个事务中处理，按照分层架构的思想，这部分属于业务逻辑层，因此，需要在 Service 层实现对多个 Repository 的调用，并在相应的方法上声明事务。

CrudRepository 接口

CrudRepository 接口提供了最基本的对实体类的添删改查操作

• T save(T entity);//保存单个实体
• Iterable<T> save(Iterable<? extends T> entities);//保存集合
• T findOne(ID id);//根据id查找实体
• boolean exists(ID id);//根据id判断实体是否存在
• Iterable<T> findAll();//查询所有实体,不用或慎用!
• long count();//查询实体数量
• void delete(ID id);//根据Id删除实体
• void delete(T entity);//删除一个实体
• void delete(Iterable<? extends T> entities);//删除一个实体的集合
• void deleteAll();//删除所有实体,不用或慎用!

测试：

service:

    @Transactional
    public void savePersons(List<Person> personList){
        personDao.saveAll(personList);
    }

PagingAndSortingRepository接口

该接口提供了分页与排序功能

• Iterable<T> findAll(Sort sort); //排序
• Page<T> findAll(Pageable pageable); //分页查询（含排序功能）

    @Test
    public void testPagingAndSortingRepository(){

        int pageNo=3;
        int pageSize=5;
        //排序相关的 Sort封装了排序的信息
        Sort.Order order1=new Sort.Order(Sort.Direction.DESC,"id");
        Sort.Order order2=new Sort.Order(Sort.Direction.ASC,"email");
        Sort sort=Sort.by(order1,order2);
        PageRequest pageRequest =  PageRequest.of(pageNo,pageSize,sort);

        Page<Person> page = personDao.findAll(pageRequest);
        System.out.println("总记录数：" + page.getTotalElements());
        System.out.println("当前第几页：" + page.getNumber() + 1);
        System.out.println("总页数：" + page.getTotalPages());
        System.out.println("当前页面的List：" + page.getContent());
        System.out.println("当前页面的记录数：" + page.getNumberOfElements());

    }

JpaRepository接口

该接口提供了JPA的相关功能

• List<T> findAll(); //查找所有实体
• List<T> findAll(Sort sort); //排序、查找所有实体
• List<T> save(Iterable<? extends T> entities);//保存集合
• void flush();//执行缓存与数据库同步
• T saveAndFlush(T entity);//强制执行持久化
• void deleteInBatch(Iterable<T> entities);//删除一个实体集合

//public interface PersonDao extends JpaRepository<Person,Integer> {
    @Test
    public void testJPARepository(){
        Person person = new Person();
        person.setBirth(new Date());
        person.setEmail("[email protected]");
        person.setLastName("xyzaa");
        person.setId(28);
        //根据id进行判断，有则更新，无则添加
        Person person1 = personDao.saveAndFlush(person);
        System.out.println(person1);
    }

JpaSpecificationExecutor接口

• 不属于Repository体系，实现一组 JPA Criteria 查询相关的方法

 

• Specification：封装 JPA Criteria 查询条件。通常使用匿名内部类的方式来创建该接口的对象

  //public interface PersonDao extends JpaRepository<Person,Integer> , JpaSpecificationExecutor<Person>
    /*目标：实现带查询条件的分页 id>5的条件
    * 调用JpaSpecificationExecutor的 findAll(@Nullable Specification<T> var1, Pageable var2)
    * Specification：封装了JPA Criteria 查询的查询条件
    * Pageable: 封装了请求分页的信息，例如，PageNo，pageSize,Sort
    * */
    //public interface PersonDao extends JpaSpecificationExecutor<Person>
    @Test
    public void testJpaSpecificationExecutor(){
        int pageNo=3-1;
        int pageSize=5;
        PageRequest pageable = PageRequest.of(pageNo, pageSize);
        //通常使用Specification的匿名内部类
        Specification<Person>  specification=new Specification<Person>(){
            /**
             *
             * @param root  *代表查询的实体类，
             * @param criteriaQuery 可以从中得到Root对象，即告知JPA Criteria查询要查询哪一个实体类
             *                      还可以添加查询条件，还可以结合EntityManager对象得到最终查询的TypedQuery对象
             * @param criteriaBuilder *criteriaBuilder对象，用于创建Criteria相关对象的工厂，
             *                        当然可以从中获取到Predicate对象
             * @return  * Predicate类型，代表一个查询条件
             */
            @Override
            public Predicate toPredicate(Root<Person> root,
                                         CriteriaQuery<?> criteriaQuery,
                                         CriteriaBuilder criteriaBuilder) {
                Path path = root.get("id");
                Predicate predicate=criteriaBuilder.gt(path,5);
                return predicate;
            }
        };

        Page<Person> page=personDao.findAll(specification,pageable);
        System.out.println("总记录数：" + page.getTotalElements());
        System.out.println("当前第几页：" + (page.getNumber() + 1));
        System.out.println("总页数：" + page.getTotalPages());
        System.out.println("当前页面的List：" + page.getContent());
        System.out.println("当前页面的记录数：" + page.getNumberOfElements());

    }

自定义 Repository 方法

• 为某一个 Repository 上添加自定义方法
• 为所有的 Repository 都添加自实现的方法

为某一个 Repository 上添加自定义方法

步骤：

• 定义一个接口: 声明要添加的, 并自实现的方法
• 提供该接口的实现类: 类名需在要声明的 Repository 后添加 Impl, 并实现方法
• 声明 Repository 接口, 并继承 1) 声明的接口
• 使用.
• 注意: 默认情况下, Spring Data 会在 base-package 中查找 "接口名Impl" 作为实现类. 也可以通过　repository-impl-postfix　声明后缀.

//PersonDao
public interface PersonDao {
   public void test();
}

//PersonRepositoryImpl
@Service
public class PersonRepositoryImpl implements PersonDao {
    @PersistenceContext
    private EntityManager entityManager;

    @Override
    public void test() {
        Person person = entityManager.find(Person.class, 11);
        System.out.println(person);

    }
}
//PersonRepository
public interface PersonRepository extends
        JpaRepository<Person,Integer> ,
        JpaSpecificationExecutor<Person> , PersonDao {}

//测试
    @Test
    public void testCustomRepositoryMethod(){
        personRepository.test();
    }

为所有的 Repository 都添加自实现的方法

步骤：

• 声明一个接口, 在该接口中声明需要自定义的方法, 且该接口需要继承 Spring Data 的 Repository.
• 提供 1) 所声明的接口的实现类. 且继承 SimpleJpaRepository, 并提供方法的实现
• 定义 JpaRepositoryFactoryBean 的实现类, 使其生成 1) 定义的接口实现类的对象
• 修改 <jpa:repositories /> 节点的 factory-class 属性指向 3) 的全类名
• 注意: 全局的扩展实现类不要用 Imp 作为后缀名, 或为全局扩展接口添加 @NoRepositoryBean 注解告知 Spring Data: Spring Data 不把其作为 Repository