[Kotlin, Ktor] ktor를 데이터베이스에 연동하기 - 1(3)

 

 

지난 포스팅

https://rkdrkd-history.tistory.com/53

[Kotlin, Ktor] ktor로 http api 만들기(2)

지난 포스팅에서는 ktor에서 http api를 만들어보는 것을 했다.

이번 포스팅에서는 ktor에 database를 사용해 data를 저장해 보겠다.

---

코드는 지난 포스팅을 바탕으로 재공 할 것이니 이전 글을 보고 오는 것을 추천한다.

 

데이터베이스 라이브러리는 다양하지만

이 포스팅에 사용할 데이터베이스 라이브러리는 Exposed와 h2database를 사용하겠다.

https://github.com/JetBrains/Exposed

GitHub - JetBrains/Exposed: Kotlin SQL Framework

https://github.com/h2 database/h2database

GitHub - h2database/h2database: H2 is an embeddable RDBMS written in Java.

 

라이브러리 추가

gradle.properties

exposed_version=0.41.1
h2_version=2.1.214

 

build.gradle.kts

val exposed_version: String by project
val h2_version: String by project

. . .

dependencies {
    // exposed
    implementation("org.jetbrains.exposed:exposed-core:$exposed_version")
    implementation("org.jetbrains.exposed:exposed-dao:$exposed_version")
    implementation("org.jetbrains.exposed:exposed-jdbc:$exposed_version")

    // h2database
    implementation("com.h2database:h2:$h2_version")
    
    . . .
}

esposed, h2database 라이브러리를 추가한다.

 

Table 생성

Customer.kt

import org.jetbrains.exposed.sql.Table

object Customer: Table() {
    val id = integer("id").autoIncrement()
    val firstName = varchar("first_name", 10)
    val lastName = varchar("last_name", 10)

    override val primaryKey: PrimaryKey = PrimaryKey(id)
}

지난 예제를 바탕으로 table을 생성해 주었다.

• id: autoIncrement()로 자동으로 값을 할당한다.
• firstname과 lastname의 필드를 생성해주었다.
• id를 primary key로 설정했다.

 

데이터베이스와 연결

데이터베이스와 연결하려면 먼저 h2 console을 설치해야 한다.https://h2database.com/html/main.html

H2 Database Engine

h2 database 공식 사이트에서 자신의 컴퓨터 운영 체제에 맞는 database engine을 설치한다.

 

h2 database를 설치한 후 파일 javaw을 찾을 수 없습니다 라는 에러가 뜬다면java가 설치가 안 돼있다는 뜻이므로 아래의 사이트에 들어가서 자바를 설치해 준다.

https://www.java.com/ko/download/

Download Java for Linux

 

java를 설치하고 나면 jdk도 같이 생성되는데 그것을 환경 변수로 등록해 주는 작업을 해야 한다.

윈도 + R 누른 후 나오는 창에 sysdm.cpl ,3 을 입력한다.

 

그리고 환경 변수 탭에 들어가서 환경 변수를 설정하면 되는데 자세한 설명은 아래의 블로그를 참고하길 바란다.

https://pingfanzhilu.tistory.com/entry/%EC%8A%A4%ED%94%84%EB%A7%81-%EC%84%A4%EC%A0%95-%EB%A9%94%EC%9D%B4%EB%B8%90-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%8A%A4%ED%94%84%EB%A7%81%EC%9C%BC%EB%A1%9C-%EC%84%A4%EC%A0%95-1

