1. 程式人生 > 實用技巧 >20201206 Spring Data JPA - 拉勾教育

20201206 Spring Data JPA - 拉勾教育

Spring Data JPA 概述

  • Spring Data Jpa 是應用於 Dao 層的一個框架,簡化資料庫開發的,作用和 Mybatis 框架一樣,但是在使用方式和底層機制是有所不同的。
  • Spring Data JPA 是 Spring 基於JPA 規範的基礎上封裝的⼀套 JPA 應用框架
  • JPA 是一套規範,內部是由介面和抽象類組成的, Hiberanate 是一套成熟的 ORM 框架,而且 Hiberanate 實現了 JPA 規範,所以可以稱 Hiberanate 為 JPA 的一種實現方式,我們使用 JPA 的 API 程式設計,意味著站在更高的角度去看待問題(面向介面程式設計)。
  • Spring Data JPA 是 Spring 提供的一套對 JPA 操作更加高階的封裝,是在 JPA 規範下的專⻔用來進行資料持久化的解決方案。

Spring Data JPA 應用

  1. 初始化指令碼

    SET NAMES utf8mb4;
    SET FOREIGN_KEY_CHECKS = 0;
    -- ----------------------------
    -- Table structure for tb_resume
    -- ----------------------------
    DROP TABLE IF EXISTS `tb_resume`;
    CREATE TABLE `tb_resume` (
    `id` bigint(20) NOT NULL AUTO_INCREMENT,
    `address` varchar(255) DEFAULT NULL,
    `name` varchar(255) DEFAULT NULL,
    `phone` varchar(255) DEFAULT NULL,
    PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
    -- ----------------------------
    -- Records of tb_resume
    -- ----------------------------
    BEGIN;
    INSERT INTO `tb_resume` VALUES (1, '北京', '張三', '131000000');
    INSERT INTO `tb_resume` VALUES (2, '上海', '李四', '151000000');
    INSERT INTO `tb_resume` VALUES (3, '⼴州', '王五', '153000000');
    COMMIT;
    SET FOREIGN_KEY_CHECKS = 1;
    
  2. POM

    	<dependencies>
            <!--單元測試jar-->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
    
    
            <!--spring-data-jpa 需要引入的jar,start-->
            <dependency>
                <groupId>org.springframework.data</groupId>
                <artifactId>spring-data-jpa</artifactId>
                <version>2.1.8.RELEASE</version>
            </dependency>
    
            <dependency>
                <groupId>javax.el</groupId>
                <artifactId>javax.el-api</artifactId>
                <version>3.0.1-b04</version>
            </dependency>
            <dependency>
                <groupId>org.glassfish.web</groupId>
                <artifactId>javax.el</artifactId>
                <version>2.2.6</version>
            </dependency>
            <!--spring-data-jpa 需要引入的jar,end-->
    
            <!--spring 相關jar,start-->
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-aop</artifactId>
                <version>5.1.12.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.aspectj</groupId>
                <artifactId>aspectjweaver</artifactId>
                <version>1.8.13</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.1.12.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context-support</artifactId>
                <version>5.1.12.RELEASE</version>
            </dependency>
    
            <!--spring對orm框架的支援包-->
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-orm</artifactId>
                <version>5.1.12.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
                <version>5.1.12.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>5.1.12.RELEASE</version>
            </dependency>
            <!--spring 相關jar,end-->
    
    
            <!--hibernate相關jar包,start-->
            <dependency>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-core</artifactId>
                <version>5.4.0.Final</version>
            </dependency>
            <!--hibernate對jpa的實現jar-->
            <dependency>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-entitymanager</artifactId>
                <version>5.4.0.Final</version>
            </dependency>
            <dependency>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-validator</artifactId>
                <version>5.4.0.Final</version>
            </dependency>
            <!--hibernate相關jar包,end-->
    
            <!--mysql 資料庫驅動jar-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.46</version>
            </dependency>
            <!--druid連線池-->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.21</version>
            </dependency>
            <!--spring-test-->
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-test</artifactId>
                <version>5.1.12.RELEASE</version>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.16</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.2.3</version>
            </dependency>
        </dependencies>
    
  3. applicationContext.xml

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:context="http://www.springframework.org/schema/context"
           xmlns:jpa="http://www.springframework.org/schema/data/jpa"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="
            http://www.springframework.org/schema/beans
            https://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            https://www.springframework.org/schema/context/spring-context.xsd
            http://www.springframework.org/schema/data/jpa
            https://www.springframework.org/schema/data/jpa/spring-jpa.xsd
    ">
    
        <!--對Spring和SpringDataJPA進行配置-->
    
        <!--1、建立資料庫連線池druid-->
        <!--引入外部資原始檔-->
        <context:property-placeholder location="classpath:jdbc.properties"/>
    
        <!--第三方jar中的bean定義在xml中-->
        <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
            <property name="driverClassName" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <property name="password" value="${jdbc.password}"/>
        </bean>
    
    
        <!--
            2、配置一個JPA中非常重要的物件,entityManagerFactory
            entityManager類似於mybatis中的SqlSession
            entityManagerFactory類似於Mybatis中的SqlSessionFactory
        -->
        <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
            <!--配置一些細節.......-->
    
    
            <!--配置資料來源-->
            <property name="dataSource" ref="dataSource"/>
            <!--配置包掃描(pojo實體類所在的包)-->
            <property name="packagesToScan" value="com.lagou.edu.pojo"/>
            <!--指定jpa的具體實現,也就是hibernate-->
            <property name="persistenceProvider">
                <bean class="org.hibernate.jpa.HibernatePersistenceProvider"></bean>
            </property>
            <!--jpa方言配置,不同的jpa實現對於類似於beginTransaction等細節實現起來是不一樣的,
                   所以傳入JpaDialect具體的實現類-->
            <property name="jpaDialect">
                <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect"></bean>
            </property>
    
    
            <!--配置具體provider,hibearnte框架的執行細節-->
            <property name="jpaVendorAdapter">
                <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
                    <!--定義hibernate框架的一些細節-->
    
                    <!--
                        配置資料表是否自動建立
                        因為我們會建立pojo和資料表之間的對映關係
                        程式啟動時,如果資料表還沒有建立,是否要程式給建立一下
                    -->
                    <property name="generateDdl" value="false"/>
    
    
                    <!--
                        指定資料庫的型別
                        hibernate本身是個dao層框架,可以支援多種資料庫型別的,這裡就指定本次使用的什麼資料庫
                    -->
                    <property name="database" value="MYSQL"/>
    
    
                    <!--
                        配置資料庫的方言
                        hiberante可以幫助我們拼裝sql語句,但是不同的資料庫sql語法是不同的,所以需要我們注入具體的資料庫方言
                    -->
                    <property name="databasePlatform" value="org.hibernate.dialect.MySQLDialect"/>
                    <!--是否顯示sql
                        操作資料庫時,是否列印sql
                    -->
                    <property name="showSql" value="true"/>
    
                </bean>
            </property>
    
        </bean>
    
    
        <!--3、引用上面建立的entityManagerFactory
    
                 <jpa:repositories> 配置jpa的dao層細節
                 base-package:指定dao層介面所在包
        -->
        <jpa:repositories base-package="com.lagou.edu.dao" entity-manager-factory-ref="entityManagerFactory"
                          transaction-manager-ref="transactionManager"/>
    
    
        <!--4、事務管理器配置
            jdbcTemplate/mybatis 使用的是 DataSourceTransactionManager
            jpa規範:JpaTransactionManager
        -->
        <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
            <property name="entityManagerFactory" ref="entityManagerFactory"/>
        </bean>
    
    
        <!--5、宣告式事務配置,需要時配置-->
        <!--
            <tx:annotation-driven/>
        -->
    
    
    </beans> 
    
  4. Resume.java - pojo

    @Entity
    @Table(name = "tb_resume")
    @Data
    public class Resume {
    
        @Id
        /**
         * 生成策略經常使用的兩種:
         * GenerationType.IDENTITY:依賴資料庫中主鍵自增功能  Mysql
         * GenerationType.SEQUENCE:依靠序列來產生主鍵     Oracle
         */
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        @Column(name = "id")
        private Long id;
        @Column(name = "name")
        private String name;
        @Column(name = "address")
        private String address;
        @Column(name = "phone")
        private String phone;
    }
    
    
  5. ResumeDao.java - DAO

    /**
     * 一個符合SpringDataJpa要求的Dao層介面是需要繼承JpaRepository和JpaSpecificationExecutor
     * <p>
     * JpaRepository<操作的實體類型別,主鍵型別>
     * 封裝了基本的CRUD操作
     * <p>
     * JpaSpecificationExecutor<操作的實體類型別>
     * 封裝了複雜的查詢(分頁、排序等)
     */
    public interface ResumeDao extends JpaRepository<Resume, Long>, JpaSpecificationExecutor<Resume> {
    
    
        @Query("from Resume  where id=?1 and name=?2")
        List<Resume> findByJpql(Long id, String name);
    
    
        /**
         * 使用原生sql語句查詢,需要將nativeQuery屬性設定為true,預設為false(jpql)
         *
         * @param name
         * @param address
         * @return
         */
        @Query(value = "select * from tb_resume  where name like ?1 and address like ?2", nativeQuery = true)
        List<Resume> findBySql(String name, String address);
    
    
        /**
         * 方法命名規則查詢
         * 按照name模糊查詢(like)
         * 方法名以findBy開頭
         * -屬性名(首字母大寫)
         * -查詢方式(模糊查詢、等價查詢),如果不寫查詢方式,預設等價查詢
         */
        List<Resume> findByNameLikeAndAddress(String name, String address);
    
    }
    
  6. 測試方法

    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(locations = {"classpath:applicationContext.xml"})
    public class ResumeDaoTest {
    
    
        // 要測試IOC哪個物件注入即可
        @Autowired
        private ResumeDao resumeDao;
    
    
        /**
         * dao層介面呼叫,分成兩塊:
         * 1、基礎的增刪改查
         * 2、專門針對查詢的詳細分析使用
         */
    
    
        @Test
        public void testFindById() {
            // 早期的版本 dao.findOne(id);
    
            /*
                select resume0_.id as id1_0_0_,
                    resume0_.address as address2_0_0_, resume0_.name as name3_0_0_,
                     resume0_.phone as phone4_0_0_ from tb_resume resume0_ where resume0_.id=?
             */
    
            Optional<Resume> optional = resumeDao.findById(1l);
            Resume resume = optional.get();
            System.out.println(resume);
        }
    
    
        @Test
        public void testFindOne() {
            Resume resume = new Resume();
            resume.setId(1l);
            resume.setName("張三");
            Example<Resume> example = Example.of(resume);
            Optional<Resume> one = resumeDao.findOne(example);
            Resume resume1 = one.get();
            System.out.println(resume1);
        }
    
    
        @Test
        public void testSave() {
            // 新增和更新都使用save方法,通過傳入的物件的主鍵有無來區分,沒有主鍵資訊那就是新增,有主鍵資訊就是更新
            Resume resume = new Resume();
            resume.setId(5l);
            resume.setName("趙六六");
            resume.setAddress("成都");
            resume.setPhone("132000000");
            Resume save = resumeDao.save(resume);
            System.out.println(save);
    
        }
    
    
        @Test
        public void testDelete() {
            resumeDao.deleteById(5l);
        }
    
    
        @Test
        public void testFindAll() {
            List<Resume> list = resumeDao.findAll();
            for (int i = 0; i < list.size(); i++) {
                Resume resume = list.get(i);
                System.out.println(resume);
            }
        }
    
    
        @Test
        public void testSort() {
            Sort sort = new Sort(Sort.Direction.DESC, "id");
            List<Resume> list = resumeDao.findAll(sort);
            for (int i = 0; i < list.size(); i++) {
                Resume resume = list.get(i);
                System.out.println(resume);
            }
        }
    
    
        @Test
        public void testPage() {
            /**
             * 第一個引數:當前查詢的頁數,從0開始
             * 第二個引數:每頁查詢的數量
             */
            Pageable pageable = PageRequest.of(0, 2);
            //Pageable pageable = new PageRequest(0,2);
            Page<Resume> all = resumeDao.findAll(pageable);
            System.out.println(all);
            /*for (int i = 0; i < list.size(); i++) {
                Resume resume =  list.get(i);
                System.out.println(resume);
            }*/
        }
    
    
        /**
         * ========================針對查詢的使用進行分析=======================
         * 方式一:呼叫繼承的介面中的方法  findOne(),findById()
         * 方式二:可以引入jpql(jpa查詢語言)語句進行查詢 (=====>>>> jpql 語句類似於sql,只不過sql操作的是資料表和欄位,jpql操作的是物件和屬性,比如 from Resume where id=xx)  hql
         * 方式三:可以引入原生的sql語句
         * 方式四:可以在介面中自定義方法,而且不必引入jpql或者sql語句,這種方式叫做方法命名規則查詢,也就是說定義的介面方法名是按照一定規則形成的,那麼框架就能夠理解我們的意圖
         * 方式五:動態查詢
         * service層傳入dao層的條件不確定,把service拿到條件封裝成一個物件傳遞給Dao層,這個物件就叫做Specification(對條件的一個封裝)
         * <p>
         * <p>
         * // 根據條件查詢單個物件
         * Optional<T> findOne(@Nullable Specification<T> var1);
         * // 根據條件查詢所有
         * List<T> findAll(@Nullable Specification<T> var1);
         * // 根據條件查詢並進行分頁
         * Page<T> findAll(@Nullable Specification<T> var1, Pageable var2);
         * // 根據條件查詢並進行排序
         * List<T> findAll(@Nullable Specification<T> var1, Sort var2);
         * // 根據條件統計
         * long count(@Nullable Specification<T> var1);
         * <p>
         * interface Specification<T>
         * toPredicate(Root<T> var1, CriteriaQuery<?> var2, CriteriaBuilder var3);用來封裝查詢條件的
         * Root:根屬性(查詢所需要的任何屬性都可以從根物件中獲取)
         * CriteriaQuery 自定義查詢方式 用不上
         * CriteriaBuilder 查詢構造器,封裝了很多的查詢條件(like = 等)
         */
    
    
        @Test
        public void testJpql() {
            List<Resume> list = resumeDao.findByJpql(1l, "張三");
            for (int i = 0; i < list.size(); i++) {
                Resume resume = list.get(i);
                System.out.println(resume);
            }
        }
    
    
        @Test
        public void testSql() {
            List<Resume> list = resumeDao.findBySql("李%", "上海%");
            for (int i = 0; i < list.size(); i++) {
                Resume resume = list.get(i);
                System.out.println(resume);
            }
        }
    
    
        @Test
        public void testMethodName() {
            List<Resume> list = resumeDao.findByNameLikeAndAddress("李%", "上海");
            for (int i = 0; i < list.size(); i++) {
                Resume resume = list.get(i);
                System.out.println(resume);
            }
    
        }
    
    
        // 動態查詢,查詢單個物件
        @Test
        public void testSpecfication() {
    
            /**
             * 動態條件封裝
             * 匿名內部類
             *
             * toPredicate:動態組裝查詢條件
             *
             *      藉助於兩個引數完成條件拼裝,,, select * from tb_resume where name='張三'
             *      Root: 獲取需要查詢的物件屬性
             *      CriteriaBuilder:構建查詢條件,內部封裝了很多查詢條件(模糊查詢,精準查詢)
             *
             *      需求:根據name(指定為"張三")查詢簡歷
             */
    
            Specification<Resume> specification = new Specification<Resume>() {
                @Override
                public Predicate toPredicate(Root<Resume> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
                    // 獲取到name屬性
                    Path<Object> name = root.get("name");
    
                    // 使用CriteriaBuilder針對name屬性構建條件(精準查詢)
                    Predicate predicate = criteriaBuilder.equal(name, "張三");
                    return predicate;
                }
            };
    
    
            Optional<Resume> optional = resumeDao.findOne(specification);
            Resume resume = optional.get();
            System.out.println(resume);
    
        }
    
    
        @Test
        public void testSpecficationMultiCon() {
    
            /**
             *      需求:根據name(指定為"張三")並且,address 以"北"開頭(模糊匹配),查詢簡歷
             */
    
            Specification<Resume> specification = new Specification<Resume>() {
                @Override
                public Predicate toPredicate(Root<Resume> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
                    // 獲取到name屬性
                    Path<Object> name = root.get("name");
                    Path<Object> address = root.get("address");
                    // 條件1:使用CriteriaBuilder針對name屬性構建條件(精準查詢)
                    Predicate predicate1 = criteriaBuilder.equal(name, "張三");
                    // 條件2:address 以"北"開頭(模糊匹配)
                    Predicate predicate2 = criteriaBuilder.like(address.as(String.class), "北%");
    
                    // 組合兩個條件
                    Predicate and = criteriaBuilder.and(predicate1, predicate2);
    
                    return and;
                }
            };
    
    
            Optional<Resume> optional = resumeDao.findOne(specification);
            Resume resume = optional.get();
            System.out.println(resume);
        }
    
    
    }
    
    

Spring Data JPA 執行過程原始碼分析

以下程式碼作為除錯:

    @Test
    public void testFindById() {
        // 早期的版本 dao.findOne(id);

        /*
            select resume0_.id as id1_0_0_,
                resume0_.address as address2_0_0_, resume0_.name as name3_0_0_,
                 resume0_.phone as phone4_0_0_ from tb_resume resume0_ where resume0_.id=?
         */

        Optional<Resume> optional = resumeDao.findById(1l);
        Resume resume = optional.get();
        System.out.println(resume);
    }
  • resumeDao 型別為 org.springframework.data.jpa.repository.support.SimpleJpaRepository
    • org.springframework.data.jpa.repository.support.SimpleJpaRepository#findById
  • BeanDefinition 加入容器
    • org.springframework.data.repository.config.RepositoryBeanDefinitionParser#parse
    • BeanDefinition 型別:org.springframework.data.jpa.repository.support.JpaRepositoryFactoryBean
  • resumeDao 生成時機
    • org.springframework.data.repository.core.support.RepositoryFactorySupport#getRepository

參考資料