【Unity】 SQLiteのEntityFrameworkを利用する

アプリケーションに組み込むことで利用できる、オープンソースの軽量のRDBMS（データベース管理システム）です。 これを利用することで、ゲームの設定値やアイテムリストをDBで管理できるのでとても便利です。

Entity Frameworkを使うと、データベースのテーブルをクラスとしてプログラム内に表現することができます。 そして、これらのクラスのインスタンスを通じて、データベースの読み書きができるようになります。

LINQの書き方を知っていれば、簡単にデータベース操作を行うことができます。

本記事では、ライブラリのインストールする際に、[NuGetForUnity]というツールを使用していきます。 使用方法については、以下リンクのGitHubの[README]に記載されていますので、そちらを参照してください。

以下の２つのライブラリを[NuGetForUnity]を使って、インストールしていきます。

• Microsoft.EntityFrameworkCore.Sqlite.Core - Version 5.0.17
• SQLitePCLRaw.bundle_e_sqlite3 - Version 2.1.8

インストール例を見ていきます。 まずインストールするには、まず[NuGet]→[Manage NuGet Packages]を開きます。

検索欄にインストールしたいライブラリ名を入力して、[Search]をクリックします。 例として、[Microsoft.EntityFrameworkCore.Sqlite.Core]を検索しています。

インストールしたいライブラリが表示されたら、適切なバージョンを選択して、[Install]をクリックします。 バージョンは[5.0.17]を選択しています。これでインストール完了です。

同じ手順で[SQLitePCLRaw.bundle_e_sqlite3]もインストールしてください。

Nugetでライブラリをインストール後にたくさんのエラーが出ることがあります。 その場合は、一度Unityエディタを終了して、再度立ち上げてみてください。

最後に[e_sqlite3.dll]というライブラリを手動取得します。 取得方法は様々ですが、今回はサイトからダウンロードします。

以下リンクから該当のものをダウンロードしてください。

まず、Unity内にDBを格納するフォルダを作成していきます。 [Assets]フォルダの直下に[StreamingAssets]という名前でフォルダを作成します。 このフォルダにデータを格納するためのDBファイルを作成していきます。

このフォルダではゲーム内で直接読み込むことができるアセットを格納することができます。 このフォルダ内に置かれたファイルは、ビルド時にそのままの形でゲームに組み込まれ、 ファイルのパスを指定することで、実行時にアクセスして読み込むことが可能です。

次にDBファイルを作成していきます。 色々方法はありますが、今回はGUIで作成できる[DB Browser for SQLite]を使用します。 以下のリンクから、インストーラをダウンロードしてインストールしてください。

インストールが終わったら、アプリを開いて、[New Database]をクリックします。

保存先を[StreamingAssets]にして、今回は[test]という名前のDBを作成します。

データを格納するテーブルを作成していきます。 例として、武器情報を想定して[Weapons]テーブルを作成してみます。 まず[Open Database]をクリックして、先ほど作成したDBと接続します。

接続したら、[Execute SQL]を選択して、以下のSQL文を実行してください。 そうすることでテーブルが作成されます。

CREATE TABLE Weapons (
    Id INTEGER PRIMARY KEY,
    Name TEXT NOT NULL,
    Description TEXT NOT NULL,
    AttackPower INTEGER NOT NULL
);

Unity側でDBに接続するための処理を作成していきます。 はじめに、作成したテーブルに対応したエンティティクラスを作成します。

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

/// <summary>
/// 武器テーブルのエンティティクラス
/// </summary>
[Table("Weapons")]
public class Weapon
{
    /// <summary>
    /// 識別子
    /// </summary>
    [Key]
    public int Id { get; set; }

    /// <summary>
    /// 名前
    /// </summary>
    [Required]
    public string Name { get; set; }

    /// <summary>
    /// 武器説明
    /// </summary>
    [Required]
    public string Description { get; set; }

    /// <summary>
    /// 攻撃力
    /// </summary>
    [Required]
    public int AttackPower { get; set; }
}

