Sanic教程：配置

howie6879發表於2019-02-16

配置

對於一個專案來說，配置是一個很嚴肅的問題，比如說：在開發環境和生產環境中，配置是不同的，那麼一個專案該如何自由地在不同的配置環境中進行切換呢，思考下，然後帶著答案或者疑問往下閱讀。

單一配置

擼起袖子，開始吧，新建資料夾 demo2 ，內部建立這樣的檔案結構：

demo02
├── config
│   ├── __init__.py
│   └── config.py
└── run.py

其中 run.py 內容如下：

#!/usr/bin/env python
from sanic import Sanic
from sanic.response import text

app = Sanic()


@app.route("/")
async def test(request):
    return text(`Hello World!`)


if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000, debug=True)

程式碼示例中開啟了 debug 模式，假設我們需要通過 config.py 配置檔案來實現控制服務的 debug 模式開啟與否，那該怎麼實現呢。

在 config.py 中新增一行：DEBUG=True ，然後 run.py 內容改為：

#!/usr/bin/env python
from sanic import Sanic
from sanic.response import text
from config import DEBUG

app = Sanic()


@app.route("/")
async def test(request):
    return text(`Hello World!`)


if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000, debug=DEBUG)

表面上看，功能確實實現了，但這實際上卻不是很好的做法，若部署在生產環境中，難道還要特地再將 debug 改為 False 麼，這顯然很浪費時間，如果需要改變的引數有很多，那就很難維護了。

多配置

那麼，正確的做法應該是怎麼樣的呢？

我們應當依據不同的環境來編寫各自對應的環境，舉個例子，比如生產環境就對應pro_config，開發環境就對應dev_config.py等等

具體該怎麼實施？首先在資料夾 demo2 ，內部建立這樣的檔案結構：

demo02
├── config
│   ├── __init__.py
│   ├── config.py
│   ├── dev_config.py
│   └── pro_config.py
└── run.py

然後使用類繼承的方式使這三個配置檔案聯絡起來，比如在 config.py 中就只放公有配置，如：

#!/usr/bin/env python
import os


class Config():
    """
    Basic config for demo02
    """
    # Application config
    TIMEZONE = `Asia/Shanghai`
    BASE_DIR = os.path.dirname(os.path.dirname(__file__))

而在 pro_config.py或dev_config.py 中就可以自由地編寫不同的配置了：

# dev_config
#!/usr/bin/env python
from .config import Config


class DevConfig(Config):
    """
    Dev config for demo02
    """

    # Application config
    DEBUG = True

# pro_config
#!/usr/bin/env python
from .config import Config


class ProConfig(Config):
    """
    Pro config for demo02
    """

    # Application config
    DEBUG = False

配置檔案還需要根據系統環境變數的設定進行不同配置環境的切換，比如設定 MODE 系統環境變數，這裡從系統環境變數得到配置也是個不錯的方法，一般說利用gunicorn配置worker數目之類的，都可以使用這種方案。

然後可以根據其不同的值切換到不同的配置檔案，因此在 __init__.py 中需要這麼寫：

#!/usr/bin/env python
import os


def load_config():
    """
    Load a config class
    """

    mode = os.environ.get(`MODE`, `DEV`)
    try:
        if mode == `PRO`:
            from .pro_config import ProConfig
            return ProConfig
        elif mode == `DEV`:
            from .dev_config import DevConfig
            return DevConfig
        else:
            from .dev_config import DevConfig
            return DevConfig
    except ImportError:
        from .config import Config
        return Config


CONFIG = load_config()

預設 MODE 設定為 DEV，在 run.py 檔案中就可以這麼呼叫：

#!/usr/bin/env python
from sanic import Sanic
from sanic.response import text
from config import CONFIG

app = Sanic()
app.config.from_object(CONFIG)

@app.route("/")
async def test(request):
    return text(`Hello World!`)


if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000, debug=app.config[`DEBUG`])

而在生產環境的伺服器上，直接通過設定系統變數就可以達到配置修改的目的了，如下：

# 通過設定MODE的值進行配置檔案的選擇
export MODE=PRO

若是利用 supervisor 來啟動服務，可通過新增environment = MODE="PRO" 來設定環境變數，是不是很方便呢。

說明

其實我編寫這種微服務，配置更新是很正常且很頻繁的需求，這樣的話我就必須要求我的程式碼可以實現熱更新，也就是可以迅速的修改配置，且迅速的生效，目前我使用的是ZooKeeper來實現這個需求，有興趣的朋友可以詳細瞭解，或許你也是用這個方案呢？

如果你有更好的方案，不妨告知一二。

相關文章