devbox
人工智能uu
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Spring Boot 与 Kotlin使用Spring-data-jpa简化数据访问层

作者：人工智能uu | 2024-08-21 01:40:28

赞

踩

kotlin springdatajpa

为什么80%的码农都做不了架构师？>>>   hot3.png

在《Spring Boot 与 Kotlin 使用JdbcTemplate连接MySQL》 中介绍了一种基本的数据访问方式，结合构建RESTful API和使用Thymeleaf模板引擎渲染Web视图的内容就已经可以完成App服务端和Web站点的开发任务了。

然而，在实际开发过程中，对数据库的操作无非就“增删改查”。就最为普遍的单表操作而言，除了表和字段不同外，语句都是类似的，开发人员需要写大量类似而枯燥的语句来完成业务逻辑。

为了解决这些大量枯燥的数据操作语句，我们第一个想到的是使用ORM框架，比如：Hibernate。通过整合Hibernate之后，我们以操作Java实体的方式最终将数据改变映射到数据库表中。

为了解决抽象各个Java实体基本的“增删改查”操作，我们通常会以泛型的方式封装一个模板Dao来进行抽象简化，但是这样依然不是很方便，我们需要针对每个实体编写一个继承自泛型模板Dao的接口，再编写该接口的实现。虽然一些基础的数据访问已经可以得到很好的复用，但是在代码结构上针对每个实体都会有一堆Dao的接口和实现。

由于模板Dao的实现，使得这些具体实体的Dao层已经变的非常“薄”，有一些具体实体的Dao实现可能完全就是对模板Dao的简单代理，并且往往这样的实现类可能会出现在很多实体上。Spring-data-jpa的出现正可以让这样一个已经很“薄”的数据访问层变成只是一层接口的编写方式。比如，下面的例子：

  1. import name.quanke.kotlin.chaper11_6_2.entity.User
  2. import org.springframework.data.jpa.repository.JpaRepository
  3. import org.springframework.data.jpa.repository.Query
  4. import org.springframework.data.repository.query.Param
  5.  
  6.  
  7. /**
  8.  * Created by http://quanke.name on 2018/1/10.
  9.  */
  10.  
  11. interface UserRepository : JpaRepository<User, Long> {
  12.  
  13.     fun findByUsername(username: String): List<User>
  14.     
  15.     @Query("from User u where u.username=:username")
  16.     fun findUser(@Param("username") username: String): User
  17.  
  18. }

只需要通过编写一个继承自JpaRepository的接口就能完成数据访问，下面以一个具体实例来体验Spring-data-jpa给我们带来的强大功能。

由于Spring-data-jpa依赖于Hibernate。如果您对Hibernate有一定了解，下面内容可以毫不费力的看懂并上手使用Spring-data-jpa。如果您还是Hibernate新手，您可以先按如下方式入门，再建议回头学习一下Hibernate以帮助这部分的理解和进一步使用。

工程配置

在build.gradle中添加相关依赖，加入以下内容：

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

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

和kotlin-spring插件一样，kotlin-jpa是一个包含在no-arg之上的插件。 该插件自动指定@Entity，@Embeddable和@MappedSuperclass no-arg注释。

  1. buildscript {
  2.     dependencies {
  3.         classpath "org.jetbrains.kotlin:kotlin-noarg:$kotlin_version"
  4.     }
  5. }
  6.  
  7. apply plugin: "kotlin-jpa"

如果使用的 Gradle plugins DSL

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

