FlutterとSQLite：データベース操作の基本

2023年8月26日

Flutterを使ってアプリを開発する際、データの永続的な保存が必要になることはよくあります。その際に役立つのがSQLiteという軽量なデータベースです。この記事では、FlutterとSQLiteを組み合わせてデータベース操作を行う基本的な方法について解説します。これをマスターすれば、より複雑なデータの管理が可能になります。

FlutterとSQLiteの基本

FlutterとSQLiteの概要

SQLiteとは？

SQLiteは、軽量で高速なオープンソースのリレーショナルデータベースです。サーバーの設定や管理が不要で、データベース全体が単一のディスクファイルに格納されます。これにより、SQLiteはアプリケーションの内部データストレージとして非常に便利で、特にモバイルアプリケーションでよく使用されます。

SQLiteはSQL（Structured Query Language）を使用してデータを操作します。これは、データの挿入、更新、削除、検索など、データベース操作のための標準的な言語です。SQLiteはACID（Atomicity, Consistency, Isolation, Durability）準拠であり、トランザクション中にシステムがクラッシュした場合でもデータの整合性を保証します。

Flutterでは、sqfliteパッケージを使用してSQLiteデータベースとのインタラクションを行います。これにより、Flutterアプリケーションでデータを永続的に保存し、必要に応じて取り出すことが可能になります。

FlutterとSQLiteの連携

SQLiteパッケージのインストール

FlutterでSQLiteを使用するためには、まずsqfliteというパッケージをプロジェクトに追加する必要があります。これは、FlutterとDartでSQLiteデータベースを操作するための最も一般的なパッケージです。

以下の手順でsqfliteパッケージをインストールできます。

pubspec.yamlファイルを開き、dependencies:セクションに移動し、以下の行を追加します。

dependencies:
  flutter:
    sdk: flutter
  sqflite: ^最新バージョン

^最新バージョンの部分は、pub.devで確認できる最新のバージョン番号に置き換えてください。

保存したら、ターミナルを開き、プロジェクトのルートディレクトリに移動します。

flutter pub get

これで、sqfliteパッケージがプロジェクトにインストールされ、SQLiteデータベースを操作するためのAPIが利用可能になります。

データベースの初期化

SQLiteデータベースを使用する前に、まずデータベースを初期化する必要があります。これには、データベースファイルの作成とテーブルの作成が含まれます。以下に、FlutterでSQLiteデータベースを初期化する基本的な手順を示します。

まず、sqfliteパッケージをインポートします。

import 'package:sqflite/sqflite.dart';

次に、データベースを初期化する関数を作成します。この関数は非同期であるため、asyncキーワードを使用します。

Future<Database> initializeDB() async {
  String path = await getDatabasesPath();
  return openDatabase(
    join(path, 'my_database.db'),
    onCreate: (database, version) async {
      await database.execute(
        "CREATE TABLE my_table(id INTEGER PRIMARY KEY, name TEXT, age INTEGER)",
      );
    },
    version: 1,
  );
}

この関数は、データベースファイルのパスを取得し、openDatabase関数を使用してデータベースを開きます。データベースがまだ存在しない場合、onCreateコールバックが呼び出され、新しいテーブルを作成します。この例では、my_tableという名前のテーブルを作成し、id、name、ageという3つのフィールドを持つようにしています。

これで、データベースが初期化され、使用する準備が整いました。

データベース操作の基本

テーブルの作成

テーブル作成のSQL文

SQLiteでは、テーブルを作成するためにはSQL（Structured Query Language）を使用します。SQLは、データベースの構造を定義し、データを操作するための言語です。

以下に、SQLiteでテーブルを作成するための基本的なSQL文を示します。

CREATE TABLE my_table(
    id INTEGER PRIMARY KEY,
    name TEXT,
    age INTEGER
);

このSQL文は、my_tableという名前の新しいテーブルを作成します。テーブルには3つの列（id、name、age）があります。

id：これは整数型（INTEGER）の列で、PRIMARY KEYと指定されています。これは、この列がテーブルの主キーであることを意味します。主キーは、テーブルの各行を一意に識別するためのものです。
name：これはテキスト型（TEXT）の列です。これは、文字列データを保存するためのものです。
age：これも整数型（INTEGER）の列です。これは、数値データを保存するためのものです。

このSQL文は、Flutterのexecuteメソッドを使用してデータベースに送信されます。これにより、指定した構造のテーブルがデータベースに作成されます。

テーブル作成の実行

Flutterのsqfliteパッケージを使用して、先ほど作成したSQL文を実行し、SQLiteデータベースにテーブルを作成します。以下にその手順を示します。

まず、データベースの初期化関数を呼び出してデータベースインスタンスを取得します。

final Database db = await initializeDB();

次に、executeメソッドを使用してSQL文を実行します。このメソッドは、引数としてSQL文を受け取り、そのSQL文をデータベースで実行します。

await db.execute(
  "CREATE TABLE my_table(id INTEGER PRIMARY KEY, name TEXT, age INTEGER)",
);

このコードは、my_tableという名前のテーブルを作成し、そのテーブルにはid、name、ageという3つの列があります。

これで、SQLiteデータベースにテーブルが作成されました。次に、このテーブルにデータを挿入したり、テーブルからデータを取得したりする操作を行うことができます。

データの挿入

データ挿入のSQL文

SQLiteでデータをテーブルに挿入するためには、INSERT INTO文を使用します。以下に、基本的なINSERT INTO文の形式を示します。

INSERT INTO my_table(id, name, age) VALUES(1, 'John Doe', 30);

