Spring Boot 與 Kotlin使用Spring-data-jpa簡(jiǎn)化數(shù)據(jù)訪問層

在《Spring Boot 與 Kotlin 使用JdbcTemplate連接MySQL》 中介紹了一種基本的數(shù)據(jù)訪問方式，結(jié)合構(gòu)建RESTful API和使用Thymeleaf模板引擎渲染W(wǎng)eb視圖的內(nèi)容就已經(jīng)可以完成App服務(wù)端和Web站點(diǎn)的開發(fā)任務(wù)了。

然而，在實(shí)際開發(fā)過程中，對(duì)數(shù)據(jù)庫的操作無非就“增刪改查”。就最為普遍的單表操作而言，除了表和字段不同外，語句都是類似的，開發(fā)人員需要寫大量類似而枯燥的語句來完成業(yè)務(wù)邏輯。

為了解決這些大量枯燥的數(shù)據(jù)操作語句，我們第一個(gè)想到的是使用ORM框架，比如：Hibernate。通過整合Hibernate之后，我們以操作Java實(shí)體的方式最終將數(shù)據(jù)改變映射到數(shù)據(jù)庫表中。

為了解決抽象各個(gè)Java實(shí)體基本的“增刪改查”操作，我們通常會(huì)以泛型的方式封裝一個(gè)模板Dao來進(jìn)行抽象簡(jiǎn)化，但是這樣依然不是很方便，我們需要針對(duì)每個(gè)實(shí)體編寫一個(gè)繼承自泛型模板Dao的接口，再編寫該接口的實(shí)現(xiàn)。雖然一些基礎(chǔ)的數(shù)據(jù)訪問已經(jīng)可以得到很好的復(fù)用，但是在代碼結(jié)構(gòu)上針對(duì)每個(gè)實(shí)體都會(huì)有一堆Dao的接口和實(shí)現(xiàn)。

由于模板Dao的實(shí)現(xiàn)，使得這些具體實(shí)體的Dao層已經(jīng)變的非常“薄”，有一些具體實(shí)體的Dao實(shí)現(xiàn)可能完全就是對(duì)模板Dao的簡(jiǎn)單代理，并且往往這樣的實(shí)現(xiàn)類可能會(huì)出現(xiàn)在很多實(shí)體上。Spring-data-jpa的出現(xiàn)正可以讓這樣一個(gè)已經(jīng)很“薄”的數(shù)據(jù)訪問層變成只是一層接口的編寫方式。比如，下面的例子：

import name.quanke.kotlin.chaper11_6_2.entity.User
import org.springframework.data.jpa.repository.JpaRepository
import org.springframework.data.jpa.repository.Query
import org.springframework.data.repository.query.Param


/**
 * Created by http://quanke.name on 2018/1/10.
 */

interface UserRepository : JpaRepository<User, Long> {

    fun findByUsername(username: String): List<User>
    
    @Query("from User u where u.username=:username")
    fun findUser(@Param("username") username: String): User

}

只需要通過編寫一個(gè)繼承自JpaRepository的接口就能完成數(shù)據(jù)訪問，下面以一個(gè)具體實(shí)例來體驗(yàn)Spring-data-jpa給我們帶來的強(qiáng)大功能。

由于Spring-data-jpa依賴于Hibernate。如果您對(duì)Hibernate有一定了解，下面內(nèi)容可以毫不費(fèi)力的看懂并上手使用Spring-data-jpa。如果您還是Hibernate新手，您可以先按如下方式入門，再建議回頭學(xué)習(xí)一下Hibernate以幫助這部分的理解和進(jìn)一步使用。

工程配置

在build.gradle中添加相關(guān)依賴，加入以下內(nèi)容：

compile "org.springframework.boot:spring-boot-starter-data-jpa:$spring_boot_version"

如果使用jpa必須增加kotlin-jpa插件

和kotlin-spring插件一樣，kotlin-jpa是一個(gè)包含在no-arg之上的插件。 該插件自動(dòng)指定@Entity，@Embeddable和@MappedSuperclass no-arg注釋。

buildscript {
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-noarg:$kotlin_version"
    }
}

apply plugin: "kotlin-jpa"

如果使用的 Gradle plugins DSL

plugins {
  id "org.jetbrains.kotlin.plugin.jpa" version "1.2.20"
}

完整的build.gradle

group 'name.quanke.kotlin'
version '1.0-SNAPSHOT'

buildscript {
    ext.kotlin_version = '1.2.10'
    ext.spring_boot_version = '1.5.4.RELEASE'
    ext.springfox_swagger2_version = '2.7.0'
    ext.mysql_version = '5.1.21'
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath("org.springframework.boot:spring-boot-gradle-plugin:$spring_boot_version")

//        Kotlin整合SpringBoot的默認(rèn)無參構(gòu)造函數(shù)，默認(rèn)把所有的類設(shè)置open類插件
        classpath("org.jetbrains.kotlin:kotlin-noarg:$kotlin_version")
        classpath("org.jetbrains.kotlin:kotlin-allopen:$kotlin_version")
    }
}

