はじめに (対象読者・この記事でわかること)

この記事は、FlutterやDartでの非同期処理に興味のある開発者、特に「awaitはasyncが付いていないメソッドでは使用できません」というエラーに遭遇したことがある方を対象としています。

この記事を読むことで、以下の点が理解できるようになります。

  • await キーワードがasyncキーワードの付いたメソッド内でしか使用できない理由
  • 非同期処理を適切に扱うためのDartの基本的な仕組み
  • asyncが付いていないメソッドで非同期処理の結果を使いたい場合の具体的な解決策

本記事は、Dartの非同期処理における基本的な誤解を解消し、より効率的でバグのないコードを書くための一助となることを目指しています。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。

  • Dartの基本的な文法
  • 非同期処理の概念（コールバック、Futureなど）の初歩的な理解
  • Flutterでの簡単なUI開発経験

「awaitはasyncが付いていないメソッドでは使用できません」エラーの発生メカニズム

Dartにおける非同期処理は、Futureというオブジェクトを中心に構築されています。Futureは、将来的に完了する値やエラーを表すもので、非同期処理の結果を扱うための主要な仕組みです。

awaitキーワードは、このFutureが完了するのを待ち、その結果を取り出すために使用されます。しかし、awaitは魔法の呪文ではありません。Dartの言語仕様として、awaitは必ずasyncキーワードが付与されたメソッド内でのみ有効となります。

なぜasyncが必要なのでしょうか？それは、asyncメソッドがDartランタイムに対して「このメソッドは非同期処理を実行する可能性がある」というシグナルを送るためです。asyncメソッドは、内部でFutureを返すか、あるいはawaitを使用して他のFutureの結果を待つことができます。

asyncが付いていない通常のメソッド（同期メソッド）内でawaitを使用しようとすると、Dartコンパイラはその時点でエラーを検出します。なぜなら、同期メソッドは定義上、実行が完了するまで処理をブロックしないため、awaitのような「待機」を伴う操作を直接的に扱えないからです。asyncが付いていないメソッドは、Futureを返したり、awaitを使用したりすることが許可されていません。

このエラーは、非同期処理の非同期性を保つためのDartの設計思想に根ざしています。awaitはasyncというコンテキストがあって初めて意味を成すものであり、この分離によってコードの可読性と安全性が向上しています。

asyncが付いていないメソッドで非同期処理の結果を利用する方法

前述の通り、asyncが付いていないメソッド内でawaitを使用することはできません。しかし、非同期処理の結果を同期的な文脈で利用したい、あるいはasyncを付けられないメソッドで非同期処理を扱いたい場面は少なくありません。ここでは、そのような状況で利用できる具体的な解決策をいくつかご紹介します。

1. メソッドにasyncを付与する

最も基本的かつ推奨される方法です。もし、そのメソッドが非同期処理の結果を必要とし、かつasyncを付与しても問題がないのであれば、シンプルにメソッド定義にasyncを追加してください。

Dart

// asyncが付いていない場合（エラー発生）
// String getUserName() {
//   var user = await fetchUserData(); // awaitはasyncがないと使えない
//   return user.name;
// }

// asyncを付与した場合（解決）
Future<String> getUserName() async {
  var user = await fetchUserData(); // asyncが付いているのでawaitが使用可能
  return user.name;
}

// fetchUserData()はFuture<User>を返す非同期関数と仮定
Future<User> fetchUserData() async {
  // 実際のデータ取得処理...
  await Future.delayed(Duration(seconds: 1));
  return User(name: 'Alice');
}

class User {
  final String name;
  User({required this.name});
}

この方法の利点は、コードが直感的になり、非同期処理のフローが追跡しやすくなることです。asyncを付与すると、メソッドは自動的にFutureを返します。

2. .then() を使用する

async/awaitが登場する以前から使われている、Futureを扱うための標準的な方法です。Futureオブジェクトの.then()メソッドにコールバック関数を渡すことで、Futureが完了した際に実行される処理を記述します。

Dart

String getUserNameSynchronous() {
  String userName = '';
  fetchUserData().then((user) {
    userName = user.name;
    // ここでuserNameを使用する処理を記述
    print('User name: $userName');
  }).catchError((error) {
    print('Error fetching user data: $error');
  });

  // 注意：この時点では userName はまだ設定されていない可能性がある
  // print('Before then callback: $userName'); // '' または空文字列が出力される可能性が高い
  return userName; // 非同期処理完了前に返されるため、期待通りの値にならない場合がある
}

// fetchUserData()はFuture<User>を返す非同期関数と仮定
Future<User> fetchUserData() async {
  await Future.delayed(Duration(seconds: 1));
  return User(name: 'Bob');
}

class User {
  final String name;
  User({required this.name});
}

