Web后端学习笔记Flask（4）视图函数

Flask中的视图函数以及视图类&＃xff1a;

添加视图函数还可以通过下面的方式add_url_rule进行&＃xff1a;

app.add_url_rule(rule,  endpoint,  view_func):

rule:  对应的url

endpoint&＃xff1a;相当于给url取一个名字

view_func&＃xff1a;视图函数

-------------------------------------------------------------------------------------------------------------------------------
endpoint用于反转视图函数得到url,如果给endpoint赋了值&＃xff0c;那么在使用url_for()获取视图函数的url时&＃xff0c;就不能再使用函数名作为参数&＃xff0c;而是应该使用endpoint来获取视图函数的url

from flask import Flask, url_forapp &＃61; Flask(__name__)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; True&＃64;app.route(&＃39;/&＃39;)
def hello_world():print(url_for("theList")) # 这里url_for的参数值只能是theList, 不能是my_list return &＃39;Hello World!&＃39;def my_list():return "This is item list"app.add_url_rule(rule&＃61;"/list/", endpoint&＃61;"theList", view_func&＃61;my_list)if __name__ &＃61;&＃61; &＃39;__main__&＃39;:app.run(debug&＃61;True)


标准类视图及其使用场景&＃xff1a;

如何将类变成一个视图函数&＃xff1a;类视图支持继承&＃xff0c;写完类视图&＃xff0c;需要通过add_url_rule进行添加

1. 标准类视图&＃xff1a;

标准类视图继承自flask.views.View,并且在子类中必须实现dispatch_request方法&＃xff0c;这个方法类似于视图函数&＃xff0c;也要返回一个基于Response或者其子类的对象.

from flask import Flask, url_for, viewsapp &＃61; Flask(__name__)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; True&＃64;app.route(&＃39;/&＃39;)
def hello_world():return &＃39;Hello World!&＃39;class ListView(views.View):def dispatch_request(self):"""类视图中必须实现这一个方法:return:"""return "This is list view"app.add_url_rule(rule&＃61;"/list/", endpoint&＃61;"list", view_func&＃61;ListView.as_view("list"))
# 这里的as_view会将一个对象转化为函数&＃xff0c;赋值给视图函数, 参数name是给转换后的函数取的名字if __name__ &＃61;&＃61; &＃39;__main__&＃39;:app.run(debug&＃61;True)


如果制定了endpoint,那么在使用url_for时必须使用endpoint, 如果没有指定&＃xff0c;那么就可以使用as_view中的名字。

类试图的应用&＃xff1a;

a. 例如有url需要返回字典

from flask import Flask, views, jsonifyapp &＃61; Flask(__name__)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; True&＃64;app.route(&＃39;/&＃39;)
def hello_world():return &＃39;Hello World!&＃39;class JsonView(views.View): # 定义基类def get_data(self):return NotImplementedErrordef dispatch_request(self):return jsonify(self.get_data())class ListView(JsonView):def get_data(self):return {"username": "Tom", "password": "2345"}app.add_url_rule(rule&＃61;"/list/", endpoint&＃61;"list", view_func&＃61;ListView.as_view("list"))
# 这里的as_view会将一个对象转化为函数&＃xff0c;赋值给视图函数, 参数name是给转换后的函数取的名字if __name__ &＃61;&＃61; &＃39;__main__&＃39;:app.run(debug&＃61;True)


JsonView类是基类&＃xff0c;定义get_data()方法&＃xff0c;ListView类是JsonView类的基类&＃xff0c;在基类中&＃xff0c;重新实现了get_data()方法&＃xff0c;在调用ListView中的dispatch_request()方法的时候&＃xff0c;由于ListView中未重写dispatch_request()方法&＃xff0c;所以回去调用父类中的dispatch_request()方法&＃xff0c;在父类的dispatch_request()方法中会调用get_data()方法&＃xff0c;而在子类ListView中实现了get_data方法&＃xff0c;所以实际调用的是子类ListView中的方法&＃xff0c;返回字典

b. 有几个url需要返回相同的变量&＃xff1a;

例如&＃xff0c;在登陆页面以及注册页面&＃xff0c;需要展示相同的广告&＃xff0c;则可以通过下面继承的方法实现&＃xff1a;

