読み込み中...

Kotlinでのデータベース接続のたった13の方法

Kotlinを使ったデータベース接続の方法のサンプルコードイメージ Kotlin
2023.10.06
この記事は約26分で読めます。

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

本記事のサンプルコードを活用して機能追加、目的を達成できるように作ってありますので、是非ご活用ください。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を満たす現役のプログラマチームによって監修されています。

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

Kotlinは今、アプリ開発者の間で急速に人気を集めているプログラミング言語です。

その魅力は、シンプルな文法とJavaとの高い互換性にあります。

この記事を読めば、Kotlinでデータベースに接続する方法を13通りマスターすることができます。

初めての方でもステップバイステップで進められるように、基本から応用、さらには注意点やカスタマイズ方法までを丁寧に解説していきます。

●Kotlinとは？

KotlinはJetBrainsが開発した静的型付けのプログラミング言語です。

2016年にGoogleがAndroidの公式言語として採用したことから、その人気はさらに加速しています。

○Kotlinの基本と特徴

Kotlinの大きな特徴は、Javaと100%互換性がある点です。

つまり、Javaで書かれたライブラリやフレームワークをそのまま使用することができます。

また、KotlinはJavaよりも簡潔にコードを書くことができ、Null安全などの機能も備えているため、より品質の高いコードを効率よく書くことができます。

また、Kotlinはその名の通り、コンパイル時にJavaのバイトコードに変換されます。

これにより、Javaで書かれたコードと混在して使用することも容易です。

この特徴は、既存のJavaのプロジェクトにKotlinを導入する際に非常に役立ちます。

●データベース接続の前提知識

プログラムを書いていると、データの保存や取得が必要となることがよくあります。このような時に役立つのがデータベースです。

特にWebアプリケーションやスマートフォンアプリなどを開発する際には、データベースの知識は必須となります。

○データベースとは？

データベースは、大量のデータを効率的に保存、管理、取得するためのシステムです。

データベースには様々な種類があり、リレーショナルデータベース(RDB)やNoSQLデータベースなどが存在します。

RDBはテーブルとしてデータを管理するシステムで、SQLという言語を用いてデータの操作を行います。

一方、NoSQLデータベースは非リレーショナル型のデータベースで、JSON形式などでデータを保存します。

○なぜデータベース接続が必要か？

アプリケーションを開発する際、ユーザーの情報や商品情報、注文履歴など様々なデータを扱うことが多いです。

これらのデータは、アプリケーションを終了した後も保存しておき、再度アプリケーションを起動した時に利用したいと考えるでしょう。

このようなデータの保存や取得を効率的に行うために、データベースを使用します。

また、WebサイトのアクセスログやECサイトの購入履歴、SNSの投稿データなど、大量のデータをリアルタイムで追加・取得する必要がある場合にも、データベースの役割は非常に大きいです。

●Kotlinでのデータベース接続の基本

Kotlinを使用してアプリケーションを開発する際、データベース接続は避けて通れないステップとなります。

正確に、安全に、効率的にデータを扱うための接続方法を学ぶことは、アプリケーションの品質を保つために不可欠です。

○サンプルコード1：基本的な接続方法

Kotlinでデータベースに接続するための基本的な方法は次のようになります。

import java.sql.Connection
import java.sql.DriverManager

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"

    // データベース接続
    val connection: Connection? = DriverManager.getConnection(url, user, password)
    println("データベースに接続しました。")

    // 接続終了
    connection?.close()
}

このコードでは、JavaのJDBC APIを用いてデータベースに接続しています。

url, user, passwordの部分は、それぞれのデータベースの環境に合わせて変更する必要があります。

接続が成功すると、「データベースに接続しました。」と表示されます。

○サンプルコード2：接続情報を持った設定ファイルの利用

ハードコーディングした接続情報をコード内に持つのは、セキュリティ的にもメンテナンスの観点からも良くありません。

より良い方法は、設定ファイルに接続情報を保持し、それを読み込む方法です。