.then()の注意点:

  • .then()は非同期処理が完了した後にコールバックを実行するため、.then()の呼び出し元メソッドが完了する前に結果が利用可能になるとは限りません。上記のgetUserNameSynchronousの例では、fetchUserData().then(...)が実行されても、その直後にuserNameが返されるわけではありません。
  • 結果を同期的に返したい場合には、この方法は適していません。
  • 複雑な非同期処理の連鎖になると、コールバックがネストし（コールバック地獄）、コードが読みにくくなることがあります。

3. await で取得した結果を引数として渡す

非同期処理の結果を、asyncが付与された別のメソッドで取得し、その結果をasyncが付与されていないメソッドに引数として渡すというアプローチです。

Dart

// 非同期処理を行うメソッド（asyncを付与）
Future<User> _fetchUserDataAsync() async {
  await Future.delayed(Duration(seconds: 1));
  return User(name: 'Charlie');
}

// 結果を同期的なメソッドに渡す
void processUserName(String name) {
  print('Processing user name: $name');
}

// これらを呼び出すためのラッパーメソッド（asyncを付与）
Future<void> displayUserName() async {
  User user = await _fetchUserDataAsync();
  processUserName(user.name); // 結果を引数として渡す
}

class User {
  final String name;
  User({required this.name});
}

この方法では、非同期処理そのものはasyncメソッド内で行い、その結果を同期的な処理を行うメソッドに引き渡すことで、asyncが付いていないメソッドの制約を回避します。

4. State Management を活用する（Flutter特有）

Flutterアプリケーション開発においては、UIの状態管理が重要になります。非同期処理の結果をUIに反映させたい場合、Provider、Riverpod、Blocなどの状態管理ライブラリを活用するのが一般的です。

これらのライブラリは、非同期処理の完了を検知し、UIを自動的に更新する仕組みを提供しています。asyncが付いていないメソッドで直接結果を扱うのではなく、状態管理を通じて非同期処理の結果を管理し、UIに通知することで、間接的に非同期処理の結果を利用します。

例えば、FutureBuilderウィジェットは、Futureの実行状態（ロード中、完了、エラー）に応じて異なるUIを表示できるため、非同期処理の結果をUIに反映させる際によく利用されます。

Dart

// Providerを使った例（概念的な説明）
// 1. 非同期処理を行うNotifierを作成（例：ChangeNotifier, StateNotifier）
// 2. Notifier内で非同期処理を実行し、結果を保持する
// 3. UI側でProvider経由でNotifierの状態を監視し、結果を表示する

// FutureBuilderを使った例
Widget build(BuildContext context) {
  return FutureBuilder<User>(
    future: fetchUserData(), // 非同期処理を呼び出す
    builder: (BuildContext context, AsyncSnapshot<User> snapshot) {
      if (snapshot.connectionState == ConnectionState.waiting) {
        return CircularProgressIndicator(); // ローディング中
      } else if (snapshot.hasError) {
        return Text('Error: ${snapshot.error}'); // エラー時
      } else if (snapshot.hasData) {
        return Text('User: ${snapshot.data!.name}'); // データ取得成功時
      } else {
        return Text('No data'); // データがない場合
      }
    },
  );
}

// fetchUserData()はFuture<User>を返す非同期関数と仮定
Future<User> fetchUserData() async {
  await Future.delayed(Duration(seconds: 2));
  return User(name: 'David');
}

class User {
  final String name;
  User({required this.name});
}

このアプローチは、Flutterアプリ開発において非同期処理の結果をUIにスムーズに統合するための強力な手段となります。

5. dart:async の Zone を利用する (高度なテクニック)

これは一般的なケースではありませんが、非常に特殊な状況下では、DartのZoneを利用して、非同期処理のコンテキストを管理することがあります。しかし、Zoneの概念は複雑であり、通常は推奨される方法ではありません。理解し、慎重に使用する必要があります。

まとめ

本記事では、Flutter/Dart開発において遭遇しがちな「awaitはasyncが付いていないメソッドでは使用できません」というエラーについて、その原因と解決策を詳細に解説しました。

  • エラーの原因: awaitはasyncメソッド内でしか使えず、同期メソッドでは利用できないDartの言語仕様によるものです。
  • 解決策:
    • メソッドにasyncを付与し、Futureを返すようにする（最も推奨）。
    • .then()メソッドを使用してコールバックで非同期処理の結果を扱う。
    • 非同期処理の結果を引数として同期的なメソッドに渡す。
    • Flutterでは、ProviderやFutureBuilderなどの状態管理・UI構築ウィジェットを活用する。
  • 重要な考え方: 非同期処理は、その性質上、完了を待つための特別なコンテキスト（asyncメソッド）が必要です。

この記事を通して、Dartの非同期処理の仕組みと、awaitを効果的に使用するための方法論を理解していただけたことと思います。今後は、さらに複雑な非同期処理のパターンや、エラーハンドリングについて深掘りした記事も作成する予定です。

参考資料