axiosで行う通信を本番環境と開発環境で切り替える方法を教えてください

Question

前提・実現したいこと

フロントエンドにReact、サーバーサイドにGolangを用いた簡易な記事投稿サイトを作成しています。
フロントエンドからサーバーサイドへの通信にはaxiosを利用しております。
ローカル環境では問題なくaxiosを用いて通信できるのですが、
本番環境でも問題なく通信できるようにする方法がわかっていません。
本番環境はawsにデプロイする予定です。
具体的には以下の２点に関して皆様の知見をご教授いただきたいです。

1. 本番環境と開発環境でaxiosのurlを切り替える方法
2. 本番環境で何をaxiosのurlに渡せば良いのか

該当のソースコード

現在はローカル限定なので、以下のようにaxiosのurlを直接指定しております。
しかしこれではローカルでしか稼働しないため、上記の２点の問題が生じております。

    axios
      .get('http://localhost:2345/api/article/' + this.props.match.params.id)
      .then(response => {
        this.setState({article: response.data});
      })
      .catch(response => console.log('ERROR!! occurred in Backend.'));

補足情報（FW/ツールのバージョンなど）

フロントエンド：React/axios
サーバーサイド：Golang/gin
デプロイするサーバー：aws(予定)

以上お手数ですが、ご教授いただけると幸いです。よろしくお願いいたします。

Answer 1

• フロントエンドでは環境変数が使えない
• 簡単でシンプルな方法が良い

上を鑑みて私がいつも採る方法は 可変なconfig.jsを用意する です。

まず

config.development.js
config.productions.js

を用意します。
（staging環境もあるのなら config.staging.js も用意します）

各ファイルの内容は次のようにします。

config.development.js

export const apiURL = 'http://localhost:8080' // 開発環境のURL

config.production.js

export const apiURL = 'https://example.com' // 本番環境のURL

あとは環境に応じて cp config.development.js config.js もしくは cp config.production.js config.js を実行するだけです。
そして config.js は .gitignore に追記しておきましょう。
これで環境ごとに config.js の内容を切り替えられますし、git管理も適切に行えます。

これらを利用すると、APIを叩くコードは次のようになるでしょう。

import axios from 'axios'
import { apiURL } from './config'

const axiosInstance = axios.create({
  baseURL: apiURL, 
});

const doSomething = async () => {
  const { data } = await axiosInstance.get('/hello')
  console.log(data)
}

doSomething()

私としては create-react-app の仕組みに依存したくないという理由から REACT_APP_XXXXXX はあまりおすすめしません。
業務で create-react-app を使う場合も少ないと思います。
私が示した方法はJSのモジュールシステムを利用しているだけなので、どのような場合でも使える汎用的なものです。
そして create-react-app 特有のよくわからないブラックボックスな仕組みを使うよりも何が起こっているかを理解しながら書けますし簡単です。

もう一つ REACT_APP_XXXXXX を使いたくない理由は、サーバーサイドNode.jsで環境変数を取得するのと同じ process.env でアクセスするので、初心者が環境変数を扱っていると勘違いしやすい という点です。
サーバの環境変数は外から見えない変数なので、AWSシークレットキーなどの機密情報をセットするのにもよく使われます。
しかしフロントエンドでは環境変数は扱えないので、 REACT_APP_XXXXXX も create-react-appが用意した環境変数っぽくアクセスできる何か でしかありません。
初心者が勘違いしてここにシークレットキーをセットしてしまう場合がありそうで、その意味でも有害だと思っています。
実際、先日勘違いした方の質問に回答しましたがなかなか理解してもらえませんでした。

Comments

[退会済みユーザー]

この件は結局どうなったのでしょうか？

Answer 2

こんにちは。

create-react-appを利用されているのでしたら、環境毎のURLはプロジェクトルートに
.env.development
.env.production
のようなファイルを作って記載すればprocess.envで読み取れます。

こちらを参考にしてみてください。
https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables

Answer 3

環境変数を持たせて、下記のようにすると良いと思います。（テストしていないですが、、、）

axios.createでbaseURLを指定する。

参考にしていただけると幸いです。

const client = axios.create({
  baseURL: process.env.REACT_APP_API_URL
})
client.get('/api/article/' + this.props.match.params.id)
  .then(response => {
    this.setState({article: response.data});
  })
  .catch(response => console.log('ERROR!! occurred in Backend.'));

Comments

[jpskgc]

ご回答いただき誠にありがとうございます。
>環境変数
こちらの場合、本番環境の稼働のために環境変数をAWSで設定する必要があると思います。
ご存知でしたらどうやってAWSで独自の環境変数を設定するのかご教授いただけると幸いです。

[退会済みユーザー]

サーバーサイドなら正しいですが、フロントエンドに環境変数は埋め込めないという根本的な問題があります。

Answer 4

8zcaさんが回答しているしていただいている内容で create-react-app での利用に基づいて書いています。
https://teratail.com/questions/202331#reply-299249

.env.production に

REACT_APP_API_URL=http://localhost:2345

を記述。
Nginxなどを利用して、ビルドした結果を利用すると良いと思います。

$ npm build
or
$ yarn build

サーバーサイドなら正しいですが、フロントエンドに環境変数は埋め込めないという根本的な問題があります。

この件については、この記事がまとまっています。

• https://qiita.com/ksh-fthr/items/2daaaf3a15c4c11956e9

最後に
環境変数、初歩的な記法ミスしていたので変更しています。