import java.sql.Connection
import java.sql.DriverManager
import java.util.Properties

fun main() {
    val properties = Properties().apply {
        load(FileInputStream("db.properties"))
    }
    val url = properties.getProperty("db.url")
    val user = properties.getProperty("db.user")
    val password = properties.getProperty("db.password")

    // データベース接続
    val connection: Connection? = DriverManager.getConnection(url, user, password)
    println("データベースに接続しました。")

    // 接続終了
    connection?.close()
}

このコードで読み込む設定ファイル(db.properties)の内容は次の通りです。

db.url=jdbc:mysql://localhost:3306/your_database_name
db.user=your_username
db.password=your_password

この方法を採用することで、データベースの接続情報が変更された場合も設定ファイルのみを変更すれば良く、コードの修正は不要となります。

セキュリティ上のリスクも軽減できます。

●KotlinでのデータベースのCRUD操作

データベースとアプリケーションのやりとりの基本は、CRUD操作に集約されます。

CRUDはCreate（作成）、Read（読み取り）、Update（更新）、Delete（削除）の頭文字を取ったものです。

Kotlinを使用してこれらの操作を行う方法を学んでいきましょう。

○サンプルコード3：データの追加 (CREATE)

新しいデータをデータベースに追加するための基本的なコードは次のようになります。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.PreparedStatement

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"
    val connection: Connection? = DriverManager.getConnection(url, user, password)

    val sql = "INSERT INTO your_table_name (column1, column2) VALUES (?, ?)"
    val preparedStatement: PreparedStatement? = connection?.prepareStatement(sql)
    preparedStatement?.setString(1, "value1")
    preparedStatement?.setString(2, "value2")
    val result = preparedStatement?.executeUpdate()

    if (result != null && result > 0) {
        println("データを正常に追加しました。")
    }

    connection?.close()
}

このコードでは、指定されたテーブルに新しいデータを追加しています。

具体的な値（”value1″と”value2″）は、実際の使用時に適切なものに変更する必要があります。

○サンプルコード4：データの取得 (READ)

データベースからデータを読み取るための基本的なコードは次の通りです。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.ResultSet
import java.sql.Statement

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"
    val connection: Connection? = DriverManager.getConnection(url, user, password)

    val statement: Statement? = connection?.createStatement()
    val resultSet: ResultSet? = statement?.executeQuery("SELECT column1, column2 FROM your_table_name")

    while (resultSet?.next() == true) {
        val value1 = resultSet.getString("column1")
        val value2 = resultSet.getString("column2")
        println("column1: $value1, column2: $value2")
    }

    connection?.close()
}

このコードは指定されたテーブルの全てのデータを取得し、その内容を表示します。

取得したい列や条件を絞り込む場合は、SQL文を変更することで対応できます。

○サンプルコード5：データの更新 (UPDATE)

データベースの情報は、一度追加されたからといって固定されるわけではありません。

特定の条件に一致するデータを更新する場面は頻繁にあります。

例えば、顧客の住所情報が変わった場合、その情報を最新のものに更新する必要があります。

下記のサンプルコードは、Kotlinを使用してデータベースの特定のデータを更新する方法を表しています。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.PreparedStatement

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"
    val connection: Connection? = DriverManager.getConnection(url, user, password)

    val sql = "UPDATE your_table_name SET column1 = ? WHERE column2 = ?"
    val preparedStatement: PreparedStatement? = connection?.prepareStatement(sql)
    preparedStatement?.setString(1, "new_value1")
    preparedStatement?.setString(2, "specific_value2")
    val result = preparedStatement?.executeUpdate()

    if (result != null && result > 0) {
        println("特定の条件に一致するデータを正常に更新しました。")
    } else {
        println("該当するデータが存在しないか、更新に失敗しました。")
    }

    connection?.close()
}

このコードでは、column2が”specific_value2″という値を持つデータのcolumn1の内容を”new_value1″に更新しています。