完整的build.gradle

  1. group 'name.quanke.kotlin'
  2. version '1.0-SNAPSHOT'
  3.  
  4. buildscript {
  5.     ext.kotlin_version = '1.2.10'
  6.     ext.spring_boot_version = '1.5.4.RELEASE'
  7.     ext.springfox_swagger2_version = '2.7.0'
  8.     ext.mysql_version = '5.1.21'
  9.     repositories {
  10.         mavenCentral()
  11.     }
  12.     dependencies {
  13.         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
  14.         classpath("org.springframework.boot:spring-boot-gradle-plugin:$spring_boot_version")
  15.  
  16. //        Kotlin整合SpringBoot的默认无参构造函数，默认把所有的类设置open类插件
  17.         classpath("org.jetbrains.kotlin:kotlin-noarg:$kotlin_version")
  18.         classpath("org.jetbrains.kotlin:kotlin-allopen:$kotlin_version")
  19.     }
  20. }
  21.  
  22. apply plugin: 'kotlin'
  23. apply plugin: "kotlin-spring" // See https://kotlinlang.org/docs/reference/compiler-plugins.html#kotlin-spring-compiler-plugin
  24. apply plugin: 'org.springframework.boot'
  25. apply plugin: "kotlin-jpa"  //https://stackoverflow.com/questions/32038177/kotlin-with-jpa-default-constructor-hell
  26. jar {
  27.     baseName = 'chapter11-6-2-service'
  28.     version = '0.1.0'
  29. }
  30. repositories {
  31.     mavenCentral()
  32. }
  33.  
  34.  
  35. dependencies {
  36.     compile "org.jetbrains.kotlin:kotlin-stdlib-jre8:$kotlin_version"
  37.     compile("org.jetbrains.kotlin:kotlin-reflect:${kotlin_version}")
  38.  
  39.  
  40.     compile "org.springframework.boot:spring-boot-starter-web:$spring_boot_version"
  41.     compile "org.springframework.boot:spring-boot-starter-data-jpa:$spring_boot_version"
  42.     compile "mysql:mysql-connector-java:$mysql_version"
  43.  
  44.     testCompile "org.springframework.boot:spring-boot-starter-test:$spring_boot_version"
  45.     testCompile "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
  46.  
  47. }
  48.  
  49. compileKotlin {
  50.     kotlinOptions.jvmTarget = "1.8"
  51. }
  52. compileTestKotlin {
  53.     kotlinOptions.jvmTarget = "1.8"
  54. }

在application.yml中配置：数据库连接信息（如使用嵌入式数据库则不需要）、自动创建表结构的设置，例如使用mysql的情况如下：

  1. spring:
  2.   datasource:
  3.     url: jdbc:mysql://localhost:3306/test
  4.     username: root
  5.     password: 123456
  6.     driver-class-name: com.mysql.jdbc.Driver

spring.jpa.properties.hibernate.hbm2ddl.auto是hibernate的配置属性，其主要作用是：自动创建、更新、验证数据库表结构。该参数的几种配置如下：

  • create：每次加载hibernate时都会删除上一次的生成的表，然后根据你的model类再重新来生成新表，哪怕两次没有任何改变也要这样执行，这就是导致数据库表数据丢失的一个重要原因。
  • create-drop：每次加载hibernate时根据model类生成表，但是sessionFactory一关闭,表就自动删除。
  • update：最常用的属性，第一次加载hibernate时根据model类会自动建立起表的结构（前提是先建立好数据库），以后加载hibernate时根据model类自动更新表结构，即使表结构改变了但表中的行仍然存在不会删除以前的行。要注意的是当部署到服务器后，表结构是不会被马上建立起来的，是要等应用第一次运行起来后才会。
  • validate：每次加载hibernate时，验证创建数据库表结构，只会和数据库中的表进行比较，不会创建新表，但是会插入新值。 至此已经完成基础配置，如果您有在Spring下整合使用过它的话，相信你已经感受到Spring Boot的便利之处：JPA的传统配置在persistence.xml文件中，但是这里我们不需要。当然，最好在构建项目时候按照之前提过的最佳实践的工程结构来组织，这样以确保各种配置都能被框架扫描到。

创建实体

创建一个User实体，包含id（主键）、username（姓名）、password（密码）属性，通过ORM框架其会被映射到数据库表中，由于配置了hibernate.hbm2ddl.auto，在应用启动的时候框架会自动去数据库中创建对应的表。

  1. import javax.persistence.*
  2.  
  3. /**
  4.  * Created by http://quanke.name on 2018/1/10.
  5.  */
  6.  
  7. @Entity
  8. data class User(
  9.         @Id
  10.         @GeneratedValue(strategy = GenerationType.AUTO)
  11.         var id: Long = -1,
  12.         @Column(nullable = false)
  13.         var username: String = "",
  14.  
  15.         var password: String = ""
  16. )

创建数据访问接口

