Spring Data CrudRepository를 사용하여 데이터베이스 접근하기

이 문서는 Spring Boot와 Kotlin 시작하기 튜토리얼의 마지막 부분입니다. 진행하기 전에 이전 단계를 완료했는지 확인하세요:

Kotlin으로 Spring Boot 프로젝트 생성하기
Spring Boot 프로젝트에 데이터 클래스 추가하기
Spring Boot 프로젝트에 데이터베이스 지원 추가하기
Spring Data CrudRepository를 사용하여 데이터베이스 접근하기

이 부분에서는 JdbcTemplate 대신 Spring Data의 CrudRepository를 사용하여 데이터베이스에 접근하도록 서비스 레이어를 마이그레이션할 것입니다. CrudRepository는 특정 타입의 리포지토리에 대한 일반적인 CRUD 작업을 위한 Spring Data 인터페이스입니다. 이는 데이터베이스와 상호 작용하기 위한 여러 메서드를 기본으로 제공합니다.

애플리케이션 업데이트하기

먼저, CrudRepository API와 함께 작동하도록 Message 클래스를 조정해야 합니다:

1. Message 클래스에 @Table 애너테이션을 추가하여 데이터베이스 테이블에 매핑을 선언합니다. id 필드 앞에 @Id 애너테이션을 추가하세요.

   NOTE

   이 애너테이션들은 추가적인 임포트도 필요합니다.

   // Message.kt
   package com.example.demo
   
   import org.springframework.data.annotation.Id
   import org.springframework.data.relational.core.mapping.Table
   
   @Table("MESSAGES")
   data class Message(@Id val id: String?, val text: String)

   또한, Message 클래스의 사용을 더 관용적으로 만들려면, id 프로퍼티의 기본값을 null로 설정하고 데이터 클래스 프로퍼티의 순서를 바꿀 수 있습니다:

   @Table("MESSAGES")
   data class Message(val text: String, @Id val id: String? = null)

   이제 Message 클래스의 새 인스턴스를 생성해야 하는 경우, text 프로퍼티만 매개변수로 지정할 수 있습니다:

   val message = Message("Hello") // id is null

2. Message 데이터 클래스와 함께 작동할 CrudRepository 인터페이스를 선언합니다. MessageRepository.kt 파일을 생성하고 다음 코드를 추가하세요:

   // MessageRepository.kt
   package com.example.demo
   
   import org.springframework.data.repository.CrudRepository
   
   interface MessageRepository : CrudRepository<Message, String>

3. MessageService 클래스를 업데이트합니다. 이제 SQL 쿼리를 실행하는 대신 MessageRepository를 사용할 것입니다:

   // MessageService.kt
   package com.example.demo
   
   import org.springframework.data.repository.findByIdOrNull
   import org.springframework.stereotype.Service
   
   @Service
   class MessageService(private val db: MessageRepository) {
       fun findMessages(): List<Message> = db.findAll().toList()
   
       fun findMessageById(id: String): Message? = db.findByIdOrNull(id)
   
       fun save(message: Message): Message = db.save(message)
   }

   확장 함수

   findByIdOrNull() 함수는 Spring Data JDBC의 CrudRepository 인터페이스를 위한 확장 함수입니다.

   CrudRepository save() 함수

   이 함수는 새 객체가 데이터베이스에 ID를 가지고 있지 않다는 가정하에 작동합니다. 따라서 삽입 시 ID는 null이어야 합니다.

   ID가 null이 아닌 경우, CrudRepository는 객체가 이미 데이터베이스에 존재한다고 가정하며 이는 insert 작업이 아니라 update 작업입니다. insert 작업 후, id는 데이터 저장소에 의해 생성되어 Message 인스턴스에 다시 할당됩니다. 이것이 id 프로퍼티가 var 키워드를 사용하여 선언되어야 하는 이유입니다.

4. 삽입된 객체에 대한 ID를 생성하도록 메시지 테이블 정의를 업데이트합니다. id가 문자열이므로, 기본적으로 RANDOM_UUID() 함수를 사용하여 ID 값을 생성할 수 있습니다:

   -- schema.sql 
   CREATE TABLE IF NOT EXISTS messages (
       id      VARCHAR(60)  DEFAULT RANDOM_UUID() PRIMARY KEY,
       text    VARCHAR      NOT NULL
   );

5. src/main/resources 폴더에 있는 application.properties 파일에서 데이터베이스 이름을 업데이트합니다:

spring.application.name=demo
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:file:./data/testdb2
spring.datasource.username=name
spring.datasource.password=password
spring.sql.init.schema-locations=classpath:schema.sql
spring.sql.init.mode=always

다음은 애플리케이션의 전체 코드입니다:

// DemoApplication.kt
package com.example.demo

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class DemoApplication

fun main(args: Array<String>) {
    runApplication<DemoApplication>(*args)
}

// Message.kt
package com.example.demo

import org.springframework.data.annotation.Id
import org.springframework.data.relational.core.mapping.Table

@Table("MESSAGES")
data class Message(val text: String, @Id val id: String? = null)

// MessageRepository.kt
package com.example.demo

import org.springframework.data.repository.CrudRepository

interface MessageRepository : CrudRepository<Message, String>

// MessageService.kt
package com.example.demo

import org.springframework.data.repository.findByIdOrNull
import org.springframework.stereotype.Service

@Service
class MessageService(private val db: MessageRepository) {
    fun findMessages(): List<Message> = db.findAll().toList()

    fun findMessageById(id: String): Message? = db.findByIdOrNull(id)

    fun save(message: Message): Message = db.save(message)
}

// MessageController.kt
package com.example.demo

import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestBody
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
import java.net.URI

@RestController
@RequestMapping("/")
class MessageController(private val service: MessageService) {
    @GetMapping
    fun listMessages() = ResponseEntity.ok(service.findMessages())

    @PostMapping
    fun post(@RequestBody message: Message): ResponseEntity<Message> {
        val savedMessage = service.save(message)
        return ResponseEntity.created(URI("/${savedMessage.id}")).body(savedMessage)
    }

    @GetMapping("/{id}")
    fun getMessage(@PathVariable id: String): ResponseEntity<Message> =
        service.findMessageById(id).toResponseEntity()

    private fun Message?.toResponseEntity(): ResponseEntity<Message> =
        // If the message is null (not found), set response code to 404
        this?.let { ResponseEntity.ok(it) } ?: ResponseEntity.notFound().build()
}

애플리케이션 실행하기

축하합니다! 애플리케이션을 다시 실행할 준비가 되었습니다. JdbcTemplate을 CrudRepository로 교체한 후에도 기능은 동일하게 유지되므로, 애플리케이션은 이전과 마찬가지로 작동합니다.

이제 requests.http 파일에서 POST 및 GET HTTP 요청을 실행하여 동일한 결과를 얻을 수 있습니다.

다음 단계

Kotlin 기능을 탐색하고 언어 학습 진행 상황을 추적하는 데 도움이 되는 개인 언어 맵을 확인하세요:

• Kotlin 코드에서 Java 호출하기 및 Java 코드에서 Kotlin 호출하기에 대해 자세히 알아보세요.
• Java-to-Kotlin 컨버터를 사용하여 기존 Java 코드를 Kotlin으로 변환하는 방법을 알아보세요.
• Java에서 Kotlin으로의 마이그레이션 가이드를 확인하세요:
  • Java와 Kotlin의 문자열.
  • Java와 Kotlin의 컬렉션.
  • Java와 Kotlin의 Nullability.