Flask 的架构升级

渐进式搭建大型 Flask 应用

hello world#

第一个 flask 应用（这个示例程序还需要templates文件夹存放模板）

1
#!/usr/bin/python
2
# -*- coding:utf-8 -*-
3
from flask import Flask
4
app = Flask(__name__)
5

6
@app.route('/')
7
def index():
8
    return render_template('index.html')
9

10
@app.route('/hello_world')
11
def hello_world():
12
    return 'Hello World!'
13

14
if __name__ == '__main__':
15
    app.run(host='0.0.0.0', port=80)

使用python manage.py可以快速启动服务，但这种服务启动方式只适合开发环境测试，因为存在以下几个问题。

flask 的自带服务器不支持多线程，用于多人的环境时很容易发生阻塞
服务因意外崩溃时不会自动重启
一旦你的 shell 关闭，你的服务将被停止。可以使用nohup python manage.py &让服务在后台运行，或者挂一个 screen screen -S pythonServer``python manage.py(这些方案只适用于快速搭建服务，生产环境应该使用服务器)

扩展#

随着功能的增加，必须根据不同功能把程序拆分成文件，使用manage.py作为入口，在views.py处理路由，在errors.py中处理错误。项目结构修改为这样：

1
proj
2
│  manage.py  # 应用入口
3
│
4
├─app
5
│  errors.py  # 错误处理
6
│  utils.py  # 工具类
7
│  views.py  # 视图/路由
8
│  __init__.py
9
│
10
├─templates  # 模板文件夹
11
│  about.html
12
│  index.html
13
│  login.html
14
│
15
└─static  # 静态资源
16
   app.js
17
   app.css

查缺补漏#

服务器在生产环境使用 web 服务器。如 Nginx, Gunicorn, Tornado
管理服务使用supervisor, systemd等方式保证服务可靠运行
日志为了快速定位 bug 以及溯源异常信息，需要使用日志模块输出日志而不是简单地使用print('errorInfo')这种方式 debug, 常用的日志模块有log4j等
配置文件方便切换开发环境和生产环境配置
测试
版本控制开发必备，不多说，使用Git吧，还建议使用贴近项目的工作流Git 工作流程

更大、更复杂#

利用蓝图和 flask 强大的扩展能力，创建更大的项目

1
proj
2
  │-app/
3
    │-templates/
4
    │-static/
5
    │-main/
6
      │-__init__.py
7
      │-errors.py
8
      │-forms.py
9
      │-views.py
10
    │-auth/
11
      │-__init__.py
12
      │-forms.py
13
      │-views.py
14
    │-__init__.py
15
    │-email.py
16
    │-models.py
17
  │-migrations/
18
  │-tests/
19
    │-__init__.py
20
    │-test*.py
21
  │-venv/
22
  │-requirements.txt
23
  │-config.py
24
  │-manage.py

应用细节#

manage.py主入口

1
#!/usr/bin/python
2
# -*- coding:utf-8 -*-
3
import os
4
from app import create_app
5

6
# 配置
7
config_name = os.getenv('FLASK_CONFIG') or 'default'
8
app = create_app(config_name)
9

10
# gunicorn -k gevent -w 8 -b 127.0.0.1:5000 manage:app
11
if __name__ == '__main__':
12
    app.run(host='127.0.0.1', port=5000, debug=True)

config.py配置文件

1
# -*- coding:utf-8 -*-
2

3
class Config(object):
4
    DEBUG = False
5
    TESTING = False
6
    DATABASE_URI = 'sqlite://:memory:'
7

8
    @staticmethod
9
    def init_app(app):
10
        pass
11

12
class ProductionConfig(Config):
13
    DATABASE_URI = 'mysql://user@localhost/foo'
14

15
class DevelopmentConfig(Config):
16
    DEBUG = True
17

18
class TestingConfig(Config):
19
    TESTING = True
20

21
config={
22
    'dev':DevelopmentConfig,
23
    'test':TestingConfig,
24
    'prod':ProductionConfig,
25
    'default':DevelopmentConfig
26
    }

app/__init__.pyapp 工厂函数，根据不同环境配置初始化 app

1
#!/usr/bin/python
2
# -*- coding:utf-8 -*-
3
from flask import Flask
4
from config import config
5

6
def create_app(config_name):
7
    app=Flask(__name__)
8

9
    # 加载配置
10
    app.config.from_object(config[config_name])
11
    config[config_name].init_app(app)
12

13
    # 注册蓝图
14
    from .main import main as main_blueprint
15
    app.register_blueprint(main_blueprint)
16

17
    app.logger.debug('应用初始化完成') # DEBUG
18
    return app

app/main/__init__.py 蓝图

1
# -*- coding:utf-8 -*-
2
from flask import Blueprint
3

4
main = Blueprint('main', __name__)

app/main/views.py 蓝图的视图

1
# -*- coding:utf-8 -*-
2
from flask import current_app as app
3
from . import main
4

5
# 测试接口
6
@main.route('/')
7
def index():
8
    app.logger.debug('SUCCESS') # DEBUG
9
    return 'Hello'

其他#

前后端分离
缓存
权限管理
访客分析
服务器监控
负载均衡
CDN
分布式
CICD
Python venv 虚拟环境
……

最后#

在搭建项目的时候根据自己项目实际情况，选择合适的架构才是正确的选择。

hello world#

扩展#

查缺补漏#

更大、更复杂#

应用细节#

其他#

最后#

参考文献#