SQL文内の「?」はプレースホルダと呼ばれ、実際の値に置き換える前にSQL文を準備するために使用されます。

これにより、SQLインジェクションといったセキュリティの脅威から守ることができます。

次に、このコードの実行結果を見てみましょう。

実際には、データベース内のデータが更新されますが、コード内で出力されるメッセージとしては「特定の条件に一致するデータを正常に更新しました。」もしくは「該当するデータが存在しないか、更新に失敗しました。」のいずれかが表示されます。

○サンプルコード6：データの削除 (DELETE)

データの削除も重要な操作の一つです。

不要なデータや過去のデータをクリーンアップするために、データをデータベースから削除することが必要となります。

Kotlinでデータを削除するためのサンプルコードを紹介します。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.PreparedStatement

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"
    val connection: Connection? = DriverManager.getConnection(url, user, password)

    val sql = "DELETE FROM your_table_name WHERE column1 = ?"
    val preparedStatement: PreparedStatement? = connection?.prepareStatement(sql)
    preparedStatement?.setString(1, "specific_value1")
    val result = preparedStatement?.executeUpdate()

    if (result != null && result > 0) {
        println("指定したデータを正常に削除しました。")
    } else {
        println("該当するデータが存在しないか、削除に失敗しました。")
    }

    connection?.close()
}

このコードでは、column1が”specific_value1″という値を持つデータをデータベースから削除しています。

実行結果として、「指定したデータを正常に削除しました。」もしくは「該当するデータが存在しないか、削除に失敗しました。」のいずれかが出力されます。

●Kotlinでのデータベース接続の応用例

Kotlinを使用してデータベースに接続する場面では、基本的なCRUD操作だけでなく、もっと高度な操作やテクニックが求められることもあります。

ここでは、Kotlinでデータベース接続をさらに応用した場合の例をいくつか紹介します。

○サンプルコード7：トランザクションの利用

データベースのトランザクションは、複数の操作をひとまとめにして、全ての操作が成功した場合のみ確定させる方法です。

トランザクションの利用は、データの整合性を保つために非常に重要です。

下記のサンプルコードは、Kotlinでデータベースのトランザクションを利用する方法を表しています。

import java.sql.Connection
import java.sql.DriverManager

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"
    val connection: Connection = DriverManager.getConnection(url, user, password)

    try {
        connection.autoCommit = false

        val statement1 = connection.createStatement()
        statement1.executeUpdate("SQL query1")

        val statement2 = connection.createStatement()
        statement2.executeUpdate("SQL query2")

        connection.commit()
        println("トランザクションが正常に完了しました。")
    } catch (ex: Exception) {
        connection.rollback()
        println("エラーが発生しました。トランザクションをロールバックします。")
    } finally {
        connection.close()
    }
}

このコードでは、2つのSQLクエリをトランザクションとして実行しています。

もし途中で何らかのエラーが発生した場合、rollbackメソッドによって、変更が元に戻されます。

このコードを実行すると、すべてのSQLクエリが成功すれば「トランザクションが正常に完了しました。」と表示され、何らかのエラーが発生した場合は「エラーが発生しました。トランザクションをロールバックします。」と表示されます。

○サンプルコード8：複数テーブルへのJOIN操作

データベース内の情報が複数のテーブルに分散して保存されている場合、JOIN操作を利用して関連するデータをまとめて取得することができます。

ここでは、Kotlinを使用して2つのテーブルをJOINしてデータを取得するサンプルコードを紹介します。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.ResultSet

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"
    val connection: Connection = DriverManager.getConnection(url, user, password)

    val sql = """
       SELECT a.column1, b.column2 
       FROM table1 a 
       JOIN table2 b ON a.column3 = b.column4
    """
    val statement = connection.createStatement()
    val resultSet: ResultSet = statement.executeQuery(sql)

    while (resultSet.next()) {
        val value1 = resultSet.getString("column1")
        val value2 = resultSet.getString("column2")
        println("column1: $value1, column2: $value2")
    }

    connection.close()
}

