Firebase for Cloud Functionsで環境変数を使用する

公開日: 2021-09-04

更新日: 2021-09-04

  • Tech
  • Firebase
  • Node.js
  • Tips

前提

  • Firebase CLIがインストール済み
  • Firebaseプロジェクトが作成済み
  • firebase initでプロジェクトの初期化が完了済み(functionsディレクトリがある)
  • TypeScriptを使用(importの仕方が異なる可能性があります)


環境変数の設定

まずは環境変数をFirebase CLIで設定します。

$ firebase functions:config:set <project id>.<key>=<value>

ex. project idが"sample-app"でsecretキーに値を設定する場合。

$ firebase functions:config:set sample-app.secret="apisecret"

ここで、<key>には大文字が使えないので注意が必要です。

次に.runtimeconfig.jsonを生成します。

$ firebase functions:config:get > .runtimeconfig.json

これで設定は完了です。うまくいけば以下のようなファイルが出力されるはずです。

{
  "sample-app": {
    "secret": "apisecret",
  }
}

当然のことですが、Gitを使用している場合は.runtimeconfig.jsonを.gitignoreに含めておきましょう。

環境変数を使用する

次に、コード上で環境変数を使用します。

import * as functions from 'firebase-functions';
import * as admin from 'firebase-admin';

// init
admin.initializeApp();

const config = functions.config()
const env = config["sample-app"]

console.log(env.secret)  // output: apisecret

これで環境変数が使えるようになりました!

補足(Firebase CLI 関連コマンド)

プロジェクトリストの表示

$ firebase projects:list

各プロジェクトの環境変数リストを表示

$ firebase functions:config:get


yona

yona

琉球大学の理学部に所属している大学3年生です。 趣味と仕事でWebアプリ開発やシステム開発をしています。