dart-fix-static-analysis-errors

Dart の静的解析エラーの解決

目次

• 診断の実行
• Null 安全性と型解決
• フロー解析と型の昇格
• アナライザーの設定
• ワークフロー：静的解析の問題の修正
• 例

診断の実行

Dart アナライザーを実行して、コードベース全体の静的エラー、警告、情報レベルの診断を特定します。

• $ dart analyze を実行して、現在のディレクトリにあるすべての Dart ファイルを解析します。
• パスを追加して、対象のディレクトリまたはファイルを指定します：$ dart analyze bin または $ dart analyze lib/main.dart。
• --fatal-infos フラグを使用すると、情報レベルの問題でも失敗するようにして、厳格さを高められます。
• サポートされている診断に自動クイックフィックスを適用するには、$ dart fix --apply を実行します。まず $ dart fix --dry-run で変更をプレビューしてください。

Null 安全性と型解決

Dart の健全な Null 安全性と厳密な型システムに関連する静的エラーに対処します。

• Null 許容性： 型に ? を追加して、null を明示的に許容します（例：String?）。
• アサーション： null 許容式が null ではないと保証できる場合は、後置のバング演算子 ! を使って、基になる null 非許容型にキャストします。
• 遅延初期化： 初回読み取り前に必ず初期化されるトップレベル変数またはインスタンス変数には、late 修飾子を適用します。これにより、アナライザーの確定的な代入チェックを回避できます。
• 名前付きパラメーター： デフォルト値がなく、null も許容できない名前付きパラメーターには、required 修飾子を使います。
• 明示的なダウンキャスト： 静的解析で暗黙的なダウンキャストが許可されない場合（例：List<Animal> を List<Cat> に代入する場合）は、明示的なキャスト as List<Cat> を使います。
• ジェネリック型： ジェネリッククラスには、常に明示的な型注釈を指定します（例：List<String>、Map<String, dynamic>）。デフォルトで dynamic となる、型引数のない List や Map は避けてください。

フロー解析と型の昇格

Dart の制御フロー解析を活用し、手動でキャストすることなく、null 許容型を null 非許容型に安全に昇格させます。

• Null チェック： ローカル変数が null かどうかを確認します（例：if (value != null)）。そのブロック内では、型が自動的に null 非許容型に昇格します。
• 型テスト： is 演算子（例：if (value is String)）を使って、変数を特定のサブクラスまたは型に昇格させます。
• 早期リターン： 変数が null の場合、または型が異なる場合は、早期リターン、break、throw を使って制御フローの経路を抜けます。これにより、スコープの残りの部分では、アナライザーが変数の型を昇格させます。
• 到達可能性： 常に例外をスローするかプロセスを終了する関数には、Never 型を使います。アナライザーはこれを使って、到達不能なコード経路を判定します。

アナライザーの設定

パッケージのルートにある analysis_options.yaml ファイルを設定して、型チェックを厳格化し、リンターのルールをカスタマイズします。

• strict-casts: true を有効にして、dynamic からの暗黙的なダウンキャストを防ぎます。
• strict-inference: true を有効にして、型を推論できない場合にアナライザーが dynamic にフォールバックするのを防ぎます。
• strict-raw-types: true を有効にして、ジェネリック型に明示的な型引数を必須にします。
• ファイル内の特定の診断を抑制するには、// ignore_for_file: <diagnostic_name> を使います。
• 特定の行の診断を抑制するには、// ignore: <diagnostic_name> を使います。

ワークフロー：静的解析の問題の修正

Dart プロジェクトの静的解析エラーを解決するには、次の手順に沿って進めます。

タスクの進捗チェックリスト

このチェックリストをコピーして、進捗を記録してください。

• $ dart analyze を実行して、エラーのベースラインを確認します。
• $ dart fix --apply を実行して、自動修正可能な問題を解決します。
• 残っている Null Safety エラー（?、!、late、required）に対処します。
• 残っている型システムのエラー（明示的な as キャスト、ジェネリック型の注釈）に対処します。
• $ dart analyze を実行して、すべてのエラーが解決されたことを確認します。
• テストを実行するかアプリケーションを起動して、修正によって実行時例外（例：as キャストの失敗や未初期化の late 変数）が発生していないことを確認します。

条件付きロジック

• 異なるバージョンのコード（レガシー Dart 2.9）が混在している場合： dart run または flutter run に --no-sound-null-safety を指定するか、エントリーポイントファイルの先頭に // @dart=2.9 を追加して、サウンド Null Safety を一時的に無効にします。
• フィールドがプライベートで final の場合： フロー解析による型の昇格を利用します。
• フィールドがパブリックまたは final でない場合： フロー解析では型を昇格できません。フィールドをローカル変数にコピーし、そのローカル変数が null かどうかを確認してから使用します。

フィードバックループ

1. バリデーターを実行： $ dart analyze
2. エラーを確認： ファイル、行番号、診断コードを特定します。
3. 修正： 適切な Null Safety または型解決の修正を適用します。
4. 繰り返し： $ dart analyze が「No issues found!」を返すまで続けます。

例

ローカル変数への代入による型の昇格

null 許容のインスタンスフィールドを扱う場合は、フロー解析を有効にするためにローカル変数にコピーします。

誤り（解析に失敗）：

class Coffee {
  String? _temperature;

  void checkTemp() {
    if (_temperature != null) {
      // ERROR: Property cannot be promoted because it is not a local variable.
      print(_temperature.length); 
    }
  }
}

正しい例：

class Coffee {
  String? _temperature;

  void checkTemp() {
    final temp = _temperature; // Copy to local variable
    if (temp != null) {
      // SUCCESS: 'temp' is promoted to non-nullable String.
      print(temp.length); 
    }
  }
}

厳格なアナライザー設定

厳格な型安全性を強制するため、次の analysis_options.yaml を設定します。

include: package:lints/recommended.yaml

analyzer:
  language:
    strict-casts: true
    strict-inference: true
    strict-raw-types: true
  errors:
    invalid_assignment: error
    missing_return: error
    dead_code: info