Quickstart

概要

H2 Database EngineにJDBCで接続するアプリケーションを作成します。

必要要件

• JDK 8、もしくはそれ以降のバージョン
• Gradle 7.2

インストール

JDKとGradleをインストールしてください。

アプリケーションの作成

ビルドスクリプト

ビルドスクリプトをGradle Kotlin DSLを使って書きます。

以下のコードをbuild.gradle.ktsに記述します。

plugins {
  application
  id("com.google.devtools.ksp") version "1.5.31-1.0.0"
  kotlin("jvm") version "1.5.31"
}

repositories {
  mavenCentral()
}

dependencies {
  val komapperVersion = "0.18.0"
  implementation("org.komapper:komapper-starter-jdbc:$komapperVersion")
  implementation("org.komapper:komapper-dialect-h2-jdbc:$komapperVersion")
  ksp("org.komapper:komapper-processor:$komapperVersion")
}

application {
  mainClass.set("org.komapper.quickstart.ApplicationKt")
}

kotlin {
  sourceSets.main {
    kotlin.srcDir("build/generated/ksp/main/kotlin")
  }
}

dependenciesブロックでは3つの依存モジュールを宣言していますが、いずれも同一のバージョンであることに注意してください。 以下にモジュールごとの説明をします。

komapper-starter-jdbc モジュール

Komapperを使ったJDBC接続に必要かつ便利なモジュール一式をまとめたモジュールです。

komapper-dialect-h2-jdbc モジュール

H2 Database Engineに接続するために必要なモジュールです。

komapper-processor モジュール

コンパイル時にコード生成を行うモジュールです。kspというキーワードを使って宣言されていることに注意してください。 ksp は Kotlin Symbol Processing API のプラグインが提供する機能でコンパイル時のコード生成に必要です。

ソースコード

最初に、データベースのテーブルに対応するエンティティクラス（Employee）と対応関係を定義するクラス（EmployeeDef）を作ります。

data class Employee(
  val id: Int = 0,
  val name: String,
  val version: Int = 0,
  val createdAt: LocalDateTime = LocalDateTime.MIN,
  val updatedAt: LocalDateTime = LocalDateTime.MIN,
)

@KomapperEntityDef(Employee::class)
data class EmployeeDef(
  @KomapperId @KomapperAutoIncrement val id: Nothing,
  @KomapperVersion val version: Nothing,
  @KomapperCreatedAt val createdAt: Nothing,
  @KomapperUpdatedAt val updatedAt: Nothing,
) {
  companion object
}

次に、main関数を書きます。

fun main() {
  // (1) create a database instance
  val database = JdbcDatabase.create("jdbc:h2:mem:quickstart;DB_CLOSE_DELAY=-1")

  // (2) start transaction
  database.withTransaction {

    // (3) get an entity metamodel
    val e = EmployeeDef.meta

    // (4) create schema
    database.runQuery {
      SchemaDsl.create(e)
    }

    // (5) insert multiple employees at once
    database.runQuery {
      EntityDsl.insert(e).multiple(Employee(name = "AAA"), Employee(name = "BBB"))
    }

    // (6) select all
    val employees = database.runQuery {
      EntityDsl.from(e).orderBy(e.id)
    }

    // (7) print all results
    for ((i, employee) in employees.withIndex()) {
      println("RESULT $i: $employee")
    }
  }
}

ビルド

ビルドをするには次のGradleコマンドを実行します。

$ gradle build

コマンド実行後、build/generated/ksp/main/kotlinディレクトリを確認してください。 Kotlin Symbol Processing APIによって生成されたコードが存在することがわかります。

実行

アプリケーションを動かすには次のGradleコマンドを実行します。

$ gradle run

アプリケーションを実行するとコンソール上に次のような出力が表示されます。

21:00:53.099 [main] DEBUG org.komapper.SQL - create table if not exists employee (id integer not null auto_increment, name varchar(500) not null, version integer not null, created_at timestamp not null, updated_at timestamp not null, constraint pk_employee primary key(id));
21:00:53.117 [main] DEBUG org.komapper.SQL - insert into employee (name, version, created_at, updated_at) values (?, ?, ?, ?), (?, ?, ?, ?)
21:00:53.140 [main] DEBUG org.komapper.SQL - select t0_.id, t0_.name, t0_.version, t0_.created_at, t0_.updated_at from employee as t0_ order by t0_.id asc
RESULT 0: Employee(id=1, name=AAA, version=0, createdAt=2021-05-05T21:00:53.115127, updatedAt=2021-05-05T21:00:53.115127)
RESULT 1: Employee(id=2, name=BBB, version=0, createdAt=2021-05-05T21:00:53.115250, updatedAt=2021-05-05T21:00:53.115250)

EmployeeインスタンスにIDやタイムスタンプが設定されていることがわかります。 これらはKomapperにより自動的に設定されました。

完全なコードの取得

完全なコードを得るには以下のリポジトリを確認ください。

• https://github.com/komapper/komapper-quickstart

上記リンク先のリポジトリではGradle Wrapperを使っています。 したがって、Gradleをインストールしなくてもアプリケーションを動かすことができます。 本ページではビルドと実行で2つのGradleコマンドを示しましたが、Gradle Wrapperを使うにはそれぞれ次のコマンドを使ってください。

$ ./gradlew build

$ ./gradlew run