【flask进阶】手把手带你搭建可扩展的flask项目脚手架

📋 个人简介

💖 作者简介：大家好，进阶手建可脚手架我是把手阿牛，全栈领域新星创作者。搭的😜
🎉 支持我：点赞👍+收藏⭐️+留言📝
📣 系列专栏：flask框架快速入门🍁
💬格言：要成为光，扩展因为有怕黑的项目人！🔥

- 📋 个人简介
前言
- 脚手架所需主要扩展
- 项目目录结构展示与介绍
- 脚手架主体代码展示与介绍
- 项目bug解决
- - 导包时报错没有这个模块或者找不到父包
  - 导包时循环导入bug
- 项目数据迁移与启动
- 这样的目录结构优点与缺点
结语

前言

flask不像我们的django可以用指令快速搭建我们的项目目录，因此，把手对于初学者，搭的做一个项目结构稍微复杂一些，扩展功能多一些的项目web项目时，用flask搭建一个可扩展且看起来比较舒服的进阶手建可脚手架项目时，可能会面临很多困难与bug，把手因此在这篇文章中，搭的我将我花时间搭建的扩展类似django的项目目录的flask项目分享给大家，让大家可以快速搭建flask的项目脚手架！

脚手架所需主要扩展

flask_sqlalchemy - orm框架，操作数据库
flask_migrate - 管理迁移数据库
flask_script - 插入脚本，产生工程管理manage.py
flask-mysqldb - 连接数据库的扩展恰好底层是基于mysqlclient的

项目目录结构展示与介绍

先来看我搭建的项目目录
在这里插入图片描述

看到这个目录结构，django开发者的DNA是否有触动，没错这就是完美的django目录，当然要实现这样的目录也是非常辛苦，博主奋战两天，解决了多个bug才搭建好了这个脚手架！至于为什么，就要从django和flask的区别说起了：很明显，我们的django是一个庞大且功能全面的框架，他将我们的一些orm，工程管理manage等等一些系列东西都囊扩进去了，再看我们的flask，本着轻巧灵活的特性，许多我们需要的功能都需要额外的一些扩展来完成，将这些扩展很好的结合进项目中，当然要花费很多时间，解决一些bug!

那么接下来我来大概介绍一下这个目录结构：

settings.py是项目配置文件。
manage.py相当于django中的manage.py文件，是依靠flask的扩展flask_script 搭建的。
Service.py可以自己看需求是否有，可以看做这里面分装一些工具类或者函数，可以在视图中调用来处理请求。
app.py毫无疑问是flask的主文件，在里面生成flask对象，注册路由，蓝图，写拦截器之类的，当然，路由管理，拦截器你可以自己再单独建文件放在里面！
migrations目录你可以忽略，这是借助flask的orm扩展flask-sqlalchemy中的指令生成的数据库迁移文件。
static和templates就是静态资源和模板目录，和app.py同级就行，这样就不需要在代码中额外添加路径，默认就能找到这些资源！
接下来就是重点，application就相当于django中的app，里面包含你这个App的models模型和views视图！（这里也是一个bug点，本文下面附解决方案）

脚手架主体代码展示与介绍

app.py

from flask import Flaskfrom flask_sqlalchemy import SQLAlchemy# 将application目录添加到项目路径，解决views里的文件导入models里的模型类时找不到models模块路径的问题import sys,ossys.path.append(os.getcwd() + "/application")# print(sys.path)app = Flask(__name__)#从配置文件中settings加载配置app.config.from_pyfile('settings.py')# 将app中的数据库配置加载到app中db = SQLAlchemy(app)

manage.py

from flask_script import Manager,Serverfrom flask_migrate import Migrate,MigrateCommandfrom app import db,app# 生成管理工具对象manager = Manager(app)# 添加服务器运行指令manager.add_command("runserver",Server(host='0.0.0.0',use_debugger=True))# 数据库迁移Migrate(app,db)# 添加数据库的操作指令manager.add_command("db",MigrateCommand)#如果是以此脚本作为主脚本程序，就执行if __name__ == '__main__':    manager.run()

主要是这两个文件，借助flask_script生成工程管理manage.py文件，使得我们的一系列操作可以向django一样依靠指令完成！

项目bug解决

导包时报错没有这个模块或者找不到父包

bug这一块主要产生在python 中 import导包这一块，先看application中的详细目录：

在这里插入图片描述
看一下model文件：

这里需要从app.py导入db对象，app是项目主文件（运行封装到了manage.py），所以用指令运行是这里导包不会报错！

再看view文件：
在这里插入图片描述
问题就出在从models里导入模型类会报错，当然上图你看到的是我解决后的
看下面这两种导入方式：

from application.models.user.User import User
from …models.user.User import User

通过尝试，这两种导入方式都会报错：“没有这个模块”或者“找不到父包”，
对于这种，我找了好久解决方案，以下方式可解决：

你在上面的app.py中是否看到了这段代码：

# 将application目录添加到项目路径，解决views里的文件导入models里的模型类时找不到models模块路径的问题import sys,ossys.path.append(os.getcwd() + "/application")# print(sys.path)

这段代码可以解决这个问题，我们将application这个目录路径添加到这个项目路径中，然后在视图中导入模型时：

from models.user.User import User

直接从models目录开始就可以了，并且要注意，你在其他文件中导入这个模型类时也要用这种导入，不要变，变了flask-sqlalchemy就会报错，你可以理解为整个项目中这个模型类已经导入了，你换个路径就会重新导入，所以会报错（还有种解决方法就是在模型类中加个什么字段，支持重新加载，如果你遇到了这个问题可以百度查查，我的建议就是统一模型类的导入即可）。

导包时循环导入bug

循环导入这个问题很常见，尤其当我们的项目逻辑多起来的时候，导的包也就多了，我在搭建这个脚手架时也遇到了，关于这个bug我的建议是你看报错，然后自己分析导入逻辑，看看那一块冲突了，然后解决，当然为了防止出现这种循环导入的问题，你不要将所有导包都放到文件最上面，哪里需要就在那里import，这样可以很大程度避免循环导入的问题！当然这样导入也有他的缺点！

关于循环导入这块，你可以自行百度去了解！

项目数据迁移与启动

我们花这么久时间搭建是为什么，这里就有答案，这可以使得整个项目的数据迁移与启动变得和django一样十分简单！

在项目启动前先在项目根目录终端进行数据迁移(在settings.py文件中要写好数据库配置哦！)：

1. python manage.py db init
2. python manage.py db migrate
3. python manage.py db upgrade

项目启动：

python manage.py runserver

这样的目录结构优点与缺点

花这么久的时间搭建这样的目录结构，到底是为了什么，很明显，是为了像django一样搭建一个可扩展的结构，你看到了，此项目中的application就相当于django中的app，你也可以像django一样建多个app，每一个大的功能就是一个app，比如网站后台就是一个app，前台就是一个app，你还可以在此基础上扩展其它app而不影响其他的服务！但要注意的是，你新建一个app都要记得将app目录添加到项目路径！（这里的app不是flask中的app.py哦！app.py只能有一个！）

当然，缺点也是很明显的，费时费精力，因此，对于没有经验的初学者，当你在做业务功能稍微多一点的项目时，我建议你豪不犹豫选择django吧！几行指令就搭建好脚手架了，结合实际情况再做调整就好，比flask快多了！