在不同環(huán)境中使用React

原文:Using React in Multiple Environments

你的 React 應用可以在本地運行厦坛,但是如何讓它能在不同的環(huán)境中也順利運行呢旦事?

包括生產(chǎn)環(huán)境,測試環(huán)境物舒,預覽環(huán)境等等织盼,所有這些環(huán)境都有自己的服務器闻牡、配置文件,甚至在不同的環(huán)境應用會打開或者關閉特定的功能俺亮。

那么驮捍,如何實現(xiàn)上述需求呢?下面我們介紹幾種方法

動態(tài)配置

如果不同環(huán)境是通過不同的域名訪問的脚曾,那么這種策略很合適

在 api-config.js 中加入下列代碼:


let backendHost;
const apiVersion = 'v1';

const hostname = window && window.location && window.location.hostname;

if(hostname === 'realsite.com') {
  backendHost = 'https://api.realsite.com';
} else if(hostname === 'staging.realsite.com') {
  backendHost = 'https://staging.api.realsite.com';
} else if(/^qa/.test(hostname)) {
  backendHost = `https://api.${hostname}`;
} else {
  backendHost = process.env.REACT_APP_BACKEND_HOST || 'http://localhost:8080';
}

export const API_ROOT = `${backendHost}/api/${apiVersion}`;

然后在 API 文件中(比如东且,api.js),你可以導入 API URL


import { API_ROOT } from './api-config';

function getUsers() {
  return fetch(`${API_ROOT}/users`)
    .then(res => res.json)
    .then(json => json.data.users);
}

編譯時配置

如果你想在編譯時進行配置本讥,也是可以的:

如果你使用 Create React App珊泳,你將會獲得一個全局變量 process.env,通過這個變量應用可以訪問環(huán)境變量拷沸,同時應用構建后色查,process.env.NODE_ENV 會被設置為 “production"

另外,Create React App 工具只會訪問以 “REACT_APP_” 開頭的環(huán)境變量撞芍,所以秧了,同樣是環(huán)境變量 REACT_APP_SKITTLE_FLAVOR 可以被訪問到,而 SKITTLE_FLAVOR 就不行

下面我們來看一下如何在構建時添加環(huán)境變量:

  • Linux 系統(tǒng)

      $ REACT_APP_API_HOST=example.com yarn run build
    

    在應用中就可以訪問到如下變量

    • process.env.REACT_APP_API_HOST === "example.com"
    • process.env.NODE_ENV === "production"
  • Windows 系統(tǒng)

      :\> set REACT_APP_API_HOST=example.com
      :\> yarn run build
    

在構建時配置功能開關

環(huán)境變量可以被設置為任意值勤庐,一個潛在的用途是在不通的環(huán)境中打開或者關閉特定的功能示惊。在構建時你可以進行這樣的操作:

$ REACT_APP_SPECIAL_FEATURE=true yarn run build

你將獲得如下變量:

#   process.env.REACT_APP_SPECIAL_FEATURE === "true"
#   process.env.NODE_ENV === "production"

然后你可以在代碼的任意位置檢查這些變量:

function HomePage() {
  if(process.env.REACT_APP_SPECIAL_FEATURE === "true") {
    return <SpecialHomePage/>;
  } else {
    return <PlainOldBoringHomePage/>;
  }
}

.env Files

Create React App 支持通 .env 文件將環(huán)境變量持久保存。

你可以創(chuàng)建一個 .env 文件愉镰,然后將環(huán)境變量添加到里面:

REACT_APP_SPECIAL_FEATURE=true
REACT_APP_API_HOST=default-host.com

這些變量在不通的環(huán)境中都會加載米罚,如果你想定義一些某個環(huán)境特定的變量,則可以創(chuàng)建名為.env.development, .env.test, 或者 .env.production 的 env 文件丈探。

.env 文件的類型

  • .env: 默認.
  • .env.local: 本地覆蓋(overrides)录择。這個文件將會在除了測試環(huán)境之外的所有環(huán)境加載。
  • .env.development, .env.test, .env.production: 環(huán)境特定設置。
  • .env.development.local, .env.test.local, .env.production.local: 針對不通環(huán)境的覆蓋配置隘竭。

.env 文件的優(yōu)先級

左邊的優(yōu)先級高于右邊

  • npm start: .env.development.local, .env.development, .env.local, .env
  • npm run build: .env.production.local, .env.production, .env.local, .env
  • npm test: .env.test.local, .env.test, .env (note .env.local is missing)

Variables are Baked In

At the risk of stating the obvious: the “environment variables” will be baked in at build time. Once you build a JS bundle, its process.env.NODE_ENV and all the other variables will remain the same, no matter where the file resides and no matter what server serves it. After all, a React app does not run until it hits a browser. And browsers don’t know about environment variables.

