如何把Flask项目改造为Django结构

Flask是一个轻量级框架，它自由、灵活，可扩展性强，所以就算是同一个项目，不同的人的项目架构设计也会又很大差别，为了能让自己的项目架构更加清晰明了，更易被别人理解，本人推荐把flask项目改造成类似django结构的形式，但前提是你得懂django框架。

一、项目总结构

这是改造后的flask项目结构，总共包括app、docs、requirements、static、templates、utils 6个目录和manage.py执行文件，以及DOCS.md说明文档。每个目录和文件的具体内容在下面进行详细介绍。

二、详细介绍

1.static

static是用于存放css、js、image等内容的目录，通常把下载的文件、图片等内容也存于此目录，如用户上传的头像等信息。

2.temlpates

templates用于存放html页面。

3.utils

utils是用于存放配置信息、常用参数等内容的目录。刚创建的flask项目，配置信息都在执行文件中进行配置，但如果你真的这样做，你会发现这个文件被写得乱八七糟，不利于理解，所以推荐把配置信息都单独写在不同的文件中，统一放在utils目录下。

（1）init.py

__init__.py通常是个空文件，它的第一个作用是作为package的标识，如果没有该文件，该目录就不会被认为是package。虽然这也是一个python文件，可以用来编写python代码，但不推荐这样做，我们应该尽可能保证这个文件足够轻。

（2）app.py

这个文件用来创建flask模型，并且


from flask import Flask

from app.house_views import house_blueprint
from app.order_views import order_blueprint
from app.user_views import user_blueprint
from utils.functions import init_ext
from utils.settings import TEMPLATE_DIR, STATIC_DIR


def create_app(Config):
    # 创建flask模型
    app = Flask(__name__, template_folder=TEMPLATE_DIR, static_folder=STATIC_DIR)
    
    # 注册蓝图
    app.register_blueprint(blueprint=user_blueprint, url_prefix='/user')
    app.register_blueprint(blueprint=house_blueprint, url_prefix='/house')
    app.register_blueprint(blueprint=order_blueprint, url_prefix='/order')

    # 配置config
    app.config.from_object(Config)

    app.debug = True

    init_ext(app)

    return app

（3）config.py

import redis

from utils.settings import SQLALCHEMY_DATABASE_URI


class Config():

    SQLALCHEMY_DATABASE_URI = SQLALCHEMY_DATABASE_URI
    SQLALCHEMY_TRACK_MODIFICATIONS = False

    # session 配置
    SECRET_KEY = '<111111>'
    SESSION_TYPE = 'redis'
    SESSION_REDIS = redis.Redis(host='127.0.0.1', port=6379)
    SESSION_KEY_PREFIX = 's_aj_'

（4）functions.py

封装高复用的函数

import functools

from flask import session, redirect
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()


def get_database_uri(DATABASE):
    db = DATABASE.get('db')
    driver = DATABASE.get('driver')
    user = DATABASE.get('user')
    password = DATABASE.get('password')
    host = DATABASE.get('host')
    port = DATABASE.get('port')
    name = DATABASE.get('name')

    return '{}+{}://{}:{}@{}:{}/{}'.format(db, driver, user, password, host, port, name)


def init_ext(app):

    db.init_app(app=app)


def is_login(view_fun):
    """
    装饰器
    验证是否登陆
    """
    @functools.wraps(view_fun)
    def decorator():
        try:
            if session['user_id']:
                return view_fun()
            else:
                return redirect('/user/login/')
        except:
            return redirect('/user/login/')
    return decorator

（6）settings.py

import os

from utils.functions import get_database_uri

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
STATIC_DIR = os.path.join(BASE_DIR, 'static')
TEMPLATE_DIR = os.path.join(BASE_DIR, 'templates')

DATABASE = {
    'db': 'mysql',
    'driver': 'pymysql',
    'user': 'root',
    'password': '123456',
    'host': '127.0.0.1',
    'port': '3306',
    'name': 'aj'
}

SQLALCHEMY_DATABASE_URI = get_database_uri(DATABASE)

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
UPLOAD_DIR = os.path.join(os.path.join(BASE_DIR, 'static'), 'upload')

（7）status_code.py

在处理事务时，通常需要返回一些json格式的数据，用来表示请求的状态，通常我们会推荐使用常量来表示请求状态。此处的status_code.py就是用来存储这些常量的文件。

SUCCESS = {'code': 200, 'msg': '请求成功'}
PARAMS_ERROR = {'code': 1050, 'msg': '参数缺少'}
ERROR = {'code': 1111, 'msg': '请求失败'}
DATABASE_ERROR = {'code': 999, 'msg': '数据库请求失败'}

4.app

整个项目的模型和用于处理事务的views都在这个目录中完成，所以此目录算是整个flask项目的核心部分。
既然是个package，就需要定义一个__init__.py文件。
models.py用于创建项目所需的全部模型。
xxx_views.py是用于处理事务的文件，由于所有处理事务的views文件都在这一个目录中，所以在创建views文件时，可以根据事务内容进行分类，如处理用户相关事件的命名为use_views.py，处理订单相关事件的命名为order_views.py。

5.requirements

在python中安装包使用如下命令：

pip install xxx

通常情况下，每个项目都需要安装大量包，如果安装每个包时都使用上面的命令，那也太过麻烦了。所以推荐把项目所需要的所有包写在一个xxx.txt文档中，然后统一安装。requirements这个目录就是用于存放xxx.txt这个文档的。安装包的命令如下：

pip install xxx.txt

注意：使用上面的命令时，需要讲路径切换到xxx.txt所在目录下。

6.docs

这个目录用于存放接口说明文件，用来说明每个接口的含义，需要的参数，可能出现的请求状态等信息。

7.manag.py

manage.py是flask的执行文件，默认的名字和flask项目的名称相同，这里把他改为manage.py，这样在启动项目时的命令就和django的启动命令差不多了。经过utils配置信息的调整，manage.py中的内容就十分精炼了，如下：


from flask_script import Manager

from utils.app import create_app
from utils.config import Config


app = create_app(Config)
manager = Manager(app=app)


if __name__ == '__main__':
    manager.run()

8.DOCS.md

### 爱租客接口文档
#### 用户模块
    -[注册接口](docs/user/user_register.md)
    -[登陆接口](docs/user/user_login.md)
    -[个人中心]
        -[修改用户信息](docs/user/user_profile.md)
        -[实名认证](docs/user/user_auth.md)
        -[我的房源](docs/user/user_house.md)

flask项目总的接口说明性文档，使用markdown格式，用来说明docs中每个文件的含义