Dartにおけるシングルトンクラスの作り方につきまして

Question

■利用しているDartのバージョン
Dart ver: v3.56.0

■概要
これまであまりクラスのデザインパターン等を意識して利用したことがなかったのですが、sqlliteというパッケージを学んでいる際に以下のようなコードに出会いました。勉強の参考にさせていただいたQiitaの記事はこちらです。
staticや_createInstance()周りのコードが理解できずに調べているとこれはおそらくシングルトンというクラスを作りたいのかというところに行きつきました。

ともすると、一つわからない点が生じるのですが、Dart-シングルトンの組み合わせで学んでいると、クラス内でインスタンスを生成しそのインスタンスを同じクラス内でfactory Singleton(){ return _instance;}のようにfactory constructorを利用しているようですが、そのようなコードは見たりません。

その一方で、DbHelper._createInstance(); //???のように何らかのコンストラクタを呼び出しているようにも見えます。

■ご質問

1. このコードはそもそもデザインパターンでいうシングルトンクラスを作ろうとしている理解であっていますか？
2. そうであるとしたら、なぜ一般的なfactoryコンストラクタを使わずにこのような記述になっているのでしょうか（シンタックスシュガーか何かでしょうか？
3. そうでないとしたら、どのようなデザインパターンの視点でこのコードを学べば良いのでしょうか？

よろしくお願い申し上げます。

import 'package:flutter_crud/model/cats.dart';
import 'package:path/path.dart';
import 'package:sqflite/sqflite.dart';

// catsテーブルのカラム名を設定
const String columnId = '_id';
const String columnName = 'name';
const String columnGender = 'gender';
const String columnBirthday = 'birthday';
const String columnMemo = 'memo';
const String columnCreatedAt = 'createdAt';

// catsテーブルのカラム名をListに設定
const List<String> columns = [
  columnId,
  columnName,
  columnGender,
  columnBirthday,
  columnMemo,
  columnCreatedAt,
];

// catsテーブルへのアクセスをまとめたクラス
class DbHelper {
  // DbHelperをinstance化する
  static final DbHelper instance = DbHelper._createInstance();
  static Database? _database;

  DbHelper._createInstance(); //???

  // databaseをオープンしてインスタンス化する
  Future<Database> get database async {
    return _database ??= await _initDB();       // 初回だったら_initDB()=DBオープンする
  }

  // データベースをオープンする
  Future<Database> _initDB() async {
    String path = join(await getDatabasesPath(), 'cats.db');    // cats.dbのパスを取得する

    return await openDatabase(
      path, 
      version: 1, 
      onCreate: _onCreate,      // cats.dbがなかった時の処理を指定する（DBは勝手に作られる）
    );
  }
  
  // データベースがなかった時の処理
  Future _onCreate(Database database, int version) async {
    //catsテーブルをcreateする
    await database.execute('''
      CREATE TABLE cats(
        _id INTEGER PRIMARY KEY AUTOINCREMENT,
        name TEXT,
        gender TEXT,
        birthday TEXT,
        memo TEXT,
        createdAt TEXT
      )
    ''');
  }

  // catsテーブルのデータを全件取得する
  Future<List<Cats>> selectAllCats() async {
    final db = await instance.database;
    final catsData = await db.query('cats');          // 条件指定しないでcatsテーブルを読み込む

    return catsData.map((json) => Cats.fromJson(json)).toList();    // 読み込んだテーブルデータをListにパースしてreturn
  }

// _idをキーにして1件のデータを読み込む
  Future<Cats> catData(int id) async {
    final db = await instance.database;
    var cat = [];
    cat = await db.query(
      'cats',
      columns: columns,
      where: '_id = ?',                     // 渡されたidをキーにしてcatsテーブルを読み込む
      whereArgs: [id],
    );
      return Cats.fromJson(cat.first);      // 1件だけなので.toListは不要
  }

// データをinsertする
  Future insert(Cats cats) async {
    final db = await database;
    return await db.insert(
      'cats',
      cats.toJson()                         // cats.dartで定義しているtoJson()で渡されたcatsをパースして書き込む
      );
  }

// データをupdateする
  Future update(Cats cats) async {
    final db = await database;
    return await db.update(
      'cats',
      cats.toJson(),
      where: '_id = ?',                   // idで指定されたデータを更新する
      whereArgs: [cats.id],
    );
  }

// データを削除する
  Future delete(int id) async {
    final db = await instance.database;
    return await db.delete(
      'cats',
      where: '_id = ?',                   // idで指定されたデータを削除する
      whereArgs: [id],
    );
  }
}

