使用Kotlin和Spring Boot构建一个最简单的Web API
简而言之
-
- Kotlin + SpringBootを扱ってみましたので、環境構築メモです。
- Spring Data JPAでテーブルアクセスし、JSON形式でブラウザに返却するところまでを書いております。
创建Spring项目
Spring Initializrを使います。
設定は下記のようにしました。
下载 IntelliJ IDEA
IntelliJ IDEAをダウンロードします。
Community版(無料)で大丈夫です。
导入已创建的项目
- IntelliJ IDEAより [File] -> [Open…] を選択し、作成したプロジェクトを取り込みます。
将JPA注释掉
dependencies {
// implementation("org.springframework.boot:spring-boot-starter-data-jpa")
implementation("org.springframework.boot:spring-boot-starter-web")
implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
implementation("org.jetbrains.kotlin:kotlin-reflect")
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
compileOnly("org.projectlombok:lombok")
annotationProcessor("org.projectlombok:lombok")
testImplementation("org.springframework.boot:spring-boot-starter-test")
}
写一个控制器
-
- Controllerクラスを書きます。
- 事前にcontrollerパッケージを作成しておきます。
package com.example.demo.controller
import org.springframework.http.MediaType
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
@RestController
@RequestMapping("/demo")
class DemoController {
@GetMapping("/getAll")
fun getAll(): ResponseEntity<String> {
return ResponseEntity.ok("Demo")
}
}
启动项目
- [View] -> [Tool Windows] -> [Gradle] -> [Tasks] -> [application] -> [bootRun] を選択してプロジェクトを実行します。
- 下記のようなログが出ればOKです。
18:32:18: Executing task 'bootRun'...
> Task :compileKotlin
> Task :compileJava NO-SOURCE
> Task :processResources UP-TO-DATE
> Task :classes UP-TO-DATE
> Task :bootRunMainClassName
> Task :bootRun
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.4.3)
2021-03-13 18:32:21.905 INFO 8184 --- [ main] com.example.demo.DemoApplicationKt : Starting DemoApplicationKt using Java 1.8.0_241 on DESKTOP-I88K5MF with PID 8184
2021-03-13 18:32:21.905 INFO 8184 --- [ main] com.example.demo.DemoApplicationKt : No active profile set, falling back to default profiles: default
2021-03-13 18:32:23.034 INFO 8184 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http)
2021-03-13 18:32:23.050 INFO 8184 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2021-03-13 18:32:23.050 INFO 8184 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.43]
2021-03-13 18:32:23.128 INFO 8184 --- [ main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2021-03-13 18:32:23.128 INFO 8184 --- [ main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 1155 ms
2021-03-13 18:32:23.425 INFO 8184 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'applicationTaskExecutor'
2021-03-13 18:32:23.662 INFO 8184 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2021-03-13 18:32:23.677 INFO 8184 --- [ main] com.example.demo.DemoApplicationKt : Started DemoApplicationKt in 2.308 seconds (JVM running for 2.822)
2021-03-13 18:32:26.108 INFO 8184 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring DispatcherServlet 'dispatcherServlet'
2021-03-13 18:32:26.108 INFO 8184 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Initializing Servlet 'dispatcherServlet'
2021-03-13 18:32:26.116 INFO 8184 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Completed initialization in 8 ms
- ブラウザでhttp://localhost:8080/demo/getAllを表示する → Demoが表示されます。
为了使用JPA进行数据访问，需要准备Mysql数据库。
- テーブルを作っておきます。
create database demo;
use demo;
create table demo (
id int auto_increment,
name varchar(256),
PRIMARY KEY (id)
);
insert into demo (name) values ("test");
在application.properties中添加配置。
spring.datasource.url=jdbc:mysql://localhost:3306/demo?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.jpa.database=MYSQL
spring.jpa.hibernate.ddl-auto=update
参考：
尝试使用Java连接数据库（MySQL）时出现错误的解决方案
使用SpringBoot + Spring JPA与数据库进行连接
取消JPA的注释，并添加驱动程序。
dependencies {
+ implementation("org.springframework.boot:spring-boot-starter-data-jpa")
implementation("org.springframework.boot:spring-boot-starter-web")
implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
implementation("org.jetbrains.kotlin:kotlin-reflect")
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+ implementation("mysql:mysql-connector-java:8.0.20")
compileOnly("org.projectlombok:lombok")
annotationProcessor("org.projectlombok:lombok")
testImplementation("org.springframework.boot:spring-boot-starter-test")
}
创建实体
-
- 事前にentityパッケージを作成しておきます。
- Demo.ktを書きます。
package com.example.demo.entity
import javax.persistence.Entity
import javax.persistence.GeneratedValue
import javax.persistence.Id
@Entity
class Demo (
var name: String? = null,
@Id
@GeneratedValue
var id: Long? = null)
创建代码库
-
- 事前にrepositoryパッケージを作成しておきます。
- DemoRepository.ktを作成します。
package com.example.demo.repository
import com.example.demo.entity.Demo
import org.springframework.data.repository.CrudRepository
interface DemoRepository : CrudRepository<Demo, Long> {
fun findAllByOrderById(): Iterable<Demo>
}
修改控制器
package com.example.demo.controller
import com.example.demo.entity.Demo
import com.example.demo.repository.DemoRepository
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.http.MediaType
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
@RestController
@RequestMapping("/demo")
class DemoController @Autowired constructor( //修正
val demoRepository: DemoRepository) //修正
{ //修正
@GetMapping("/getAll")
fun getAll(): ResponseEntity<Iterable<Demo>> { //修正
val demos = demoRepository.findAllByOrderById() //修正
return ResponseEntity.ok(demos) //修正
}
}
用浏览器进行显示
-
- ブラウザでhttp://localhost:8080/demo/getAllを表示します
- 下記のようにDBに登録されたデータが返却されていることを確認します。
总结
- kotlin + Spring BootでJSONをGetするところまでやりました。何かの参考になれば幸いです。
参考文献：
使用Spring Data JPA入门
使用Kotlin和Spring Boot 2.0实现简单的Rest API
