flask框架实战项目架构

一、项目架构：

研习了多天flask，今天终于按照标准流程写了一个实验demo，并实现了ORM调用，一起喜欢自己写原生SQL。废话不多说，来看项目文件结构

mysite/
    ./config/
        default.py#默认上线的配置文件
        development.py#开放过程的配置文件
        debug.py#调试过程的配置文件
    ./instance/
        config.py#特殊的复写的配置文件
    ./utils/#自定义的lib库
        tools1.py
        tools2.py
    ./main/#app所在库
        __init__.py#app定义
        modles.py#ORM数据库代码文件
        ./views/#视图（路由）代码文件
            user.py#模块一的蓝图文件，定义视图路由函数
        ./static/#静态文件所在文件夹
        ./templates/#模板文件所在文件夹
    ./docs/#文档文件文件夹
    ./libs/#css/js/ca等类型文件文件夹
    requestment.py#以来库要求文件夹
    manage.py#启动脚本

二、多层文件架构需要注意的坑

1、引入本文件夹下的__init__.py下的对象from . import xxx

2、引入文件寻址路径添加方式：

import sys
sys.path.append(filepath)

3、注意互相引用时候的定义以来，比如A引用B的m，B引用的A的n，m需要n去定义，那么A中引入m一定要在n定义之后。

三、default.py的内容：

DEBUG = True
SECRET_KEY = 'xxxx'
SQLALCHEMY_DATABASE_URI ="mysql://root:root@127.0.0.1:3306/webuser"#mysql连接的定义mysql://user:pass@host:port/databasename
SQLALCHEMY_TRACK_MODIFICATIONS = True

四、__init__.py app定义、数据库对象创建、蓝图函数注册：

# -*- encoding:utf-8 -*-
import sys
sys.path.append("./")
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
 
myapp = Flask(__name__)
myapp.config.from_pyfile("../config/default.py")#读取配置文件
userdb = SQLAlchemy(myapp)#创建数据库连接对象
from views.user import User#引入模块User
myapp.register_blueprint(User)#蓝图注册函数

五、ORM定义数据库的方式modles.py

# -*- encoding:utf-8 -*-

#import lib files
from . import userdb#从__init__.py引入userdb对象

class UserTable(userdb.Model):
    id = userdb.Column(userdb.Integer,primary_key=True,autoincrement=True)
    name = userdb.Column(userdb.String(20))
    def __init__(self,name):
        self.name = name
    def __repr__(self):
        return '<UserTable %r>'%self.name
    def show(self):
        return self.name
                                                                             
#创建表（一个类一个表）：
"""
#类的属性就是表的列字段 创建函数就是数据库连接对象.Column(约束)
id = userdb.Column(userdb.Integer,primary_key=True,autoincrement=True)
name = userdb.Column(userdb.String(20))
"""

六、user.py模块 定义视图路由函数的文件

# -*- encoding:utf-8 -*-
import sys
sys.path.append("../")
sys.path.append("../../")
from . import userdb#引入数据库连接对象
from models import UserTable#引入数据表对象
from flask import Blueprint,request,jsonify

User = Blueprint("user",__name__)#创建蓝图

@User.route("/register",methods=["GET","POST"])#蓝图路由
def register():
    if request.method == "GET":
        user = request.args.get("username")
    else:
        user = request.forms.get("username")
    try:
        userdb.create_all()
    except Exception,ex:
        pass
    retlist = UserTable.query.filter_by(name=user).all()
    if len(retlist) > 0:
        return jsonify({"message":"failed","reason":"username repeat!"})
    else:
        userobj = UserTable(user)
        userdb.session.add(userobj)
        userdb.session.commit()
        return jsonify({"message":"success","reason":"Hello %s"%user})

七、启动脚本manage.py

from mainapp.app import myapp

if __name__ == "__main__":
     myapp.run("127.0.0.1",port=5443)
#另外一种方式：
"""
from flask_script import Manager
manager = Manager(app)
#...
if __name__ == '__main__':
    manager.run()"
(venv) $ python hello.py runserver --host 0.0.0.0 -p 5443
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
 """

八、requestments.txt

pip freeze > requestments.txt