开发者社区> 馆主阿牛> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

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

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

@TOC

前言

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 Flask
from flask_sqlalchemy import SQLAlchemy

# 将application目录添加到项目路径,解决views里的文件导入models里的模型类时找不到models模块路径的问题
import sys,os
sys.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,Server
from flask_migrate import Migrate,MigrateCommand
from 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,os
sys.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

  1. python manage.py db migrate
  2. 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快多了!

结语

后面我会做一个后台项目实践这个项目结构,敬请关注此专栏!

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Flask入门的第一个项目进阶版
前言: 此次版本增加【一对多】数据库关系和动态路由设置。 一、数据库设计 environments表与variable1表的关系为:一对多。variable1.env_id设置为外键,与environments表建立关系。
906 0
Flask入门的第一个项目
前言: Flask简介:Flask是一个使用 Python 编写的轻量级 Web 应用框架,基于 WerkzeugWSGI工具箱和 Jinja2模板引擎。 想要学习flask,又非常迷茫,不知如何下手,终于写下第一个项目,分享给大家,希望能对刚刚入门的你有所帮助。
1315 0
Python编程:使用os.urandom生成Flask的SECRET_KEY
Python编程:使用os.urandom生成Flask的SECRET_KEY
35 0
Python编程:Flask扩展Flask-Migrate迁移数据库
Python编程:Flask扩展Flask-Migrate迁移数据库
25 0
Python编程:将Flask项目部署到免费服务器Heroku
Python编程:将Flask项目部署到免费服务器Heroku
52 0
Python编程:腾讯防水墙原理浅析与Flask结合测试
Python编程:腾讯防水墙原理浅析与Flask结合测试
38 0
Python编程:uWSGI+nginx配置flask实例
Python编程:uWSGI+nginx配置flask实例
48 0
Python编程:web框架flask、web.py、tornado最小应用
Python编程:web框架flask、web.py、tornado最小应用
23 0
Python全栈:flask的blueprint蓝图使用
Python全栈:flask的blueprint蓝图使用
26 0
python编程:mac环境gunicorn+nginx部署flask项目
python编程:mac环境gunicorn+nginx部署flask项目
37 0
+关注
馆主阿牛
目前计算机专业大二在读,会网络爬虫,专注于web开发,熟悉c, python,html,css,JavaScript… 致力于成为一名Full Stack developer 看到不妨点个关注,我们一起进步哦!
文章
问答
文章排行榜
最热
最新
相关电子书
更多
Vue.js 在前端服务化上的探索与实践
立即下载
Vue.js在前端服务化上的实践与探索
立即下载
React在大型后台管理项目中的工程实践
立即下载