次にDBに接続するためのDBコンテキストクラスを作成していきます。 このクラスがDBとの接続を担うクラスになります。

using Microsoft.Data.Sqlite;
using Microsoft.EntityFrameworkCore;

/// <summary>
/// DB接続クラス
/// </summary>
public class TestDbContext : DbContext
{
    /// <summary>
    /// 武器テーブルのデータが格納される
    /// </summary>
    public DbSet<Weapon> Weapons { get; set; }

    /// <summary>
    /// 接続文字列
    /// </summary>
    private readonly string _connectString;

    /// <summary>
    /// コンストラクタ
    /// </summary>
    /// <param name="connectString">接続文字列</param>
    public TestDbContext(string connectString)
    {
        _connectString = connectString;
    }

    /// <summary>
    /// オプション構成
    /// </summary>
    /// <param name="optionsBuilder">オプションビルダー</param>
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        var connectionString = new SqliteConnectionStringBuilder { DataSource = _connectString }.ToString();
        optionsBuilder.UseSqlite(new SqliteConnection(connectionString));
    }
}

作成したDBコンテキストクラスを使って、DBに接続して処理を行います。 以下のような使用感で使うことができます。

using System;
using System.IO;
using System.Linq;
using TMPro;
using UnityEngine;

public class DbContextSample : MonoBehaviour
{
    /// <summary>
    /// AddDataのメッセージを表示するテキスト
    /// </summary>
    [SerializeField]
    private TextMeshProUGUI _textAddData;

    /// <summary>
    /// ReadDataのメッセージを表示するテキスト
    /// </summary>
    [SerializeField]
    private TextMeshProUGUI _textReadData;

    /// <summary>
    /// DBにデータ追加するサンプル
    /// </summary>
    public void AddData()
    {
        try
        {
            // 接続先パス
            var connectString = Path.Combine(Application.streamingAssetsPath, "test.db");
            using (TestDbContext testDbContext = new TestDbContext(connectString))
            {
                Weapon weapon = new Weapon()
                {
                    Name = "ラグナロク",
                    Description = "伝説の武器です。勇者しか扱えない。",
                    AttackPower = 500
                };

                // 武器をデータベースに追加
                testDbContext.Weapons.Add(weapon);

                // 変更を保存
                testDbContext.SaveChanges();

                _textAddData.text = "AddData Success";
            }
        }
        catch(Exception e)
        {
            Debug.Log(e);
            _textAddData.text = "AddData Failure";
        }
    }

    /// <summary>
    /// DBからデータ読み込むサンプル
    /// </summary>
    public void ReadData()
    {
        try
        {
            // 接続先パス
            var connectString = Path.Combine(Application.streamingAssetsPath, "test.db");
            using (TestDbContext testDbContext = new TestDbContext(connectString))
            {
                // 武器をデータベースに追加
                var weapon = testDbContext.Weapons.Where(weapon => weapon.Id == 1).SingleOrDefault();

                if(weapon != default)
                {
                    Debug.Log(weapon.Name);
                    Debug.Log(weapon.Description);
                    Debug.Log(weapon.AttackPower);
                }

                _textReadData.text = "ReadData Success";
            }
        }
        catch (Exception e)
        {
            Debug.Log(e);
            _textReadData.text = "ReadData Failure";
        }
    }
}

Application.streamingAssetsPathで[StreamingAssets]フォルダまでのパスを取得できます。 そのパスを引数にしてTestDbContextを作成して、データベースの操作を行っています。 AddDataメソッドには、DBに武器データを追加処理、ReadDataには、DBから武器データを読み込む処理が書かれています。

実際にこのクラスを使用しているサンプルシーン(SqliteEfScene)をGitHubに用意してありますので、よかったら動かしてみてください。

今回はSQLiteのEntityFrameworkの導入方法について解説しました。 EntityFrameworkを使うと開発が捗りますので、是非利用してみてください。