RalaCode

44件の記事があります

Reactで環境変数を読み込む【開発・本番で切り替え可能】

Reactで環境変数を読み込む【開発・本番で切り替え可能】
サムライエンジニアプラス

「Reactで環境変数を使いたい」

今回は上記の悩みにお答えします。

Reactでは、以下のパターンで環境変数を使い分けることが可能です。

  • 開発環境

  • 本番環境

というわけで、この記事では主に以下を解説します。

  • Reactで環境変数を使う方法

  • 「開発環境」と「本番環境」で環境変数を切り替える方法

また、解説は「create-react-appでReactアプリを作成している」という前提で進めていきます。

環境変数を使う方法

手順は以下です。

  • プロジェクトのルートディレクトリに「.env」というファイルを作る

  • 「.env」の中で環境変数を定義する

  • 「process.env.(変数名)」で呼び出す

順番に見ていきます。

「.env」を作る

「.env」をルートディレクトリに作成する

まず、「.env」というファイルを作ります。
作る場所は、ルートディレクトリです。

上記の画像で示した位置です。
「.gitignore」などと同じ階層ですね。

環境変数を定義する

では、「.env」に環境変数を定義します。
今回は例として、以下のようにしてみました。

REACT_APP_HELLO_WORLD="Hello, world!"

変数名は「REACT_APP_〜」の形にしないと上手くいきません。

環境変数を読み込む

では「App.js」で、環境変数を読み込んでみましょう。

/* App.js */

const App = () => {
  return (
    <h1 style={{margin: "2em"}}>
      {process.env.REACT_APP_HELLO_WORLD}
    </h1>
  );
};

export default App;

上記のように、環境変数は「process.env.(変数名)」という形で呼び出します。

ここで、「開発モード」でローカルサーバーを起動しましょう。
ターミナルで、以下を入力して実行します。

$ npm start

すでに実行している場合は、一度停止してもう一回実行してください。

「Hello, world!」と表示されている

ブラウザで「localhost:3000」にアクセスします。
上記のように表示されれば成功です。

backgound-colorは、cssで見やすい色に変えました。

ローカルサーバーは一度停止させて、次に進みます。

「開発環境用」の環境変数を使いたいとき

「開発環境だけで使える環境変数を定義できたらいいな...」

次は上記を解決していきます。

結論から言うと、「.env.development」というファイルに環境変数を定義するだけです。

「.env.development」をルートディレクトリに作成

では、「.env.development」をルートディレクトリに作ります。
ここでは、あえて「.env」は残してみましょう。

「.env.development」には、以下のように記述してみます。

REACT_APP_HELLO_WORLD="Hello, development!"

変数名は、「.env」で定義したものと同じ「REACT_APP_HELLO_WORLD」にしています。

ですが、中身は「"Hello, development!"」です。

この場合、「.env」と「.env.development」の環境変数はどっちが採用されるんでしょうか。

では、また「開発モード」でローカルサーバーを起動します。

$ npm start
「Hello, development!」と表示される

上記のように表示されます。

つまり、開発環境では「.env」よりも「.env.development」の環境変数が優先されるわけです。

「本番環境用」の環境変数を使いたいとき

「本番環境のみで使える環境変数もあったらいいな...」

こういうときは、「.env.production」というファイルに環境変数を定義すれば大丈夫です。

「.env.production」をルートディレクトリに作成

上記のように、「.env.production」をルートディレクトリに作ります。
.env」と「.env.development」もあえて残してあります。

「.env.production」には以下のように記述してみましょう。

REACT_APP_HELLO_WORLD="Hello, production!"

「.env」と「.env.development」にもある「REACT_APP_HELLO_WORLD」という環境変数に、「"Hello, production"」という文字列を入れています。

では、本番環境でのアプリ表示を確認してみましょう。

まず、ターミナルで以下を入力して実行します。

$ npm run build
「npm run build」を実行すると「build」フォルダが作られる

するとルートディレクトリに「build」というフォルダが作られます。
これをデプロイすることで、インターネット上にReactアプリが公開されます。

でも、いちいちデプロイするのは面倒...。

というわけで、今回は「本番環境でのアプリ表示を簡単に確認する方法」をご紹介します。

では、ターミナルに以下を入力して実行します。

$ npm install -g serve

続けて以下を入力して実行します。

$ serve -s build

これにより、「本番環境モード」でローカルサーバーが起動します。
localhost:3000」にアクセスしてみましょう。

「Hello, production!」と表示される

上記のように表示されると思います。

.env.production」で定義した環境変数が反映されていますね。

まとめ

最後に記事の内容をまとめます。

Reactで環境変数を使う手順は以下です。

  • ルートディレクトリに「.env」というファイルを作る

  • 「.env」に環境変数を定義する

  • 「process.env.(変数名)」という形で呼び出す

そして、「開発環境用」と「本番環境用」で環境変数を切り替えることができます。

  • 「.env.development」というファイルで定義した環境変数は、開発環境のみで使える

  • 「.env.production」というファイルで定義した環境変数は、本番環境のみで使える

「別に、自分は開発環境と本番環境で使い分けないよ...」

っていう場合は、「.env」だけ使えばオッケーって感じですかね。

というわけで、記事は以上です。

あなたにおすすめ

サムライエンジニアプラス

この記事を共有

以下のボタンを押すとSNSが開きます

関連記事

【Mac向け】nvmでNode.jsをインストールする方法

【Mac向け】nvmでNode.jsをインストールする方法

【フォーム送信を実装】Getform.ioの使い方を解説【HTMLのみでOK】

【フォーム送信を実装】Getform.ioの使い方を解説【HTMLのみでOK】

Reactで作ったアプリをNetlifyにデプロイする方法

Reactで作ったアプリをNetlifyにデプロイする方法

ReactとFirebaseで認証機能を実装する方法【作りながら解説】

ReactとFirebaseで認証機能を実装する方法【作りながら解説】

【TypeScriptあり】Node.jsとReactでWebアプリを作る【Express使います】

【TypeScriptあり】Node.jsとReactでWebアプリを作る【Express使います】

【最新バージョン対応】React Routerの使い方を解説

【最新バージョン対応】React Routerの使い方を解説

RalaCodeTwitter
© 2022 RalaCode | Privacy Policy