Spring Data JPA详解

刺骨的言语ヽ痛彻心扉 2024-03-22 17:25 85阅读 0赞

### 第一节 SpringData介绍 ###

#### 1. Spring Data ####

Spring Data是持久层通用解决方案，支持关系型数据库 Oracle、MySQL、非关系型数据库NoSQL、Map-Reduce 框架、云基础数据服务 、搜索服务等。

#### 2. Spring Data JPA ####

Spring Data JPA 框架，主要针对的就是 Spring 唯一没有简化到的持久层操作代码，至此，开发者连仅剩的实现持久层工作都省了，唯一要做的，就只是声明持久层的接口，其他都交给 Spring Data JPA 来帮你完成！

### 第二节 SpringBoot 整合 JPA ###

#### 1. 引入依赖 ####

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>

#### 2. yml 配置 ####

spring:
      datasource:
        type: com.zaxxer.hikari.HikariDataSource
        url: jdbc:mysql://localhost:3306/jpa?serverTimezone=Asia/Shanghai
        username: root
        password: root
      jpa:
        hibernate:
          ddl-auto: update #自动创建表
        show-sql: true #显示SQL语句

#### 3. 创建实体类 ####

package com.qf.jpa.entity;
    
    import lombok.Data;
    
    import javax.persistence.*;
    import java.io.Serializable;
    
    @Entity //标识实体
    //为注解标识的实体指定对应的数据表
    @Table(name = "student")
    @Data
    public class Student implements Serializable {
    
        @Id //ID列标识
        @GeneratedValue(strategy = GenerationType.IDENTITY)//主键生成策略
        @Column(name = "id", length = 20, nullable = false)//列定义
        private Long id;
    
        @Column(name = "name", length = 50, nullable = false)
        private String name;
    
        @Column(name = "sex", length = 1, nullable = false)
        private int sex;
    
        @Column(name = "phone", length = 11, nullable = false)
        private String phone;
    }

#### 4. 创建DAO ####

package com.qf.jpa.dao;
    
    import com.qf.jpa.entity.Student;
    import org.springframework.data.jpa.repository.JpaRepository;
    
    public interface StudentRepository extends JpaRepository<Student, String> {
    }

#### 5. 测试 ####

package com.qf.jpa;
    
    import com.qf.jpa.dao.StudentRepository;
    import com.qf.jpa.entity.Student;
    import org.junit.jupiter.api.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    
    @SpringBootTest
    class JpaApplicationTests {
    
        @Autowired
        private StudentRepository studentRepository;
    
        @Test
        void jpaTest() {
            Student stu = new Student();
            stu.setName("张华");
            stu.setSex(1);
            stu.setPhone("1388888888");
            studentRepository.save(stu);
            System.out.println(stu.getId());
        }
    }

#### 6. 查看表结构及数据 ####

### 第三节 Spring Data JPA 核心接口 ###

#### 1. Repository 接口 ####

该接口主要提供了方法名称命名查询方式，同时也提供了基于@Query注解查询与更新

package com.qf.jpa.dao;
    
    import com.qf.jpa.entity.Student;
    import org.springframework.data.jpa.repository.JpaRepository;
    import org.springframework.data.jpa.repository.Modifying;
    import org.springframework.data.jpa.repository.Query;
    
    import java.util.List;
    
    public interface StudentRepository extends JpaRepository<Student, String> {
        //方法名称必须要遵循驼峰式命名规则，findBy（关键字）+属性名称（首字母大写）+查询条件（首字母大写）
        List<Student> findByNameLike(String name);
    
        List<Student> findByNameLikeOrPhoneEquals(String name, String phone);
    
        @Query("FROM Student WHERE name LIKE :name") //HQL=Hibernate Query Language
        List<Student> getStudents(String name);
    
        @Query(value="SELECT * FROM student WHERE name LIKE ?",nativeQuery=true)
        List<Student> searchStudents(String name);
    }

#### 2. CrudRepository接口 ####

该接口是 Repository的子接口，主要是提供一些增删改查的操作。

