Springboot 系列（十）使用 Spring data jpa 訪問數據庫

前言

Springboot data jpa 和 Spring jdbc 同屬於 Spring開源組織，在 Spring jdbc 以後又開發了持久層框架，很明顯 Spring data jpa 相對於 Spring jdbc 更加的便捷強大，否則也就沒有開發的必要了。根據下面的文章開始體驗下 Spring data jpa 魅力。

1. Spring data jpa 介紹

Spring data jpa 是 Spring data 系列的一部分，使用它能夠輕鬆的實現對數據訪問層的加強支持，在至關長的一段時間內，實現應用程序的數據訪問層一直很麻煩，須要編寫大量的樣板式的代碼來執行簡單查詢或者分頁操做。Spring data jpa 的目標是儘可能的減小實際編碼來改善數據訪問層的操做。

2. Spring data jpa 依賴

此次的實驗基於系列文章第九篇實驗代碼，代碼中的數據源相關的配置也能夠參考系列文章第九篇，這裏只演示 Spring data jpa 部分。

建立Spring boot 項目，引入須要的依賴。

<dependencies>
        <!-- Spring Boot web 開發整合 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-json</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- 阿里 fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.47</version>
        </dependency>

        <!-- Lombok 工具 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!-- 導入配置文件處理器，在配置springboot相關文件時候會有提示 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

        <!-- 單元測試 -->
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>RELEASE</version>
            <scope>compile</scope>
        </dependency>

        <!-- 數據庫訪問 JPA-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <!--添加數據庫連接 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!-- 阿里 druid 數據源，Spring boot 中使用Druid要用這個 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>
    </dependencies>
複製代碼

3. Spring data jpa 配置

關於 Druid 數據源的配置再也不說明，能夠參考系列文章第九篇。

############################################################
# 服務啓動端口號
server.port=8080
spring.profiles.active=dev
############################################################
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/springboot?characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name= com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123
# 使用 druid 數據源
spring.datasource.type: com.alibaba.druid.pool.DruidDataSource
spring.datasource.initialSize: 5
spring.datasource.minIdle: 5
spring.datasource.maxActive: 20
spring.datasource.maxWait: 60000
spring.datasource.timeBetweenEvictionRunsMillis: 60000
spring.datasource.minEvictableIdleTimeMillis: 300000
spring.datasource.validationQuery: SELECT 1 FROM DUAL
spring.datasource.testWhileIdle: true
spring.datasource.testOnBorrow: false
spring.datasource.testOnReturn: false
spring.datasource.poolPreparedStatements: true
spring.datasource.filters: stat
spring.datasource.maxPoolPreparedStatementPerConnectionSize: 20
spring.datasource.useGlobalDataSourceStat: true
spring.datasource.connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
# SpringBoot JPA
spring.jpa.show-sql=true
# create 每次都從新建立表，update，表若存在則不重建
spring.jpa.hibernate.ddl-auto=update
spring.jpa.database-platform=org.hibernate.dialect.MySQL55Dialect
複製代碼

spring.jpa.show-sql=true 打印 SQL 語句。
spring.jpa.hibernate.ddl-auto=update 根據 Enity 自動建立數據表，Update 表示若是表存在則不從新建立。

4. Spring data jpa 編碼

Springboot Data JPA 是 ORM 的完整實現，實體類和數據表關係一一對應，所以實體類也就是數據表結構。spring.jpa.hibernate.ddl-auto=update 會在 JPA 運行時自動在數據表中建立被 @Entity 註解的實體數據表。若是表已經存在，則不會建立。

4.1. 數據實體類

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.format.annotation.DateTimeFormat;

import javax.persistence.*;
import javax.validation.constraints.NotNull;
import java.util.Date;

/** * <p> * * @Entity JPA實體 * @Data GET SET TOSTRING * @NoArgsConstructor 無參構造 * @AllArgsConstructor 全參構造 * @Author niujinpeng * @Date 2018/12/19 17:13 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Entity
@Table(name = "user")
public class User {

    /** * 用戶ID * * @Id 主鍵 * @GeneratedValue 自增主鍵 */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    /** * 用戶名 */
    @Column(name = "username", length = 32, nullable = false)
    @NotNull(message = "用戶名不能爲空")
    private String username;
    /** * 密碼 */
    @Column(name = "password", length = 32, nullable = false)
    @NotNull(message = "密碼不能爲空")
    private String password;
    /** * 年齡 */
    @Column(name = "age", length = 3)
    private Integer age;
    /** * 生日 */
    @DateTimeFormat(pattern = "yyyy-MM-dd hh:mm:ss")
    private Date birthday;
    /** * 技能 */
    private String skills;
}
複製代碼

4.2. JPA 操做接口

JPA 操做接口只須要繼承 JpaRepository 就能夠了，JpaRepository 裏封裝了經常使用的增刪改查分頁等方法，能夠直接使用，若是須要自定義查詢方式，能夠經過構造方法名的方式增長。下面增長了一個根據 username 和 password 查詢 User 信息的方法。

package net.codingme.boot.domain.repository;