このコードは、table1とtable2をJOINし、それぞれのテーブルからcolumn1とcolumn2を取得しています。

JOINの条件はa.column3 = b.column4としており、これにより関連するデータを一度に取得できます。

実行結果としては、JOINにより取得されたデータが「column1: value1, column2: value2」という形式で出力されます。

○サンプルコード9：非同期処理との組み合わせ

近年のアプリケーション開発では、非同期処理が一般的に利用されるようになっています。

特にデータベース接続の際には、ユーザーの体感速度を上げるために、非同期でデータベースとのやり取りを行うケースが増えています。

Kotlinではcoroutinesを利用して、この非同期処理を実現できます。

ここでは、Kotlinのcoroutinesを用いて、非同期にデータベースへの接続とデータの取得を行う方法を紹介します。

import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking
import java.sql.Connection
import java.sql.DriverManager
import java.sql.ResultSet

fun main() = runBlocking {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"

    launch {
        val connection: Connection = DriverManager.getConnection(url, user, password)
        val statement = connection.createStatement()
        val resultSet: ResultSet = statement.executeQuery("SELECT * FROM your_table_name")

        while (resultSet.next()) {
            val data = resultSet.getString("your_column_name")
            println(data)
        }

        connection.close()
    }
}

このコードはrunBlockingを利用して、非同期のコードを同期的に実行しています。

また、launch関数内でデータベース接続とデータの取得を非同期で行っています。

このコードを実行すると、非同期にデータベースからデータを取得し、取得したデータがコンソールに出力されます。

○サンプルコード10：外部ライブラリの利用

Kotlinを使用してデータベースに接続する際には、多くの場合、JDBCドライバだけでなく、さまざまな外部ライブラリを利用することがあります。

外部ライブラリを使用することで、データベース操作をより簡単に、また効率的に行うことができます。

ここでは、ExposedというKotlinのデータベースアクセスライブラリを使用して、データベースの接続と操作を行う方法を紹介します。

import org.jetbrains.exposed.dao.IntIdTable
import org.jetbrains.exposed.sql.Database
import org.jetbrains.exposed.sql.SchemaUtils
import org.jetbrains.exposed.sql.selectAll
import org.jetbrains.exposed.sql.transactions.transaction

object Users : IntIdTable() {
    val name = varchar("name", 50)
}

fun main() {
    Database.connect("jdbc:mysql://localhost:3306/your_database_name", driver = "com.mysql.jdbc.Driver", user = "your_username", password = "your_password")

    transaction {
        SchemaUtils.create(Users)

        val result = Users.selectAll()
        for (row in result) {
            println(row[Users.name])
        }
    }
}

このコードは、Exposedライブラリを用いて、Usersテーブルから全てのデータを取得し、その名前を出力するものです。

実行すると、Usersテーブルに保存されている名前がすべてコンソールに表示されます。

●データベース接続の注意点と対処法

データベース接続時には、さまざまな問題やトラブルが発生する可能性があります。

効率的なシステムを構築するためには、これらの注意点を理解し、適切な対処法を知っておくことが重要です。

○サンプルコード11：エラーハンドリング

データベース接続や操作中にエラーが発生することは少なくありません。

例えば、データベースサーバがダウンしている、ネットワークの問題、SQL文の誤りなどが考えられます。

こういったエラーを適切にハンドリングするための方法を以下に示します。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.SQLException

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"

    try {
        val connection: Connection = DriverManager.getConnection(url, user, password)
        // その他のデータベース操作
    } catch (e: SQLException) {
        // エラー処理
        println("データベース接続に失敗しました。")
        e.printStackTrace()
    }
}

このコードでは、try-catchブロックを使用して、SQLExceptionをキャッチしています。

エラーが発生した場合には、エラーメッセージとスタックトレースを出力しています。

○サンプルコード12：セキュリティ対策

データベースは重要な情報を保管する場所であり、セキュリティ上の脅威から保護する必要があります。

