【Flutter/Dart】コンストラクタで非同期処理を行いたい場合の対応

課題

Dartであるクラスのコンストラクタで非同期処理をしたい場合がある。

例えば、リモートデータベースから取得した値を初期値とする場合など。

しかし、下記の構文はコンパイルエラーになる。

class testClass{

  testClass()async{  
    await _init();
  }
//← The modifier 'async' can't be applied to the body of a constructor.

  Future<void> _init()async{
    await Future.delayed(const Duration(seconds: 1));
  }
}

コンストラクタはtestClassを返すべきで、Future<testClass>を返すものではない、という思想らしい。

ちなみに以下はコンパイルは通るが、_init()の完了を待たない

class testClass{

  testClass(){  
　　　_init();
  }

  Future<void> _init()async{
    await Future.delayed(const Duration(seconds: 1));
  }
}

つまり、

class testClass{

  testClass(){  
　　　_init();
    debugPrint("construct");
  }

  Future<void> _init()async{
    await Future.delayed(const Duration(seconds: 1));
    debugPrint("init");
  }
}

void main(){

  testClass _test = testClass();
  debugPrint("done");
}

の実行結果は

flutter: construct
flutter: done
flutter: init

となる。

対応方法

インスタンスを生成するstaticなメソッドを作る。

class testClass{

  testClass(){

  }

  static Future<testClass> create()async{
    testClass _test = testClass();
    await _test._init();
    debugPrint("construct");
    return _test;
  }

  Future<void> _init()async{
    await Future.delayed(const Duration(seconds: 1));
    debugPrint("init");
  }
}

下記を実行すると

void main()async{

    testClass _test = await testClass.create();
    debugPrint("done");
}

flutter: init
flutter: construct
flutter: done

無事期待通りの順番になった。

最後に

この話題に関しては、staticメソッドではなくコンストラクタでできるようにして欲しいとか、そもそもコンストラクタでawaitするべきではないとか色々論争はあるみたい。

参考

Allow async constructors (or at least factory constructors)

Calling an async method from a constructor in Dart