Flutter APIキー等を記載した秘匿ファイルを読み込むflutter_dotenv

やりたいこと

Flutterアプリで使うAPIキーをソースファイルに書かずに使用したい。

やり方

• .envファイルを作成する
• .envを.gitignoreに追記する
• flutter_dotenvをインストールする
• main()で.envファイルを読み込む
• 必要な箇所で環境変数を読む

.envファイルを作成する

プロジェクトのルートディレクトリに作成します。
.env

HOGEHOGE=hogehoge

.envを.gitignoreに追記する

.gitignore

.env

flutter_dotenvをインストールする

下記を記載してUpgradeを実行。
pubspec.yaml

dependencies:
  flutter_dotenv: ^3.1.0

ソースファイルでimport。
main.dart

import 'package:flutter_dotenv/flutter_dotenv.dart' as DotEnv;

main()で.envファイルを読み込む

main.dart

Future main() async {
  await DotEnv.load();
  runApp(MyApp());
}

ライブラリは非同期で動作するようなのでasync awaitが必要。

必要な箇所で環境変数を読む

main.dart

DotEnv.env['HOGEHOGE']

HOGEHOGEは.envに記載した環境変数名です。

備考

flutter_dotenvの詳細は下記ページを参照。
pub.dev

flutter_dotenvのバージョン3系と2系では書き方が異なるようです。

blog.mbaas.nifcloud.com