下面针对User实体创建对应的Repository接口实现对该实体的数据访问，如下代码：

  1.  
  2. import name.quanke.kotlin.chaper11_6_2.entity.User
  3. import org.springframework.data.jpa.repository.JpaRepository
  4. import org.springframework.data.jpa.repository.Query
  5. import org.springframework.data.repository.query.Param
  6.  
  7.  
  8. /**
  9.  * Created by http://quanke.name on 2018/1/10.
  10.  */
  11.  
  12. interface UserRepository : JpaRepository<User, Long> {
  13.  
  14.     fun findByUsername(username: String): List<User>
  15.  
  16.     fun findByUsernameAndPassword(username: String, password: String?): User
  17.  
  18.     @Query("from User u where u.username=:username")
  19.     fun findUser(@Param("username") username: String): User
  20.  
  21. }

在Spring-data-jpa中，只需要编写类似上面这样的接口就可实现数据访问。不再像我们以往编写了接口时候还需要自己编写接口实现类，直接减少了我们的文件清单。

下面对上面的UserRepository做一些解释，该接口继承自JpaRepository，通过查看JpaRepository接口的API文档，可以看到该接口本身已经实现了创建（save）、更新（save）、删除（delete）、查询（findAll、findOne）等基本操作的函数，因此对于这些基础操作的数据访问就不需要开发者再自己定义。

在我们实际开发中，JpaRepository接口定义的接口往往还不够或者性能不够优化，我们需要进一步实现更复杂一些的查询或操作。由于本文重点在spring boot中整合spring-data-jpa，在这里先抛砖引玉简单介绍一下spring-data-jpa中让我们兴奋的功能，后续再单独开篇讲一下spring-data-jpa中的常见使用。

在上例中，我们可以看到下面两个函数：

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

它们分别实现了按name查询User实体和按name和age查询User实体，可以看到我们这里没有任何类SQL语句就完成了两个条件查询方法。这就是Spring-data-jpa的一大特性：通过解析方法名创建查询。

除了通过解析方法名来创建查询外，它也提供通过使用@Query 注解来创建查询，您只需要编写JPQL语句，并通过类似“:name”来映射@Param指定的参数，就像例子中的第三个findUser函数一样。

Spring-data-jpa的能力远不止本文提到的这些，由于本文主要以整合介绍为主，对于Spring-data-jpa的使用只是介绍了常见的使用方式。诸如@Modifying操作、分页排序、原生SQL支持以及与Spring MVC的结合使用等等内容就不在本文中详细展开，这里先挖个坑，后续再补文章填坑，如您对这些感兴趣可以关注我博客或简书，同样欢迎大家留言交流想法。

单元测试

在完成了上面的数据访问接口之后，按照惯例就是编写对应的单元测试来验证编写的内容是否正确。这里就不多做介绍，主要通过数据操作和查询来反复验证操作的正确性。

  1.  
  2. import name.quanke.kotlin.chaper11_6_2.entity.User
  3. import name.quanke.kotlin.chaper11_6_2.repository.UserRepository
  4. import org.apache.commons.logging.LogFactory
  5. import org.junit.Test
  6. import org.junit.runner.RunWith
  7. import org.springframework.beans.factory.annotation.Autowired
  8. import org.springframework.boot.test.context.SpringBootTest
  9. import org.springframework.test.context.junit4.SpringRunner
  10.  
  11. /**
  12.  * Created by http://quanke.name on 2018/1/9.
  13.  */
  14. @RunWith(SpringRunner::class)
  15. @SpringBootTest
  16. class ApplicationTests {
  17.  
  18.     val log = LogFactory.getLog(ApplicationTests::class.java)!!
  19.  
  20.     @Autowired
  21.     lateinit var userRepository: UserRepository
  22.  
  23.     @Test
  24.     fun `jpa test"`() {
  25.  
  26. //        val username = "quanke"
  27. //        val password = "123456"
  28.  
  29.         val user = User()
  30.  
  31.         user.username = "quanke.name"
  32.         user.password = "12"
  33.         userRepository.save(user)
  34.  
  35.         log.info("总共用户: ${userRepository.count()}")
  36.  
  37.         log.info("名字为quanke的用户: ${userRepository.findByUsername("quanke.name")}")
  38.  
  39.  
  40.     }
  41.

更多Spring Boot 和 kotlin相关内容

欢迎关注《Spring Boot 与 kotlin 实战》

参考

全科龙婷

转载于:https://my.oschina.net/quanke/blog/1611469

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/人工智能uu/article/detail/1009326
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号