import net.codingme.boot.domain.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

/** * <p> * * @Author niujinpeng * @Date 2019/1/1114:26 */
@Repository
public interface UserRepository extends JpaRepository<User, Integer> {
     /** * 一個自定義方法，根據 username 和 password 查詢 User 信息 */
    User findByUsernameAndPassword(String username, String password);
}
複製代碼

到這裏，Jpa 的功能已經能夠測試使用了，關於 Service 層和 Controller 就不在這裏貼了，直接編寫 Springboot 單元測試進行 Jpa 測試。

5. Spring data jpa 測試

使用 Springboot 的單元測試方法能夠方便的測試 Springboot 項目，對 Springboot 單元測試不瞭解的能夠直接參照官方文檔的說明，固然，也能夠直接看下面的示例代碼。
下面編寫四個測試方法分別測試根據 Id 查詢、分頁查詢、更新數據、根據 username 和 password 查詢四個功能。

package net.codingme.boot.domain.repository;

import net.codingme.boot.domain.User;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.List;
import java.util.Optional;

/** * 單元測試 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserRepositoryTest {

    @Autowired
    private UserRepository userRepository;

    /** * id查詢 */
    @Test
    public void findByIdUserTest() {
        Optional<User> userOptional = userRepository.findById(1);
        User user = userOptional.orElseGet(null);
        System.out.println(user);
        Assert.assertNotNull(user);
    }

    /** * 分頁查詢 */
    @Test
    public void findByPageTest() {
        PageRequest pageRequest = PageRequest.of(0, 2);
        Page<User> userPage = userRepository.findAll(pageRequest);
        List<User> userList = userPage.getContent();
        userList.forEach((user) -> System.out.println(user));
        Assert.assertNotNull(userList);
    }

    /** * 更新 */
    @Test
    public void updateUserTest() {
        Optional<User> userOptional = userRepository.findById(1);
        User user = userOptional.orElseThrow(() -> new RuntimeException("用戶信息沒有取到"));
        System.out.println(user.getAge());
        ;
        user.setAge(user.getAge() + 1);
        User updateResult = userRepository.save(user);
        Assert.assertNotNull(updateResult);
    }

    /** * 根據 Username 和 Password 查詢 */
    @Test
    public void findByUsernameAndPasswordTest() {
        User user = userRepository.findByUsernameAndPassword("Darcy", "123");
        System.out.println(user);
        Assert.assertNotNull(user);
    }
}
複製代碼

首先看到四個方法所有運行經過。

分頁查詢查出數據庫中的兩條數據。

Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.birthday as birthday3_0_, user0_.password as password4_0_, user0_.skills as skills5_0_, user0_.username as username6_0_ from user user0_ limit ?
Hibernate: select count(user0_.id) as col_0_0_ from user user0_
User(id=1, username=Darcy, password=123, age=18, birthday=2019-01-12 21:02:30.0, skills=Go)
User(id=3, username=Chris, password=456, age=23, birthday=2019-01-01 00:11:22.0, skills=Java)
複製代碼

根據 Id 查詢也沒有問題。

Hibernate: select user0_.id as id1_0_0_, user0_.age as age2_0_0_, user0_.birthday as birthday3_0_0_, user0_.password as password4_0_0_, user0_.skills as skills5_0_0_, user0_.username as username6_0_0_ from user user0_ where user0_.id=?
User(id=1, username=Darcy, password=123, age=18, birthday=2019-01-12 21:02:30.0, skills=Go)
複製代碼

更新操做也是正常輸出 SQL ，沒有任何異常。

Hibernate: select user0_.id as id1_0_0_, user0_.age as age2_0_0_, user0_.birthday as birthday3_0_0_, user0_.password as password4_0_0_, user0_.skills as skills5_0_0_, user0_.username as username6_0_0_ from user user0_ where user0_.id=?
18
Hibernate: select user0_.id as id1_0_0_, user0_.age as age2_0_0_, user0_.birthday as birthday3_0_0_, user0_.password as password4_0_0_, user0_.skills as skills5_0_0_, user0_.username as username6_0_0_ from user user0_ where user0_.id=?
Hibernate: update user set age=?, birthday=?, password=?, skills=?, username=? where id=?
複製代碼

最後一個是自定義查詢操做，上面三個方法的輸出中，Darcy 用戶對應的年齡是 18，在通過更新加1 以後應該變爲19，下面是自定義查詢的結果。

Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.birthday as birthday3_0_, user0_.password as password4_0_, user0_.skills as skills5_0_, user0_.username as username6_0_ from user user0_ where user0_.username=? and user0_.password=?
User(id=1, username=Darcy, password=123, age=19, birthday=2019-01-12 21:02:30.0, skills=Go)
複製代碼

可見是沒有任何問題的。
文章代碼已經上傳到 GitHub。
測試代碼中使用了一些 JDK8 的特性，如 Optional 類的使用，之後會單獨寫一部分關於 JDK 新特性的文章，歡迎掃碼關注公衆號。

<完>
我的網站：www.codingme.net
若是你喜歡這篇文章，能夠關注公衆號，一塊兒成長。