一日一技：如何正確管理項目的環(huán)境變量
在之前的公眾號文章：開發(fā)經(jīng)驗：如何正確設置開發(fā)環(huán)境與生產(chǎn)環(huán)境的配置參數(shù)中，我提到了把項目的開發(fā)環(huán)境與生產(chǎn)環(huán)境的配置文件分開管理這種方式。
實際上，項目的配置信息，除了用配置文件以外，還可以使用環(huán)境變量來進行設置。有一些項目，他們不用配置文件設置敏感信息，因為害怕一不小心就把敏感信息發(fā)送到了Github上面。而是把所有敏感信息設置到環(huán)境變量里面。代碼直接從環(huán)境變量讀取這些信息。
在Python里面，讀取環(huán)境變量非常簡單：
- import os
- value = os.getenv('變量名')
假設有一個項目，它運行的時候需要連Redis/MongoDB/Kafka/ElasticSearch。配置信息有五六十條。那么，它可能需要設置很多的環(huán)境變量，像下面這樣：
- export REDIS_HOST=xxx
- export REDIS_PORT=xxx
- export REDIS_PASSWORD=xxx
- export MONGODB_URI=xxxx
- export KAFKA_SERVER=xxx
- ...
這樣做的好處顯而易見，一旦設置好環(huán)境變量以后，每次啟動程序只需要直接運行代碼就可以了。當你在開發(fā)機上面運行，它自動就連開發(fā)環(huán)境;當你在生產(chǎn)環(huán)境來運行，它自動就會連生產(chǎn)環(huán)境。
但壞處也很明顯，如果你有多個環(huán)境，每次重新修改環(huán)境變量就非常麻煩。一般來說，生產(chǎn)環(huán)境只有一個，但你還有開發(fā)環(huán)境、測試環(huán)境、預發(fā)布環(huán)境…。其中生產(chǎn)環(huán)境的配置參數(shù)你是拿不到的，但另外幾個環(huán)境的參數(shù)你是可以拿到的。假設你現(xiàn)在的代碼在開發(fā)機運行正常，但是放到測試環(huán)境就失敗了。那么你想在開發(fā)機使用測試環(huán)境的參數(shù)來調(diào)試代碼。這個時候你就必須一個一個重新設置環(huán)境變量，這就非常麻煩。
但好在Python已經(jīng)有一個用來管理項目環(huán)境變量的第三方庫python-dotenv[1]。
這個庫使用起來非常簡單，只需要兩行代碼加一個文件。
首先，在項目的根目錄創(chuàng)建一個文件，叫做.env。使用Windows的同學可能無法做到，因為Windows使用正常方法沒有辦法創(chuàng)建一個點開頭的文件。但是Linux和macOS可以正常創(chuàng)建。例如：
- NAME=kingname
- SALARY=9999999
- ADDRESS=上海
然后，在項目入口文件的頂部，增加兩行代碼，如下圖所示：
- from dotenv import load_dotenv
- load_dotenv()
這樣就完成了。你原來讀取環(huán)境變量的代碼不需要做任何修改，直接讀取環(huán)境變量就可以了，如下圖所示：
從圖中可以看到，當我們在Shell里面直接執(zhí)行echo $ 變量名的時候，顯示的是空，說明這個環(huán)境變量是沒有設置的。當我們運行項目代碼的時候，python-dotenv會自動讀取.env文件，然后在項目里面設置環(huán)境變量。
如果僅僅是讀文件，那我當然不會特意介紹它。它還有兩個更好用的功能。
如果環(huán)境變量已經(jīng)存在，那么會以已經(jīng)存在的環(huán)境變量為準，.env中對應的項自動失效：
也就是說，這個.env文件，你甚至可以直接上傳到生產(chǎn)環(huán)境。由于生產(chǎn)環(huán)境已經(jīng)設置好了對應的配置參數(shù)，所以.env文件里面的內(nèi)容自動失效。
第二個好用的功能，是.env里面還可以復用同一個變量。例如，我的項目有一個域名會在多個地方用到：
- EMAIL=contact@kingname.info
- ENTRYPOINT=https://kingname.info/api
- REDIS_HOST=redis.kingname.info
- KAFKA_SERVER=kafka.kingname.info
- ...
如果有一天我要修改這個域名，那么所有配置都需要修改。但是.env可以復用變量：
- DOMAIN=kingname.info
- EMAIL=contact@${DOMAIN}
- ENTRYPOINT=https://${DOMAIN}/api
- REDIS_HOST=redis.${DOMAIN}
- KAFKA_SERVER=kafka.${DOMAIN}
這樣一來，當我要改域名的時候，只需要修改DOMAIN的值就可以了。
關于python-dotenv的更多使用說明，大家可以閱讀參考文檔里面的Readme。
參考文獻
[1]python-dotenv: https://github.com/theskumar/python-dotenv