Unit Testing

Once you’ve got all these variables multiplying your code paths, you probably want to test that they work. Probably with unit tests. Probably with Jest (that’s what I’m showing here anyway).

If the variables are determined at runtime, like in the first example above, a regular import './api-config' won’t cut it – Jest will cache the module after the first import, so you won’t be able to tweak the variables and see different results.

These tests will make use of two things: the require() function for importing the module inside tests, and the jest.resetModules() function to clear the cache.


// (this could also go in afterEach())
beforeEach(() => {
  // Clear the Jest module cache
  jest.resetModules();

  // Clean up the environment
  delete process.env.REACT_APP_BACKEND_HOST;
});

it('points to production', () => {
  const config = setupTest('realsite.com');
  expect(config.API_ROOT).toEqual('https://api.realsite.com/api/v1');
});

it('points to staging', () => {
  const config = setupTest('staging.realsite.com');
  expect(config.API_ROOT).toEqual('https://staging.api.realsite.com/api/v1');
});

it('points to QA', () => {
  const config = setupTest('qa5.company.com');
  expect(config.API_ROOT).toEqual('https://api.qa5.company.com/api/v1');
});

it('points to dev (default)', () => {
  const config = setupTest('localhost');
  expect(config.API_ROOT).toEqual('http://localhost:8080/api/v1');
});

it('points to dev (custom)', () => {
  process.env.REACT_APP_BACKEND_HOST = 'custom';
  const config = setupTest('localhost');
  expect(config.API_ROOT).toEqual('custom/api/v1');
});

function setupTest(hostname) {
  setHostname(hostname);
  return require('./api-config');
}

// Set the global "hostname" property
// A simple "window.location.hostname = ..." won't work
function setHostname(hostname) {
  Object.defineProperty(window.location, 'hostname', {
    writable: true,
    value: hostname
  });
}


Links

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末塘秦,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子动看,更是在濱河造成了極大的恐慌尊剔,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,378評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件菱皆,死亡現(xiàn)場離奇詭異须误,居然都是意外死亡,警方通過查閱死者的電腦和手機仇轻,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,970評論 3 399
  • 文/潘曉璐 我一進店門京痢,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人篷店,你說我怎么就攤上這事祭椰。” “怎么了疲陕?”我有些...
    開封第一講書人閱讀 168,983評論 0 362
  • 文/不壞的土叔 我叫張陵方淤,是天一觀的道長。 經(jīng)常有香客問我鸭轮,道長臣淤,這世上最難降的妖魔是什么橄霉? 我笑而不...
    開封第一講書人閱讀 59,938評論 1 299
  • 正文 為了忘掉前任窃爷,我火速辦了婚禮,結果婚禮上姓蜂,老公的妹妹穿的比我還像新娘按厘。我一直安慰自己,他們只是感情好钱慢,可當我...
    茶點故事閱讀 68,955評論 6 398
  • 文/花漫 我一把揭開白布逮京。 她就那樣靜靜地躺著,像睡著了一般束莫。 火紅的嫁衣襯著肌膚如雪懒棉。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,549評論 1 312
  • 那天览绿,我揣著相機與錄音策严,去河邊找鬼。 笑死饿敲,一個胖子當著我的面吹牛妻导,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 41,063評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼倔韭,長吁一口氣:“原來是場噩夢啊……” “哼术浪!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起寿酌,我...
    開封第一講書人閱讀 39,991評論 0 277
  • 序言:老撾萬榮一對情侶失蹤胰苏,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后醇疼,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體碟联,經(jīng)...
    沈念sama閱讀 46,522評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,604評論 3 342
  • 正文 我和宋清朗相戀三年僵腺,在試婚紗的時候發(fā)現(xiàn)自己被綠了鲤孵。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,742評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡辰如,死狀恐怖普监,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情琉兜,我是刑警寧澤凯正,帶...
    沈念sama閱讀 36,413評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站豌蟋,受9級特大地震影響廊散,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜梧疲,卻給世界環(huán)境...
    茶點故事閱讀 42,094評論 3 335
  • 文/蒙蒙 一允睹、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧幌氮,春花似錦缭受、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,572評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至宇智,卻和暖如春蔓搞,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背随橘。 一陣腳步聲響...
    開封第一講書人閱讀 33,671評論 1 274
  • 我被黑心中介騙來泰國打工喂分, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人太防。 一個月前我還...
    沈念sama閱讀 49,159評論 3 378
  • 正文 我出身青樓妻顶,卻偏偏與公主長得像酸员,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子讳嘱,可洞房花燭夜當晚...
    茶點故事閱讀 45,747評論 2 361

推薦閱讀更多精彩內(nèi)容