apply plugin: 'kotlin'
apply plugin: "kotlin-spring" // See https://kotlinlang.org/docs/reference/compiler-plugins.html#kotlin-spring-compiler-plugin
apply plugin: 'org.springframework.boot'
apply plugin: "kotlin-jpa"  //https://stackoverflow.com/questions/32038177/kotlin-with-jpa-default-constructor-hell
jar {
    baseName = 'chapter11-6-2-service'
    version = '0.1.0'
}
repositories {
    mavenCentral()
}


dependencies {
    compile "org.jetbrains.kotlin:kotlin-stdlib-jre8:$kotlin_version"
    compile("org.jetbrains.kotlin:kotlin-reflect:${kotlin_version}")


    compile "org.springframework.boot:spring-boot-starter-web:$spring_boot_version"
    compile "org.springframework.boot:spring-boot-starter-data-jpa:$spring_boot_version"
    compile "mysql:mysql-connector-java:$mysql_version"

    testCompile "org.springframework.boot:spring-boot-starter-test:$spring_boot_version"
    testCompile "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"

}

compileKotlin {
    kotlinOptions.jvmTarget = "1.8"
}
compileTestKotlin {
    kotlinOptions.jvmTarget = "1.8"
}

在application.yml中配置：數(shù)據(jù)庫連接信息（如使用嵌入式數(shù)據(jù)庫則不需要）、自動(dòng)創(chuàng)建表結(jié)構(gòu)的設(shè)置，例如使用mysql的情況如下：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver

spring.jpa.properties.hibernate.hbm2ddl.auto是hibernate的配置屬性，其主要作用是：自動(dòng)創(chuàng)建、更新、驗(yàn)證數(shù)據(jù)庫表結(jié)構(gòu)。該參數(shù)的幾種配置如下：

  • create：每次加載hibernate時(shí)都會(huì)刪除上一次的生成的表，然后根據(jù)你的model類再重新來生成新表，哪怕兩次沒有任何改變也要這樣執(zhí)行，這就是導(dǎo)致數(shù)據(jù)庫表數(shù)據(jù)丟失的一個(gè)重要原因。
  • create-drop：每次加載hibernate時(shí)根據(jù)model類生成表，但是sessionFactory一關(guān)閉,表就自動(dòng)刪除。
  • update：最常用的屬性，第一次加載hibernate時(shí)根據(jù)model類會(huì)自動(dòng)建立起表的結(jié)構(gòu)（前提是先建立好數(shù)據(jù)庫），以后加載hibernate時(shí)根據(jù)model類自動(dòng)更新表結(jié)構(gòu)，即使表結(jié)構(gòu)改變了但表中的行仍然存在不會(huì)刪除以前的行。要注意的是當(dāng)部署到服務(wù)器后，表結(jié)構(gòu)是不會(huì)被馬上建立起來的，是要等應(yīng)用第一次運(yùn)行起來后才會(huì)。
  • validate：每次加載hibernate時(shí)，驗(yàn)證創(chuàng)建數(shù)據(jù)庫表結(jié)構(gòu)，只會(huì)和數(shù)據(jù)庫中的表進(jìn)行比較，不會(huì)創(chuàng)建新表，但是會(huì)插入新值。
    至此已經(jīng)完成基礎(chǔ)配置，如果您有在Spring下整合使用過它的話，相信你已經(jīng)感受到Spring Boot的便利之處：JPA的傳統(tǒng)配置在persistence.xml文件中，但是這里我們不需要。當(dāng)然，最好在構(gòu)建項(xiàng)目時(shí)候按照之前提過的最佳實(shí)踐的工程結(jié)構(gòu)來組織，這樣以確保各種配置都能被框架掃描到。

創(chuàng)建實(shí)體

創(chuàng)建一個(gè)User實(shí)體，包含id（主鍵）、username（姓名）、password（密碼）屬性，通過ORM框架其會(huì)被映射到數(shù)據(jù)庫表中，由于配置了hibernate.hbm2ddl.auto，在應(yīng)用啟動(dòng)的時(shí)候框架會(huì)自動(dòng)去數(shù)據(jù)庫中創(chuàng)建對(duì)應(yīng)的表。

import javax.persistence.*

/**
 * Created by http://quanke.name on 2018/1/10.
 */

@Entity
data class User(
        @Id
        @GeneratedValue(strategy = GenerationType.AUTO)
        var id: Long = -1,
        @Column(nullable = false)
        var username: String = "",

        var password: String = ""
)

創(chuàng)建數(shù)據(jù)訪問接口

