Flask项目中app与model拆分

前言

用Flask这个轻量级的web微框架经一段时间了，基本上都是来的项目比较小，需求比较简单或者说时间比较赶的时候，Flask基本成了我的第一选择了，因为搭建一个Flask的项目是非常容易的，相对于Django来说，Flask更加容易给初学者接受，比如一个最小的Flask应用：

from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
    return 'Hello, World!

这样就已经完成了一个简单的接口了，访问域名+/ 就可以获得字符串 Hello,World了。

Flask 可以很容易的部署一套api系统，但是，很多时候都把model以及一些route都写在一个文件当中，当项目需求比较简单的时候，写在一个文件里面也足够了，也方便维护，但是后期如果业务扩展，都写在一个文件里面的话就容易变的臃肿难以维护了，对于MVC架构来所，route文件可以使用Flask的蓝图来拆分，但是如果使用orm(SQLAlchemy)的话，数据库的model就全部挤在了app.py中，本篇文章也是记录了如何将model和app拆分开来。

基本环境

Python 3.7
- Flaks 1.1.2
- gevent 20.5.0
- Flask-SQLAlchemy 2.4.3
Mac OS
Pycharm
Mysql

开始拆分

因为SQLAlchem需要与Flask做绑定，而Model也是需要和SQLAlchemy做绑定，为了解决循环引用，我们可以单独创建一个dbs.py来维护数据库实例，然后model和app分别引用它即可。

不同文件方式

目录结构：

. 
├── app.py
├── dbs.py
├── models.py

dbs.py

from flask_sqlalchemy import SQLAlchemy 
mysql = SQLAlchemy()

models.py

from dbs import mysql 

class User(mysql.Model):
    __tablename__ = 'user'
    id = mysql.Column(mysql.Integer, primary_key=True)
    user_name = mysql.Column(mysql.String(255))

app.py

# encoding=utf8
from flask import Flask, jsonify
from gevent import pywsgi
from flask_cors import CORS
from models import User
from dbs import mysql

app = Flask(__name__)
app.debug = True
app.config['JSON_AS_ASCII'] = False

# 这里连接串的意思是使用pymysql去连接mysql
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql+pymysql://root:@127.0.0.1:3316/mytest'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
app.config['SQLALCHEMY_COMMIT_TEARDOWN'] = True

CORS(app, supports_credentials=True)
# init_app就是为了解决循环引用的
mysql.init_app(app)


@app.route("/")
def index():
    return success()

@app.route("/users")
def users():
    users = User.query.all()
    res = []
    for user in users:
        _res = {
            "id":user.id,
            "name":user.user_name
        }
        res.append(_res)
    return success(res)


def success(data=None):
    return response(0, "success", data)


def fail(msg):
    return response(-1, msg)


def response(code, msg, data=''):
    return jsonify({'code': code, 'msg': msg, 'data': data})


if __name__ == "__main__":
    print("开始启动web服务器...")
    server = pywsgi.WSGIServer(('0.0.0.0', 8088), app)
    server.serve_forever()

不同模块方式

文件夹结构

.
├── app.py
├── database
│   ├── __init__.py 
│   └── dbs.py
└── models
    ├── __init__.py 
    └── user.py

这里将区分不同模块拎出来讲是因为有的时候很多人还是喜欢将不同层级的代码分在不同的文件夹中，这里因为区分了不同模块，所以引用方式不一样，因为pycharm会对你的引用方式报错，正确的方式会报红，不正确的方式反而不会报红，对于这个问题我也不知道为啥~,例如如下报错:
Traceback (most recent call last):
  File "app.py", line 5, in 
    from .models.user import User
ModuleNotFoundError: No module named '__main__.models'; '__main__' is not a package
Traceback (most recent call last):
  File "app.py", line 5, in 
    from models.user import User
  File "models/user.py", line 1, in 
    from ..database.dbs import mysql
ValueError: attempted relative import beyond top-level package 