Answer 1

このコードはそもそもデザインパターンでいうシングルトンクラスを作ろうとしている理解であっていますか？

そう考えてもいいと思います。

そうであるとしたら、なぜ一般的なfactoryコンストラクタを使わずにこのような記述になっているのでしょうか（シンタックスシュガーか何かでしょうか？

名前付きのコンストラクタ、この場合はDbHelper._createInstance()になりますが、これを書くことでフォルトコンストラクタDbHelper()での呼び出しができないようにしています。また_を付けることでプライベート化するので、外部からのインスタンス生成ができなくなります。

factoryで書くことも可能だけど、それだと若干実装行数が増えるのでこのような形にしたのではないでしょうか。

https://gist.github.com/AbedElazizShe/2817592ce7d2070c5a0d1c73a220e85a
こっちがfactoryで書いた例になるのかな。

Comments

[mako_0221]

ありがとうございます、いずれの方法でもできるが簡便的な実装方法によっているという理解をいたしました。
大変申し訳ないのですが、どうしても調べても以下の点にピント来ないのですが
static Dbhelper instance = Dbhelper._createInstance();//(1)
Dbhelper._createInstance(); //(2)
(2)で名前付きコンストラクタが実行される
(1)で同じように名前付きコンストラクタだ実行されてinstance変数に格納されている
ということなのかと推察していますが、instanceに入れることは別として、 Dbhelper._createInstance()が2回実行されるのはここでは直感的にどのようにとらえればよいのでしょうか？

[ta.fu]

2回実行されているわけではありません。
(1)の方はDbhelperのインスタンスを作りそれを代入。
(2)は名前付きコンストラクタの定義です。
コンストラクタは{}が付いたファンクションボディと呼ばれる定義と;のみの定義ができます。
;の場合は{}と同等(仕様上はempty body {}と書いてある)と認識されます。
Dart2.10仕様書の10及び10.6.1に記載があります。

あと、意味は書いてないけど、
https://dart.dev/guides/language/language-tour#constructors
のPointに;で終わるコンストラクタが書いてあります。

[mako_0221]

ありがとうございます！
(1)の方はDbhelperのインスタンスを作りそれを代入。の「それ」とは何を指しているのでしょうか？定義した名前付きコンストラクタを差していると思っていいのでしょうか？
また、2回実行されていないとしたら、1回実行されているとしたら(1)で実行されていて、実行された結果がinstanceに格納されているイメージであっていますか？
分かりづらい表現で申し訳ございません。

[ta.fu]

「それ」は「インスタンス」のことです。
DbhelperのインスタンスをDbhelper._createInstance()で作成し、そのインスタンスを変数instanceに代入する。
(1)の部分は、上記の様な処理になるということです。

[mako_0221]

ありがとうございます。
最後に念の為の確認ですが、(1)のDbhelper._createInstance()でインスタンスを作成して、変数に格納していることはわかったのですが、(2)のDbhelper._createInstance()はインスタンスの作成はしておらず、単なる名前付きコンストラクタの定義と認識して差し支えないでしょうか？

[ta.fu]

そうです。

[mako_0221]

最後までありがとうございます。まだ少し記述の方法として、直感的になるほどというところまで腹落ちはしていないのですが、漠然と意味がわからないコードについて、何をしたいのかは理解できました。
お力添えに御礼申し上げます。