Flask使用Blueprint进行多模块应用的编写

简介:

1、blueprint

在使用flask进行一个项目编写的时候,可能会有许多个模块,如一个普通的互联网sass云办公应用,会有用户管理、部门管理、账号管理等模块,如果把所有的这些模块都放在一个views.py文件之中,那么最后views.py文件必然臃肿不堪,并且极难维护,因此flask中便有了blueprint的概念,可以分别定义模块的视图、模板、视图等等,我们可以使用blueprint进行不同模块的编写,不同模块之间有着不同的静态文件、模板文件、view文件,十分方便代码的维护和管理,下面就是使用blueprint来进行上面用户管理、部门管理、账号管理模块的模拟编写,只涉及到api层面上,模板文件和静态文件就不写在上面了。

2、分模块后的结构

在进行分模块编写接口之后,以前提供的接口就不能写在一个views.py文件之中,具体结构如下所示:

640?wx_fmt=jpeg&tp=webp&wxfrom=5&wx_lazy

8481c8f592b7f349aa84a1de5c171db681516edfdept: 这是部门管理模块,views是相应的接口文件。
8481c8f592b7f349aa84a1de5c171db681516edf user: 这是用户管理模块,同上,views是用户管理的相应接口。

其他的和之前的类似。

3、业务模块

3.1 dept模块

__init__.py:

# coding:utf-8

from flask import Blueprint

dept = Blueprint('dept', __name__,)

from app.dept import views

在这里,我们定义了dept blueprint对象,便于在views.py文件中应用,替代Flask对象。主要的接口 
views.py:

# coding:utf-8

from app.dept import dept

from flask import jsonify

import json

dept_data = [

    {

        'name': '部门1',

        'id': 12345

    },

    {

        'name': '部门2',

        'id': 12346

    }

]



@dept.route('/<int:id>', methods=['GET', ])

def get(id):

    for dept in dept_data:

        if int(dept['id']) == id:

            return jsonify(status='success', dept=dept)



    return jsonify(status='failed', msg='dept not found')



@dept.route('/depts', methods=['GET', ])

def get_depts():

    data = {

        'status': 'success',

        'depts': dept_data

    }

    return json.dumps(data, ensure_ascii=False, indent=1)

提供两个接口,一个接口用于查询特定的部门,一个接口用于返回部门列表,dept对象我是模拟的部门数组,没有用models.py文件中dept对象,主要是在这一节中没有使用相应的orm框架,因此就没写相应的model,这个在随后中会涉及到。

另外一个,我在获取depts接口时,用的就不是jsonify方法了,而是内置的json.dumps转换为json对象,我之所以这样写,是因为jsonify如果要返回数组对象的话,必须要相应的对象实现一个方法返回json数据,或者将这个对象转成字典类型,然后循环遍历这个对象,比较麻烦,因此这里我就直接使用json.dumps来进行转换了。

在相应的路由注解上,我使用的就是dept.route,因此在定义了为dept的blueprint对象后,这里的作用相当于当初定义的app Flask对象,但其实是进行了view层的路由后,最终还是注册到了app上面,在代码层面上实现了不同模块之间的隔离。

3.2、user模块

user模块功能和代码大部分和dept相同,这里仅仅只贴出代码,不再描述具体的功能。

__init__.py:

# coding:utf-8

from flask import Blueprint

user = Blueprint('user', __name__,)

from app.user import views

views.py:

# coding: utf-8

from app.user import user

from flask import jsonify

import json

user_data = [

    {

        'id': 1,

        'name': '张三',

        'age': 23

    },

    {

        'id': 2,

        'name': '李四',

        'age': 24

    }

]

@user.route('/<int:id>', methods=['GET', ])

def get(id):

    for user in user_data:

        if user['id'] == id:

            return jsonify(status='success', user=user)



@user.route('/users', methods=['GET', ])

def users():

    data = {

        'status': 'success',

        'users': user_data

    }

    return json.dumps(data, ensure_ascii=False, indent=1)

3.3、run.py文件

最终Blueprint对象在run文件之中进行注册,如下:

# coding:utf-8

from app import app

from app.dept import dept

from app.user import user

app.register_blueprint(user, url_prefix='/user')

app.register_blueprint(dept, url_prefix='/dept')

if __name__ == '__main__':

    app.run()

app.register_blueprint在这里进行了Blueprint对象的注册和路由,在这里还有许多用法,如制定静态文件夹和模板文件夹等等,这些可以参考以下自己学习:使用蓝图的模块化应用

其他的我就没有再讲了,config.py和manager.py在这些简单的应用中还无需用到,讲到后面再来说这些的作用。

4、运行

启动run文件,进行运行,请求

http://localhost:5000/user/

结果:

第一个接口请求成功:

请求第二个接口:

http://localhost:5000/user/users
640?wx_fmt=jpeg&tp=webp&wxfrom=5&wx_lazy

接口同样请求成功,在这里dept模块就不去请求,结果是类似的。

5、总结

8481c8f592b7f349aa84a1de5c171db681516edf Blueprint其实本身只是对view上的接口进行了注册,然后整体挂载在app上,Blueprint本身的目的就是组织多模块的平行共存,避免直接在app上注册view,其实更多的只是方便开发和代码的维护,因为最终所有的views上的接口都仍然是直接挂载在app上,其实对应整个应用来说,没有什么明显的区别。
8481c8f592b7f349aa84a1de5c171db681516edf Flask 中的Blueprint不是一个可插拨的应用,因为它不是一个真正的应用,而是一套可以注册 在应用中的操作,并且可以注册多次。
8481c8f592b7f349aa84a1de5c171db681516edf 同时在这里,我们不能使用多个flask对象来管理和注册,因为这样会导致每个flask对象都有一个自己的配置,不好管理。
8481c8f592b7f349aa84a1de5c171db681516edf 使用Blueprint,应用会在Flask层中进行管理,共享配置,通过注册按需改变应用 对象。Blueprint的缺点是一旦应用被创建后,只有销毁整个应用对象才能注销lueprint。
8481c8f592b7f349aa84a1de5c171db681516edf 综合以上,简单来说,Blueprint就是通过url找到view的一套机制,并没有太过于复杂的逻辑。