from flask import Flask, views, render_templateapp &＃61; Flask(__name__)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; True&＃64;app.route(&＃39;/&＃39;)
def hello_world():return &＃39;Hello World!&＃39;class AdsView(views.View): # 广告内容def __init__(self):super(AdsView, self).__init__() # 调用父类的init方法self.ad_content &＃61; {"product": "GMCC-1001"}def dispatch_request(self):return NotImplementedError # 因为基类中的这个方法不会被调用class LoginView(AdsView):def dispatch_request(self):return render_template("html/login.html", **self.ad_content)class RegisterView(AdsView):def dispatch_request(self):return render_template("html/registry.html", **self.ad_content)app.add_url_rule(rule&＃61;"/login/", endpoint&＃61;"login", view_func&＃61;LoginView.as_view("login"))
app.add_url_rule(rule&＃61;"/registry/", endpoint&＃61;"registry", view_func&＃61;RegisterView.as_view("registry"))if __name__ &＃61;&＃61; &＃39;__main__&＃39;:app.run(debug&＃61;True)


通过这种方法&＃xff0c;可已将相同的广告内容展示在不同的页面。且修改起来更加的容易。

2. 基于请求方法的视图

Flask还提供了另一种类视图&＃xff0c;flask.view.Methodview,对每个http执行不同的函数&＃xff08;映射到对应方法的小写的同名方法上&＃xff09;&＃xff0c;这对restful API尤其有用。

基于方法的类视图&＃xff0c;是根据请求的“method”不同来执行不同的方法的&＃xff0c;如果用户是发送的“get”请求&＃xff0c;那么将会执行这个类的get方法&＃xff0c;如果发送的是post请求&＃xff0c;将会执行类的post方法。其他的“method”也类似&＃xff0c;例如delete,put方法

from flask import Flask, views, render_template, requestapp &＃61; Flask(__name__)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; True&＃64;app.route(&＃39;/&＃39;)
def hello_world():return &＃39;Hello World!&＃39;class LoginView(views.MethodView):def get(self, error&＃61;None):return render_template("html/login.html", error&＃61;error)def post(self):"""获取post请求提交的参数:return:"""username &＃61; request.form.get("username")password &＃61; request.form.get("password")if username &＃61;&＃61; "knight" and password &＃61;&＃61; "123456":return self.get(error&＃61;"success")else:return self.get(error&＃61;"fail")app.add_url_rule(rule&＃61;"/login/", view_func&＃61;LoginView.as_view("login"))if __name__ &＃61;&＃61; &＃39;__main__&＃39;:app.run(debug&＃61;True)


前端代码&＃xff1a;

类视图中使用装饰器&＃xff1a;

1. 如果使用的是函数视图&＃xff0c;那么自己定义的装饰器必须放在“app.route()”装饰器的下面才能生效。否则这个装饰器不能起作用。

2. 类视图的装饰器需要重写类视图的一个属性decorates&＃xff0c;这个类属性是一个列表或者元组&＃xff0c;里面装的就是所有的装饰器。

应用场景&＃xff1a;例如网站上的个人信息页面和设置页面&＃xff0c;在跳转到这些页面的时候&＃xff0c;如果用户没有登陆&＃xff0c;则会自动跳转到登陆页面&＃xff0c;

提醒用户登陆。只有在登录状态下才能访问这些页面&＃xff0c;下面通过装饰器模拟这一功能。

from flask import Flask, views, render_template, request
from functools import wrapsapp &＃61; Flask(__name__)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; Truedef login_required(func): # 定义装饰器&＃64;wraps(func) # 保留参数 函数func的一些属性&＃xff0c;如__name__属性等def wrapper(*args, **kwargs):username &＃61; request.args.get("username")if username and username &＃61;&＃61; "Tom":return func(*args, **kwargs)else:return "请先登陆"return wrapper&＃64;app.route(&＃39;/&＃39;)
def hello_world():return &＃39;Hello World!&＃39;&＃64;app.route(&＃39;/setting/&＃39;)
&＃64;login_required # 自定义的装饰器应该放在url的下main
def setting():return "User setting"# 给类视图添加装饰器
class ProfileView(views.View):decorators &＃61; [login_required]def dispatch_request(self):return "这是个人页面"app.add_url_rule("/profile/", view_func&＃61;ProfileView.as_view("profile"))if __name__ &＃61;&＃61; &＃39;__main__&＃39;:app.run(debug&＃61;True)


在这些页面中&＃xff0c;只有请求参数中有用户名参数的时候&＃xff0c;才能够跳转到相应的页面&＃xff0c;否则会提示登陆。

蓝图的基本使用&＃xff1a;

蓝图用于将一个大型Flask项目分层解耦&＃xff0c;进行模块化划分,可以将相同模块的视图函数放在同一个文件中&＃xff0c;统一进行管理

例如&＃xff0c;网站主要可以划分为新闻&＃xff0c;电影&＃xff0c;图书&＃xff0c;个人中心四个模块&＃xff0c;则可以按照如下的方式进行划分&＃xff1a;

