2.配置

优质

小牛编辑

137浏览

2023-12-01

配置

对于一个项目来说，配置是一个很严肃的问题，比如说：在开发环境和生产环境中，配置是不同的，那么一个项目该如何自由地在不同的配置环境中进行切换呢，思考下，然后带着答案或者疑问往下阅读。

单一配置

撸起袖子，开始吧，新建文件夹 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来实现这个需求，有兴趣的朋友可以详细了解，或许你也是用这个方案呢？

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