@Test
    public void testCrudRepositorySave() {
        Student stu = new Student();
        stu.setName("张华");
        stu.setSex(1);
        stu.setPhone("1388888888");
        studentRepository.save(stu);
    }
    
    @Test
    public void testCrudRepositoryUpdate() {
         Student stu = new Student();
         stu.setId(1);
         stu.setName("张华");
         stu.setSex(2);
         stu.setPhone("13899999999");
         this.studentRepository.save(users);
    }
    
    @Test
    public void testCrudRepositoryFindOne() {
        Student stu=this.studentRepository.findOne(1);
        System.out.println(stu);
    }
    
    @Test
    public void testCrudRepositoryFindAll() {
        List<Student> list= (List<Student>) this.studentRepository.findAll();
        for (Student stu:list){
            System.out.println(stu);
        }
    }
    
    @Test
    public void testCrudRepositoryDeleteById() {
        this.studentRepository.delete(4);
    }

#### 3. PagingAndSortingRepository接口 ####

该接口是 CrudRepository 的子接口，主要提供了分页与排序的操作。

@Test
        public void testPagingAndSortingRepositorySort() {
            //Order 定义了排序规则
            Sort.Order order=new Sort.Order(Sort.Direction.DESC,"id");
            //Sort对象封装了排序规则
            Sort sort=new Sort(order);
            List<Student> list= (List<Student>) this.studentRepository.findAll(sort);
            for (Student stu:list){
                System.out.println(stu);
            }
        }
    
        @Test
        public void testPagingAndSortingRepositoryPaging() {
            //Pageable:封装了分页的参数，当前页，煤业显示的条数。注意：它的当前页是从0开始
            //PageRequest(page,size):page表示当前页，size表示每页显示多少条
            Pageable pageable=new PageRequest(1,2);
            Page<Student> page=this.studentRepository.findAll(pageable);
            System.out.println("数据的总条数："+page.getTotalElements());
            System.out.println("总页数："+page.getTotalPages());
            List<Student> list=page.getContent();
            for (Student stu:list){
                System.out.println(stu);
            }
        }
    
        @Test
        public void testPagingAndSortingRepositorySortAndPaging() {
            Sort sort=new Sort(new Sort.Order(Sort.Direction.DESC,"id"));
            Pageable pageable=new PageRequest(0,2,sort);
            Page<Student> page=this.studentRepository.findAll(pageable);
            System.out.println("数据的总条数："+page.getTotalElements());
            System.out.println("总页数："+page.getTotalPages());
            List<Student> list=page.getContent();
            for (Student stu:list){
                System.out.println(stu);
            }
        }

#### 4. JpaRepository 接口 ####

该接口是 PagingAndSortingRepository的子接口，对继承父接口中方法的返回值进行了适配,因为在父类接口中通常都返回迭代器，需要我们自己进行强制类型转化。而在JpaRepository中，直接返回了List。

#### 5. JpaSpecificationExecutor 接口 ####

JpaSpecificationExecutor 接口是独立于以上接口之外的接口，主要用于实现复杂动态查询。

5.1 单条件查询

public Page<User> test(){
            Sort sort = new Sort(Sort.Direction.DESC,"id");
            int page = 1;
            int pageSize = 5;
            Pageable pageable = PageRequest.of(page,pageSize,sort);
    
            //通常使用 Specification 的匿名内部类
            Specification<User> specification = new Specification<User>() {
                /**
                 * @param root: 代表查询的实体类.
                 * @param query: 可以从中可到 Root 对象, 即告知 JPA Criteria 查询要查询哪一个实体类. 还可以
                 * 来添加查询条件, 还可以结合 EntityManager 对象得到最终查询的 TypedQuery 对象.
                 * @param *cb: CriteriaBuilder 对象. 用于创建 Criteria 相关对象的工厂. 当然可以从中获取到 Predicate 对象
                 * @return: *Predicate 类型, 代表一个查询条件.
                 */
                @Override
                public Predicate toPredicate(Root<Student> root,
                                             CriteriaQuery<?> query, CriteriaBuilder cb) {
                    Path id = root.get("id");
                    Predicate predicateId = cb.gt(id,5);
                    return predicateId ;
                }
            };
            Page<Student> userPage = userRepository.findAll(specification,  pageable);
            return userPage;
        }

5.2 多条件查询

Specification<User> specification = new Specification<User>() {
        @Override
        public Predicate toPredicate(Root<Student> root,
                                     CriteriaQuery<?> query, CriteriaBuilder cb) {
            Path id = root.get("id");
            Predicate predicateId = cb.gt(id,5);
            Path<Student> email = root.get("phone");
            Predicate predicateEmail = cb.equal(email, "13899999999");
            Predicate endPredicate = cb.and(predicateId, predicateEmail);
            return endPredicate;
        }
    };