Kotlinでデータベースのテーブルを定義する方法を徹底解説！初心者にもわかるEntityアノテーションの使い方

先生と生徒の会話形式で理解しよう

生徒

「Kotlinでデータベースのテーブルを作るには、どうすればいいんですか？」

先生

「Kotlinでは、@Entityというアノテーションを使って、クラスをテーブルとして定義します。」

生徒

「アノテーションって何ですか？難しそう…」

先生

「安心して。アノテーションは、クラスや関数に“特別な意味”を伝えるためのマークのようなものです。難しい仕組みは後回しで、まずは使い方から覚えていきましょう。」

1. Kotlinでデータベース操作をする準備

Kotlinでデータベースを操作するためには、ORM（Object Relational Mapping）という仕組みを使います。これは、Kotlinのクラスと、データベースのテーブルを結びつける技術です。

その中でもよく使われるのが、RoomやHibernateです。今回は、初心者でも使いやすい「Roomライブラリ」を例に説明します。

2. @Entityアノテーションとは？

@Entity（エンティティ）は、Kotlinのクラスを「データベースのテーブルですよ」と教えるマークです。クラスの上にこのアノテーションをつけることで、そのクラスがテーブルとして扱われるようになります。

例えば、「ユーザー情報」を保存したい場合は、次のようなクラスを定義します。


import androidx.room.Entity
import androidx.room.PrimaryKey

@Entity(tableName = "users")
data class User(
    @PrimaryKey val id: Int,
    val name: String,
    val email: String
)

3. 各アノテーションの意味をやさしく解説

@Entity：このクラスは「users」という名前のテーブルに対応しています。
@PrimaryKey：idがテーブルの主キー（ユニークな値）であることを示します。
data class：Kotlinの「データを扱うための特別なクラス」です。自動で便利な処理が追加されます。

たとえば、上のクラスではidが「会員番号」のようなもので、重複しない値として使われます。

4. テーブル名を自由に決める方法

@Entityには、tableNameというオプションをつけることができます。これを使うと、テーブル名を自由に設定できます。設定しない場合は、クラス名がそのままテーブル名になります。


@Entity(tableName = "custom_table_name")
data class Item(
    @PrimaryKey val id: Int,
    val title: String
)

5. 主キー（Primary Key）とは何かを解説

主キー（Primary Key）とは、データベースの中で一意に（＝重複せず）そのデータを特定するための番号やIDのことです。

例えば、生徒の名簿があったとき、「生徒番号」があれば同じ名前の人がいても区別できますよね。それと同じです。

Kotlinでは、主キーにする変数の前に@PrimaryKeyをつけるだけでOKです。

6. 自動採番する主キーにするには？

毎回手動でIDを設定するのは大変ですよね。RoomではautoGenerate = trueを使うと、自動で番号をふってくれます。


@Entity
data class Book(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val title: String,
    val author: String
)

このように書くと、新しい本のデータを追加したときに、自動でidが増えていく仕組みになります。

7. カラム名を自由に設定する方法

デフォルトでは、変数名がそのままカラム名になります。でも、カラム名をもっと分かりやすくしたいときは、@ColumnInfoを使って変更できます。


import androidx.room.ColumnInfo

@Entity
data class Product(
    @PrimaryKey val id: Int,
    @ColumnInfo(name = "product_name") val name: String,
    @ColumnInfo(name = "product_price") val price: Int
)

これで、データベース上では「product_name」「product_price」という名前でカラムが作られます。