Kotlin + SpringBoot + JPA 服務端開發
本篇主要介紹一下 kotlin + springboot的服務端開發環境搭建
1.概述
Kotlin 是一個基於JVM的程式語言, 是IDEA開發工具 jetbrains 公司開發的語言,也被google選為android開發的首選語言, 因為它是完全相容Java的 所以也可以做後端開發 比如整合我們在使用Java的一些技術框架 ,本篇就來簡單介紹一下和SpringBoot的整合
下面我用Gradle init 的方式從頭開始搭建Kotlin 整合SpringBoot環境, 你也可以透過IDEA直接建立 SpringBoot專案裡面選擇Kotlin語言即可, 我這裡不展示了
2.Gradle init 初始化專案
可以透過gradle init 命令初始化專案 按照提示 選擇 kotlin語言 , kotlin dsl 等等..
2.1 外掛配置
需要配置幾個外掛 包括 springboot gradle 外掛
-
org.springframework.boot
Spring Boot 官方提供了
Gradle外掛支援，可以打包程式為可執行的 jar 或 war 包，執行 Spring Boot 應用程式,並且使用spring-boot-dependencies 管理版本 -
io.spring.dependency-management
自動從你正在使用的springbooot版本中匯入spring-boot-dependencies bom
-
kotlin("jvm") : 指定kotlin的版本
-
kotlin("plugin.spring") : 用於在給類新增 open 關鍵字(否則是final的) 僅限於spring的一些註解比如@Controller
@Service ..
-
kotlin("plugin.jpa") : 用於生成kotlin 資料類 無參建構函式,否則會提示Entity缺少預設建構函式
plugins {
// Apply the org.jetbrains.kotlin.jvm Plugin to add support for Kotlin.
// id("org.jetbrains.kotlin.jvm") version "1.7.10"
id("org.springframework.boot") version "2.6.11"
id("io.spring.dependency-management") version "1.0.13.RELEASE"
kotlin("jvm") version "1.6.21"
//引入spring外掛 可以給 一些spring註解的類 新增 open關鍵字 解決kotlin 預設final問題
kotlin("plugin.spring") version "1.6.21"
//引入jpa外掛 主要可以給JPA的一些註解類新增 無參建構函式
kotlin("plugin.jpa") version "1.6.21"
// Apply the application plugin to add support for building a CLI application in Java.
}
java.sourceCompatibility = JavaVersion.VERSION_1_8
configurations {
compileOnly {
extendsFrom(configurations.annotationProcessor.get())
}
}
dependencies {
// Use the Kotlin JUnit 5 integration.
testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
// Use the JUnit 5 integration.
testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.1")
// This dependency is used by the application.
implementation("com.google.guava:guava:31.1-jre")
implementation("org.jetbrains.kotlin:kotlin-reflect")
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
//引入springboot web依賴
implementation("org.springframework.boot:spring-boot-starter-web")
}
tasks.named<Test>("test") {
// Use JUnit Platform for unit tests.
useJUnitPlatform()
}
tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
kotlinOptions {
freeCompilerArgs = listOf("-Xjsr305=strict")
jvmTarget = "1.8"
}
}
2.2 編寫SpringBoot啟動類
直接手動建立一個即可, 內容和 原生Java 差不多 因為新增了 plugin.spring所以不需要新增open關鍵字了
package kotlinspringbootdemo
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication
@SpringBootApplication
class KotlinSpringBootApplication
fun main(args: Array<String>) {
runApplication<KotlinSpringBootApplication>(*args)
}
2.3 編寫Controller
可以看到controller 和 Java 寫法 基本差不多 是不是很像
@RestController
class HelloController {
data class KotlinInfo(val name: String, val desc: String)
@GetMapping("/getKotlin")
fun getKotlinSpringBoot(): KotlinInfo {
return KotlinInfo("kotlin", "kotlin springboot")
}
}
2.4 配置application.yaml
在resources 下面建立一個 application.yaml檔案即可
server:
port: 8899
2.5 測試介面 /getKotlin
可以看到成功返回了資料
3.整合JPA
下面來看看如何整合JPA
3.1 引入jpa外掛
這個外掛的作用是給 @Entity 等JPA的實體 新增 無參構造方法的, 下面是spring官網對這個外掛的解釋
In order to be able to use Kotlin non-nullable properties with JPA, Kotlin JPA plugin is also enabled. It generates no-arg constructors for any class annotated with @Entity, @MappedSuperclass or @Embeddable.
//引入jpa外掛
kotlin("plugin.jpa") version "1.6.21"
3.2 引入jpa 和 mysql
jpa的版本由 dependency-management 外掛管理
//引入JPA
implementation("org.springframework.boot:spring-boot-starter-data-jpa")
//引入 Mysql
implementation("mysql:mysql-connector-java:8.0.30")
3.3 application.yaml 資料庫配置
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/kotlinweb?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false
username: root
password: root123456
3.4 編寫一個Entity
注意哈是 () 構造方法定義的這些屬性 , 這是kotlin的建構函式的寫法
package kotlinspringbootdemo.entity
import javax.persistence.*
/**
* Created on 2022/12/17 21:28.
* @author Johnny
*/
@Entity
@Table(name = "student")
class StudentInfo(
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
val id: Long = 0,
@Column(name = "name")
val name: String,
@Column(name = "email")
val email: String,
@Column(name = "address")
val address: String
)
3.5 student表建立
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;
-- ----------------------------
-- Table structure for student
-- ----------------------------
DROP TABLE IF EXISTS `student`;
CREATE TABLE `student` (
`id` bigint NOT NULL AUTO_INCREMENT,
`name` varchar(255) DEFAULT NULL,
`email` varchar(255) DEFAULT NULL,
`address` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
SET FOREIGN_KEY_CHECKS = 1;
3.6 編寫Repository
jpa需要定義 repository 這是jpa的知識範圍 不多介紹
/**
* @author Johnny
*/
@Repository
interface StudentRepository : JpaRepository<StudentInfo,Long> {
}
3.7 新增一個介面測試
除了lateinit 標註 注入的 屬性 延遲初始化, 其他的和Java 裡面用沒啥區別
@RestController
class HelloController {
//注意是 lateinit 延遲初始化
@Autowired
lateinit var studentRepository: StudentRepository
@GetMapping("/add")
fun addStudent(): StudentInfo {
val studentInfo = StudentInfo(name = "johnny", email = "626242589@qq.com", address = "江蘇無錫")
studentRepository.save(studentInfo)
return studentInfo
}
}
總結
本篇主要介紹 kotlin springboot 和 jpa的環境搭建和基本使用, 可以看到 基本和java的那套沒啥區別
主要是外掛那塊要弄清楚 這些外掛 kotlin spring jpa boot dependency-manager 等等都是幹嘛的
//用法一: 這個外掛 用於在給類新增 open 關鍵字(否則是final的) 僅限於spring的一些註解比如@Controller @Service ..等等.
kotlin("plugin.spring") version "1.6.21"
//用法二
id("org.jetbrains.kotlin.plugin.allopen") version "1.6.21"
allOpen{
//把需要open 註解標註的類新增上來
annotation("org.springframework.boot.autoconfigure.SpringBootApplication")
annotation("org.springframework.web.bind.annotation.RestController")
}
//用法三
id("org.jetbrains.kotlin.plugin.allopen") version "1.6.21"
apply{
plugin("kotlin-spring")
}
//詳細可以看 : https://kotlinlang.org/docs/all-open-plugin.html#spring-support
歡迎大家訪問 個人部落格 Johnny小屋
歡迎關注個人公眾號