このSQL文は、my_tableという名前のテーブルに新しい行を追加します。新しい行の各列の値は、VALUES句で指定します。この例では、id列の値は1、name列の値は’John Doe’、age列の値は30となります。

このSQL文をFlutterのexecuteメソッドを使用してデータベースに送信することで、新しい行がテーブルに追加されます。

なお、SQLiteでは、id列が主キーとして設定されている場合、同じid値を持つ行を複数追加することはできません。同じid値を持つ行を追加しようとすると、エラーが発生します。そのため、各行のid値は一意である必要があります。

データ挿入の実行

Flutterのsqfliteパッケージを使用して、先ほど作成したINSERT INTO文を実行し、SQLiteデータベースのテーブルにデータを挿入します。以下にその手順を示します。

まず、データベースの初期化関数を呼び出してデータベースインスタンスを取得します。

final Database db = await initializeDB();

次に、rawInsertメソッドを使用してSQL文を実行します。このメソッドは、引数としてSQL文を受け取り、そのSQL文をデータベースで実行します。

await db.rawInsert(
  "INSERT INTO my_table(id, name, age) VALUES(1, 'John Doe', 30)",
);

このコードは、my_tableという名前のテーブルに新しい行を追加します。新しい行のid列の値は1、name列の値は’John Doe’、age列の値は30となります。

これで、SQLiteデータベースのテーブルにデータが挿入されました。次に、このテーブルからデータを取得したり、テーブルのデータを更新したりする操作を行うことができます。

データの取得

データ取得のSQL文

SQLiteでデータを取得するためには、SELECT文を使用します。以下に、基本的なSELECT文の形式を示します。

SELECT * FROM my_table;

このSQL文は、my_tableという名前のテーブルから全ての行を取得します。*は全ての列を意味します。

特定の列だけを取得したい場合は、*の代わりに列名を指定します。例えば、nameとage列だけを取得するには以下のようにします。

SELECT name, age FROM my_table;

特定の条件を満たす行だけを取得したい場合は、WHERE句を使用します。例えば、ageが30以上の行だけを取得するには以下のようにします。

SELECT * FROM my_table WHERE age >= 30;

このSQL文をFlutterのqueryメソッドを使用してデータベースに送信することで、指定した条件に一致する行が取得できます。

データ取得の実行

Flutterのsqfliteパッケージを使用して、先ほど作成したSELECT文を実行し、SQLiteデータベースのテーブルからデータを取得します。以下にその手順を示します。

まず、データベースの初期化関数を呼び出してデータベースインスタンスを取得します。

final Database db = await initializeDB();

次に、rawQueryメソッドを使用してSQL文を実行します。このメソッドは、引数としてSQL文を受け取り、そのSQL文をデータベースで実行します。

List<Map> result = await db.rawQuery(
  "SELECT * FROM my_table",
);

このコードは、my_tableという名前のテーブルから全ての行を取得します。取得した結果は、マップのリストとして返されます。各マップは一つの行を表し、マップのキーは列名、値はその列の値となります。

これで、SQLiteデータベースのテーブルからデータを取得することができました。取得したデータは、アプリケーションで自由に使用することができます。

効率的なデータベース管理

非同期処理とSQLite

FlutterのSQLiteパッケージは非同期APIを提供しています。これは、データベース操作が時間を要する可能性があるため、これらの操作をバックグラウンドで行い、UIをブロックしないようにするためです。

SQLiteの各操作（例えば、データの挿入、取得、更新、削除）は、通常Futureを返す非同期関数として提供されます。これにより、asyncとawaitキーワードを使用してこれらの操作を簡単に非同期に行うことができます。

以下に、非同期処理とSQLiteの連携の基本的な例を示します。

Future<void> insertData(Database db, Map<String, dynamic> data) async {
  await db.insert('my_table', data);
}

Future<List<Map<String, dynamic>>> fetchData(Database db) async {
  return await db.query('my_table');
}

この例では、insertData関数はデータをデータベースに非同期に挿入し、fetchData関数はデータベースからデータを非同期に取得します。どちらの関数もasyncキーワードを使用して定義されており、awaitキーワードを使用してデータベース操作の完了を待っています。

エラーハンドリング

SQLiteの操作中にエラーが発生した場合、そのエラーを適切に処理することが重要です。エラーハンドリングを行うことで、アプリケーションの安定性を保つとともに、ユーザーに対して適切なフィードバックを提供することができます。

以下に、SQLiteの操作中にエラーが発生した場合の基本的なエラーハンドリングの例を示します。

Future<void> insertData(Database db, Map<String, dynamic> data) async {
  try {
    await db.insert('my_table', data);
  } catch (e) {
    // エラーハンドリング
    print('An error occurred while inserting data: $e');
    // 必要に応じてユーザーにエラーメッセージを表示するなどの処理を行う
  }
}

Future<List<Map<String, dynamic>>> fetchData(Database db) async {
  try {
    return await db.query('my_table');
  } catch (e) {
    // エラーハンドリング
    print('An error occurred while fetching data: $e');
    // 必要に応じてユーザーにエラーメッセージを表示するなどの処理を行う
    return [];
  }
}

この例では、try-catchブロックを使用してエラーを捕捉しています。tryブロック内でデータベース操作を行い、エラーが発生した場合はcatchブロックでエラーを捕捉します。エラーメッセージはログに出力され、必要に応じてユーザーにエラーメッセージを表示するなどの処理を行います。

エラーハンドリングは、アプリケーションの安定性とユーザーエクスペリエンスを保つために重要な作業です。エラーが発生した場合でも、適切な処理を行うことでアプリケーションのクラッシュを防ぎ、ユーザーに対して適切なフィードバックを提供することができます。