SQLインジェクションは、データベースに対する一般的な攻撃の1つです。

これを回避するためには、プリペアドステートメントを使用することが推奨されます。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.PreparedStatement

fun main() {
    val url = "jdbc:mysql://localhost:3306/your_database_name"
    val user = "your_username"
    val password = "your_password"
    val query = "SELECT * FROM your_table_name WHERE id = ?"

    val connection: Connection = DriverManager.getConnection(url, user, password)
    val preparedStatement: PreparedStatement = connection.prepareStatement(query)
    preparedStatement.setInt(1, 1)  // ここで値をセット

    val resultSet = preparedStatement.executeQuery()
    while (resultSet.next()) {
        val data = resultSet.getString("your_column_name")
        println(data)
    }
    connection.close()
}

このコードでは、prepareStatementを使用してSQL文を事前に準備し、その後でパラメータの値をセットしています。

これにより、SQLインジェクションのリスクを大幅に減少させることができます。

エラーハンドリングのコードを実行すると、データベース接続に失敗した場合にエラーメッセージが表示され、問題の原因を特定するためのスタックトレースが出力されます。

一方、セキュリティ対策のコードを実行すると、プリペアドステートメントを使用して安全にデータベースからデータを取得できます。

●カスタマイズ方法

Kotlinを使用したデータベース接続は、高度なカスタマイズが可能です。

プロジェクトの要件に応じて、独自の関数やクラスを追加することで、効率的なデータベース操作を実現できます。

○サンプルコード13：独自の関数やクラスの追加

独自の関数やクラスを使用することで、特定のデータベース操作を簡単に行うことができます。

下記のサンプルコードでは、データベースから特定のデータを取得するための独自関数を作成しています。

import java.sql.Connection
import java.sql.DriverManager
import java.sql.ResultSet

class CustomDatabaseHandler(val url: String, val user: String, val password: String) {
    private fun getConnection(): Connection {
        return DriverManager.getConnection(url, user, password)
    }

    fun fetchDataById(table: String, id: Int): ResultSet? {
        val query = "SELECT * FROM $table WHERE id = $id"
        val connection = getConnection()
        val statement = connection.createStatement()
        return statement.executeQuery(query)
    }
}

fun main() {
    val dbHandler = CustomDatabaseHandler("jdbc:mysql://localhost:3306/your_database_name", "your_username", "your_password")
    val data = dbHandler.fetchDataById("your_table_name", 1)
    while (data?.next() == true) {
        println(data.getString("your_column_name"))
    }
}

このコードではCustomDatabaseHandlerという独自のクラスを作成しています。

このクラスには、指定されたIDのデータを取得するfetchDataByIdという関数が含まれており、これを使用してデータベースからデータを簡単に取得することができます。

このコードを実行すると、指定したテーブルとIDに基づいてデータを取得し、そのデータをコンソールに出力します。

独自の関数やクラスの追加により、複雑なデータベース操作もシンプルなコードで実現することができるのが大きな特長です。

まとめ

Kotlinを使用したデータベース接続は、シンプルかつ効率的にデータベースの操作を行うことができる方法の一つです。

本記事では、基本的な接続方法からCRUD操作、応用例、注意点、そしてカスタマイズ方法に至るまで、幅広くKotlinを使ったデータベース接続の手法を解説しました。

Kotlinの型安全性やシンタックスの簡潔さは、データベース操作をより安全で読みやすいものにしています。

また、多様なライブラリやフレームワークとの組み合わせによって、高度なデータベース処理もスムーズに実行可能です。

データベース接続の際には、セキュリティやエラーハンドリングといった注意点も念頭に置き、適切な処理を行うことが重要です。

独自の関数やクラスを追加することで、プロジェクトの要件に合わせたカスタマイズも容易に行うことができます。

Kotlinを活用することで、効率的で安全なデータベース操作を実現することができるようになるでしょう。

これからの開発において、本記事が参考となり、より質の高いアプリケーション開発をサポートとなることを期待しています。