Python之Flask 路由和蓝图

2024-11-24 来源：个人技术集锦

1. 路由

@app.route('/index')
def index():
    return "hello world"

1.1 查询路由信息

命令行方式

>flask routes
Endpoint  Methods  Rule
--------  -------  -----------------------
index     GET      /index
static    GET      /static/<path:filename>

在程序中获取

print(app.url_map)
#Map([<Rule '/index' (HEAD, GET, OPTIONS) -> index>,<Rule '/static/<filename>' (HEAD, GET, OPTIONS) ->static>])

在程序中获取路由信息，可采用如下方式

for rule in app.url_map.iter_rules():
    print('name={%s} path={%s}' %(rule.endpoint, rule.rule))
    
#name={index} path={/index}
#name={static} path={/static/<path:filename>}

@app.route('/')
def route_map():
    rules_iter = app.url_map.iter_rules()
    return json.dumps({rule.endpoint:rule.rule for rule in rules_iter})

1.2 指定请求方式
在Flask中，定义路由其默认的请求方式为：

GET
OPTIONS（自带）
HEAD（自带）

利用methods参数可以自己指定一个接口的请求方式

@app.route('/index', methods=['GET'])
def index():
    return "hello world"

@app.route('/', methods=['GET','POST'])
def route_map():
    rules_iter = app.url_map.iter_rules()
    return json.dumps({rule.endpoint:rule.rule for rule in rules_iter})

1.3 类视图的指定方式

Flask的views中提供了MethodView类可以根据请求方法自己调用自定义类视图的方法函数，跟django的View类一样

from flask import Flask, views, render_template, session, redirect, url_for


app = Flask(__name__)
app.secret_key = 'abcdefg'

class LoginView(views.MethodView):

    def get(self):
        return render_template('login.html')

    def post(self):
        session['username'] = 'zhangsan'
        return redirect('http://www.baidu.com')


def index():
    if session.get('username', None) is None:
        return redirect(url_for('login_view'))
    return render_template('index.html', user_info={'user_id':123,'username':'zs'})

# 视图函数也可以用这种方式注册
app.add_url_rule('/index',view_func=index)
# 视图类的注册方式
app.add_url_rule('/login', view_func=LoginView.as_view(name='login_view'))

2. 蓝图

需求
在一个Flask 应用项目中，如果业务视图过多，可否将以某种方式划分出的业务单元单独维护，将每个单元用到的视图、静态文件、模板文件等独立分开？

例如从业务角度上，可将整个应用划分为用户模块单元、商品模块单元、订单模块单元，如何分别开发这些不同单元，并最终整合到一个项目应用中？

2.1 蓝图
在Flask中，使用Blueprint来分模块组织管理

蓝图实际可理解为是一个存储一组视图方法的容器对象，其具有如下特点：

一个应用可以有多个Blueprint
可将一个Blueprint注册到任何一个未使用的URL下，如"/users"、"/goods"
Blueprint可以单独具有自己的模板、静态文件或者其他通用操作方法，它并不是必须要实现应用的视图和函数的
在一个应用初始化时，就应该要注册需要使用的Blueprint

一个Blueprint并不是一个完整的应用，它不能独立于应用运行，而是必须要注册到某一个应用中。

2.2 使用方式

使用蓝图Blueprint可分为三个步骤

# 创建蓝图
users_bp = Blueprint('users', __name__, static_folder='static_users')
# 导入视图 注意顺序必须放在蓝图后面，这一步需要在第2步结束后再做
from .views import *

在这个蓝图对象上进行操作，注册路由，指定静态文件夹，注册模板过滤器等。如users包下创建一个views.py文件

from users import users_bp

@users_bp.route('/')
def user_info():
    return "用户信息"

在入口文件中的Flask应用对象上注册蓝图

from flask import Flask

from users import users_bp

app = Flask(__name__)

# 注册蓝图 url_prefix指定url前缀
app.register_blueprint(users_bp, url_prefix='/users')

单文件蓝图
可以将创建蓝图对象与定义视图放到一个文件中。

2.3 扩展用法

1) 指定蓝图的url前缀
在应用中注册蓝图时使用url_prefix参数指定

app.register_blueprint(users_bp, url_prefix='/users')

2) 蓝图内部静态文件

# 创建蓝图
users_bp = Blueprint('users', __name__, static_folder='static_users')
# http://localhost:5000/users/static_users/1.png

也可通过static_url_path改变访问路径

users_bp = Blueprint('users', __name__, static_folder='static_users', static_url_path='/static')
# http://localhost:5000/users/static/1.png

users_bp = Blueprint('users', __name__,template_folder='templates_users', static_folder='static_users', static_url_path='/static')

显示全文

全部栏目

Python之Flask 路由和蓝图

1. 路由

2. 蓝图