user.py文件&＃xff1a;&＃xff08;初始化蓝图&＃xff09;

# -*- coding: utf-8 -*-
from flask import Blueprintuser_bp &＃61; Blueprint("user", __name__, url_prefix&＃61;"/user") # 初始化蓝图# 个人中心
&＃64;user_bp.route(&＃39;/profile/&＃39;)
def profile():return "个人中心页面"&＃64;user_bp.route("/settings/")
def settings():return "设置页面"

news.py文件 (初始化蓝图), 同时在news.py中渲染html文件的方法不变&＃xff1a;

# -*- coding: utf-8 -*-
from flask import Blueprint, render_templatenews_bp &＃61; Blueprint("news", __name__, url_prefix&＃61;"/news")&＃64;news_bp.route("/news_list/")
def news_list():return render_template("html/news_list.html")&＃64;news_bp.route("/news_detail/")
def news_detail():return "新闻详情"


在app.py文件中&＃xff0c;注册上面创建的蓝图

from flask import Flask, views, render_template, request
from blueprints.user import user_bp
from blueprints.news import news_bpapp &＃61; Flask(__name__)
app.register_blueprint(user_bp)
app.register_blueprint(news_bp)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; True&＃64;app.route(&＃39;/&＃39;)
def hello_world():return &＃39;Hello World!&＃39;if __name__ &＃61;&＃61; &＃39;__main__&＃39;:app.run(debug&＃61;True)


这样就将项目中的视图函数分模块进行管理。

url_prefix&＃xff1a;url前缀&＃xff0c;如果加了&＃xff0c;则视图函数对应的url前面必须有前缀&＃xff0c;且只能有一个斜杠

route中还可以指定template_folder参数&＃xff0c;如果制定了这个参数template_folder&＃61;“xxx”&＃xff0c;那么flask在渲染模板的时候&＃xff0c;首先会去项目中的templates文件夹中寻找&＃xff0c;如果没有找到&＃xff0c;flask接下来会去blueprints/xxx文件夹中寻找模板文件。

蓝图中静态文件的寻找规则&＃xff1a;

1. 在模板文件中&＃xff0c;加载静态文件&＃xff0c;如果使用url_for(&＃39;static&＃39;)&＃xff0c;那么就会在app指定的静态文件夹目录下查找静态文件

2.如果在加载静态文件的时候&＃xff0c;指定了蓝图的名字&＃xff0c;比如“news.static”,那么Flask就会到这个蓝图指定的static_folder下查找静态文件。

url_for反转蓝图注意事项&＃xff1a;

如果需要跨文件反转视图函数&＃xff0c;则需要指定视图函数的蓝图名字&＃xff0c;再加上视图函数名字&＃xff0c;例如&＃xff1a;

&＃64;app.route(&＃39;/&＃39;)
def hello_world():print(url_for("news.news_list"))return &＃39;Hello World!&＃39;

例如&＃xff0c;需要反转news_list视图函数&＃xff0c;则需要在加上其蓝图的名字才可以&＃xff0c;在模板中和在python文件中的用法一样&＃xff0c;同样需要加蓝图的名字。

即使在同一个蓝图中反转视图函数&＃xff0c;也需要指定蓝图的名字。

子域名实现详解&＃xff1a;

1. 使用蓝图技术

2. 在创建蓝图对象的时候&＃xff0c;需要传递一个"subdomain"参数&＃xff0c;来指定这个子域名的前缀&＃xff1a;

3. 需要在主app文件中&＃xff0c;需要配置serve name参数&＃xff1a;

【注】IP地址不能有子域名&＃xff0c;localhost不能有子域名

例如&＃xff0c;CMS子域名&＃xff1a;

# -*- coding: utf-8 -*-
from flask import Blueprintcms_bp &＃61; Blueprint("cms", __name__, subdomain&＃61;"cms")&＃64;cms_bp.route("/")
def index():return "Cms index Page"


在app.py文件中设置&＃xff1a;

from blueprints.cms import cms_bpapp.register_blueprint(cms_bp)app.config["TEMPLATE_AUTO_RELOAD"] &＃61; True
app.config["SERVER NAME"] &＃61; "jd.com:5000"
# 修改host文件&＃xff1a;
# 127.0.0.1 jd.com
# 127.0.0.1 cms.jd.com

此时设置完毕计算机的host文件后&＃xff0c;在本地计算机访问jd.com,就会映射到127.0.0.1

---------------------------------------------------------------------------------------------------------------------------------------