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 <module>
    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 <module>
    from models.user import User
  File "models/user.py", line 1, in <module>
    from ..database.dbs import mysql
ValueError: attempted relative import beyond top-level package

  • dbs.py

    from flask_sqlalchemy import SQLAlchemy
mysql = SQLAlchemy()

  • user.py

    from database.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.user import User
from database.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)
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()

总结

这里也没啥总结的，总结的话就是虽然只是几个很简单的方式，但是在尝试过程中也是遇到了许多问题，具体分为两个问题:引用问题和flask mysql连接串问题

  • 引用问题

    不管是分模块的方式也好，或者说是分文件的方式，不知道为什么正确的配置编译器(pycharm和vscode都测试过了)都会报红，对于老练的人来说却是没什么影响，但是对于小白(as same as me o(╥﹏╥)o)来说，遇到报红就会很怀疑自己~

    官方参考文档

  • flask mysql连接串问题

    因为SQLAlchemy中的 mysql连接直接用的是MySQLdb，但是Python3.x之后不支持MySQLdb了，所以如果数据库连接串为mysql://xxxx的话会报出没有MySQLdb模块的问题，所以需要使用pymysql代替MySQLdb，所以连接串为mysql+pymysql://xxxx这样既可。

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 199,440评论 5赞 467
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 83,814评论 2赞 376
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 146,427评论 0赞 330
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 53,710评论 1赞 270
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 62,625评论 5赞 359
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,014评论 1赞 275
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,511评论 3赞 390
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,162评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,311评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,262评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,278评论 1赞 328
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,989评论 3赞 316
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,583评论 3赞 303
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,664评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,904评论 1赞 255
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,274评论 2赞 345
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 41,856评论 2赞 339