原文发布时间为:2017-03-30

本文作者:夏轩

本文来自云栖社区合作伙伴“Python中文社区”,了解相关信息可以关注“Python中文社区”微信公众号

相关文章
|
5月前
|
关系型数据库 数据库连接 数据库
Flask应用基础入门总结
Flask应用基础入门总结
44 0
|
16天前
|
API 数据库 数据安全/隐私保护
Flask框架在Python面试中的应用与实战
【4月更文挑战第18天】Django REST framework (DRF) 是用于构建Web API的强力工具,尤其适合Django应用。本文深入讨论DRF面试常见问题,包括视图、序列化、路由、权限控制、分页过滤排序及错误处理。同时,强调了易错点如序列化器验证、权限认证配置、API版本管理、性能优化和响应格式统一,并提供实战代码示例。了解这些知识点有助于在Python面试中展现优秀的Web服务开发能力。
24 1
|
16天前
|
SQL 中间件 API
Flask框架在Python面试中的应用与实战
【4月更文挑战第18天】**Flask是Python的轻量级Web框架,以其简洁API和强大扩展性受欢迎。本文深入探讨了面试中关于Flask的常见问题,包括路由、Jinja2模板、数据库操作、中间件和错误处理。同时,提到了易错点,如路由冲突、模板安全、SQL注入,以及请求上下文管理。通过实例代码展示了如何创建和管理数据库、使用表单以及处理请求。掌握这些知识将有助于在面试中展现Flask技能。**
16 1
Flask框架在Python面试中的应用与实战
|
20天前
|
存储 Prometheus 监控
Flask监控与日志记录:掌握应用运行状况
【4月更文挑战第16天】本文介绍了在Flask应用中实现监控和日志记录的方法,以确保应用稳定性和问题排查。推荐使用Prometheus、Grafana、New Relic或Flask-MonitoringDashboard等工具进行监控,并通过Python的logging模块记录日志。监控集成涉及安装配置工具、添加监控代码,而日志管理则需要集中存储和使用分析工具。安全是关键,要防止未授权访问和数据泄露,避免记录敏感信息。监控和日志记录有助于提升应用性能和用户体验。
|
20天前
|
缓存 监控 数据库
Flask性能优化:打造高性能Web应用
【4月更文挑战第16天】本文介绍了提升Flask应用性能的七大策略:优化代码逻辑,减少数据库查询,使用WSGI服务器(如Gunicorn、uWSGI),启用缓存(如Flask-Caching),优化数据库操作,采用异步处理与并发(如Celery、Sanic),以及持续监控与调优。通过这些手段,开发者能有效优化Flask应用,适应大型或高并发场景,打造高性能的Web服务。
|
20天前
|
监控 安全 数据库
Flask应用部署指南:从开发到生产环境
【4月更文挑战第16天】本文是Flask应用从开发到生产的部署指南,涵盖开发环境准备、应用开发、部署方案选择、生产环境配置、应用部署、监控与维护。确保安装Python、Flask及依赖库,使用文本编辑器或IDE编写代码,关注应用安全与性能。选择WSGI服务器、Docker或云服务平台部署,配置生产环境,确保安全性,然后部署应用并进行监控维护,定期更新修复问题,保证应用稳定运行。
|
20天前
|
JSON 安全 API
Flask-Login与Flask-RESTful:扩展你的应用功能
【4月更文挑战第16天】本文介绍了两个实用的Flask扩展——Flask-Login和Flask-RESTful。Flask-Login提供用户认证和会话管理,简化了登录、注销和保护路由的逻辑。而Flask-RESTful则助力构建RESTful API,支持多种HTTP方法和请求解析。通过这两个扩展,开发者能轻松增强Flask应用的功能性,实现安全的用户认证和高效的API交互。
|
21天前
|
数据库 数据安全/隐私保护 开发者
WTForms在Flask中的应用:创建与验证表单
【4月更文挑战第16天】本文介绍了如何在Flask应用中使用WTForms进行表单处理。首先,通过`pip install WTForms`安装库,并在配置文件中启用CSRF保护。接着,创建表单类,如`RegistrationForm`,包含所需字段及验证规则。在视图函数中处理表单提交,验证数据并进行相应操作。最后,在模板中渲染表单,显示标签、输入字段及验证错误信息。WTForms提供便捷的表单创建和验证,增强应用交互性和安全性。
|
21天前
|
网络架构 Python
Flask路由与视图:构建你的第一个Web应用
【4月更文挑战第15天】Flask是Python的Web框架,其核心是路由和视图。路由通过`@app.route()`装饰器定义,将URL映射到视图函数。视图函数处理请求并返回响应。动态路由允许URL包含可变部分,如`&lt;username&gt;`,将参数传递给函数。本文通过示例展示了如何创建显示待办事项列表的Web应用,包括定义路由、视图、使用模板以及运行应用。这为基础的Flask应用开发提供了基础。
|
22天前
|
数据库 开发者 Python
Python中使用Flask构建简单Web应用的例子
【4月更文挑战第15天】Flask是一个轻量级的Python Web框架,它允许开发者快速搭建Web应用,同时保持代码的简洁和清晰。下面,我们将通过一个简单的例子来展示如何在Python中使用Flask创建一个基本的Web应用。