[Spring Project] - 스프링 프로젝트 메이븐(Maven) 기반 Spring 프로젝트 생성(자바 Java JDK 설치 및 환경

 

여기까지 완료한 후 윈도우 키를 눌러 h2 console을 실행하면...

 

브라우저에 이런 창이 뜨면 성공이다.

많이 왔는데 아직 끝나지 않았다.

이제는 ktor로 넘어와서 database factory를 작성한다.

package com.example.database

import com.example.models.Customer
import org.jetbrains.exposed.sql.Database
import org.jetbrains.exposed.sql.SchemaUtils
import org.jetbrains.exposed.sql.transactions.transaction

object DatabaseFactory {
    fun init() {
        val driverClassName = "org.h2.Driver"
        val jdbcURL = "jdbc:h2:file:./build/db"
        val database = Database.connect(jdbcURL, driverClassName)

        transaction(database) {
            SchemaUtils.create(Customer)
        }
    }
}

 이 코드에서 우리가 바꿔야 할 부분은 jdbcURL 쪽인데

 

h2 console에서 jdbc url이라는 입력 창이 있는데

jdbc:h2:~/원하는 이름 입력

이렇게 database의 이름을 설정한다.

이름을 설정하고 '연결' 버튼을 눌렀을 때

다음과 같은 오류가 발생하면

숨겨진 아이콘에서 왼쪽 위에 있는 icon을 클릭해서 h2 콘솔을 재실행한 후 다시 시도하면 정상적으로 작동한다.

다음과 같은 화면이 나오면 성공이다.

저 화면이 나오면

 

사용자 폴더에 다음과 같은 데이터베이스 파일이 생성된다.

데이터베이스를 만들었으니 ktor에서는

val jdbcURL = "jdbc:h2:~/test"

jdbcURL을 자신이 생성한 database 이름으로 바꾼다.

 

쿼리 생성

databaseFactory 파일 안에 쿼리 함수를 만든다.

suspend fun <T> dbQuery(block: suspend () -> T): T =
        newSuspendedTransaction(Dispatchers.IO) { block() }

 

그리고 dao 파일을 만들어준다.

DAOFacade.kt

package com.example.database

import com.example.models.Customers

interface DAOFacade {
    suspend fun allCustomers(): List<Customers>
    suspend fun customer(): Customers?
    suspend fun addNewCustomer(firstName: String, lastName: String, email: String): Customers?
    suspend fun editCustomer(id: Int, firstName: String, lastName: String, email: String): Boolean
    suspend fun deleteCustomer(id: Int): Boolean
}

데이터베이스 관리에 사용될 함수들을 생성해 준다.

 

이제 DAOFacade 구현체를 만들어서 기능을 담아주도록 하겠다.

package com.example.database

import com.example.database.DatabaseFactory.dbQuery
import com.example.models.Customer
import com.example.models.Customers
import org.jetbrains.exposed.sql.*
import org.jetbrains.exposed.sql.SqlExpressionBuilder.eq

class DAOFacadeImpl: DAOFacade {
    private fun resultRowToCustomer(row: ResultRow) = Customers(
        id = row[Customer.id],
        firstName = row[Customer.firstName],
        lastName = row[Customer.lastName],
        email = row[Customer.email]
    )

    override suspend fun allCustomers(): List<Customers> = dbQuery {
        Customer.selectAll().map(::resultRowToCustomer)
    }

    override suspend fun customer(id: Int): Customers? = dbQuery {
        Customer
            .select { Customer.id eq id }
            .map(::resultRowToCustomer)
            .singleOrNull()
    }

    override suspend fun addNewCustomer(firstName: String, lastName: String, email: String): Customers? = dbQuery {
        val insertStatement = Customer.insert {
            it[Customer.firstName] = firstName
            it[Customer.lastName] = lastName
            it[Customer.email] = email
        }
        insertStatement.resultedValues?.singleOrNull()?.let(::resultRowToCustomer)
    }

    override suspend fun editCustomer(id: Int, firstName: String, lastName: String, email: String): Boolean = dbQuery {
        Customer.update({ Customer.id eq id }) {
            it[Customer.firstName] = firstName
            it[Customer.lastName] = lastName
            it[Customer.email] = email
        } > 0
    }

    override suspend fun deleteCustomer(id: Int): Boolean = dbQuery {
        Customer.deleteWhere { Customer.id eq id } > 0
    }
}

이제 각 함수들의 역할을 알아보자

• resultToRowCustomer 함수는 일단 잘 모르겠지만 각 customer item에 row을 넣어주는 것으로 이해했다.
• allCustomers 함수에서는 db에 저장된 모든 데이터를 불러오게(selectAll()) 만들었다.
• customer 함수는 특정 id 값을 찾아서 parameter의 id와 customer의 id가 같은지(eq) 확인하는 작업을 거쳐 데이터를 불러오게 했다.
• addNewCustomer 함수에서는 insert를 사용해 insertState(it)에 parameter의 데이터를 넣어 데이터베이스에 넣어주는 로직으로 구성했다.
• editCustomer 함수는 update를 사용해 customer 함수와 같이 customer의 id가 같은지 확인하는 작업을 거친 후 새로운 데이터를 넣어서 update 하는 로직이다.
• deleteCustomer 함수는 deleteWhere를 사용해 id가 같은가의 조건을 생성해 true인 경우만 값을 삭제시키는 로직을 만들었다.

---

지금 글을 적다가 양이 많아져서 일단 여기까지 하도록 하겠다.

다음 포스팅에 위에 글에서 했던 코드들을 이용해 기존의 api를 수정해 보도록 하겠다.