下面針對(duì)User實(shí)體創(chuàng)建對(duì)應(yīng)的Repository接口實(shí)現(xiàn)對(duì)該實(shí)體的數(shù)據(jù)訪問，如下代碼：


import name.quanke.kotlin.chaper11_6_2.entity.User
import org.springframework.data.jpa.repository.JpaRepository
import org.springframework.data.jpa.repository.Query
import org.springframework.data.repository.query.Param


/**
 * Created by http://quanke.name on 2018/1/10.
 */

interface UserRepository : JpaRepository<User, Long> {

    fun findByUsername(username: String): List<User>

    fun findByUsernameAndPassword(username: String, password: String?): User

    @Query("from User u where u.username=:username")
    fun findUser(@Param("username") username: String): User

}

在Spring-data-jpa中，只需要編寫類似上面這樣的接口就可實(shí)現(xiàn)數(shù)據(jù)訪問。不再像我們以往編寫了接口時(shí)候還需要自己編寫接口實(shí)現(xiàn)類，直接減少了我們的文件清單。

下面對(duì)上面的UserRepository做一些解釋，該接口繼承自JpaRepository，通過查看JpaRepository接口的API文檔，可以看到該接口本身已經(jīng)實(shí)現(xiàn)了創(chuàng)建（save）、更新（save）、刪除（delete）、查詢（findAll、findOne）等基本操作的函數(shù)，因此對(duì)于這些基礎(chǔ)操作的數(shù)據(jù)訪問就不需要開發(fā)者再自己定義。

在我們實(shí)際開發(fā)中，JpaRepository接口定義的接口往往還不夠或者性能不夠優(yōu)化，我們需要進(jìn)一步實(shí)現(xiàn)更復(fù)雜一些的查詢或操作。由于本文重點(diǎn)在spring boot中整合spring-data-jpa，在這里先拋磚引玉簡(jiǎn)單介紹一下spring-data-jpa中讓我們興奮的功能，后續(xù)再單獨(dú)開篇講一下spring-data-jpa中的常見使用。

在上例中，我們可以看到下面兩個(gè)函數(shù)：

  • fun findByName(name:String ):User
  • fun findByNameAndAge(name:String , age:Int ):User

它們分別實(shí)現(xiàn)了按name查詢User實(shí)體和按name和age查詢User實(shí)體，可以看到我們這里沒有任何類SQL語句就完成了兩個(gè)條件查詢方法。這就是Spring-data-jpa的一大特性：通過解析方法名創(chuàng)建查詢。

除了通過解析方法名來創(chuàng)建查詢外，它也提供通過使用@Query 注解來創(chuàng)建查詢，您只需要編寫JPQL語句，并通過類似“:name”來映射@Param指定的參數(shù)，就像例子中的第三個(gè)findUser函數(shù)一樣。

Spring-data-jpa的能力遠(yuǎn)不止本文提到的這些，由于本文主要以整合介紹為主，對(duì)于Spring-data-jpa的使用只是介紹了常見的使用方式。諸如@Modifying操作、分頁排序、原生SQL支持以及與Spring MVC的結(jié)合使用等等內(nèi)容就不在本文中詳細(xì)展開，這里先挖個(gè)坑，后續(xù)再補(bǔ)文章填坑，如您對(duì)這些感興趣可以關(guān)注我博客或簡(jiǎn)書，同樣歡迎大家留言交流想法。

單元測(cè)試

在完成了上面的數(shù)據(jù)訪問接口之后，按照慣例就是編寫對(duì)應(yīng)的單元測(cè)試來驗(yàn)證編寫的內(nèi)容是否正確。這里就不多做介紹，主要通過數(shù)據(jù)操作和查詢來反復(fù)驗(yàn)證操作的正確性。


import name.quanke.kotlin.chaper11_6_2.entity.User
import name.quanke.kotlin.chaper11_6_2.repository.UserRepository
import org.apache.commons.logging.LogFactory
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.test.context.junit4.SpringRunner

/**
 * Created by http://quanke.name on 2018/1/9.
 */
@RunWith(SpringRunner::class)
@SpringBootTest
class ApplicationTests {

    val log = LogFactory.getLog(ApplicationTests::class.java)!!

    @Autowired
    lateinit var userRepository: UserRepository

    @Test
    fun `jpa test"`() {

//        val username = "quanke"
//        val password = "123456"

        val user = User()

        user.username = "quanke.name"
        user.password = "12"
        userRepository.save(user)

        log.info("總共用戶: ${userRepository.count()}")

        log.info("名字為quanke的用戶: ${userRepository.findByUsername("quanke.name")}")


    }

更多Spring Boot 和 kotlin相關(guān)內(nèi)容

歡迎關(guān)注《Spring Boot 與 kotlin 實(shí)戰(zhàn)》

參考

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容