插拔式视图

基本规则

@app.route('/users/')

def show_users(page):

  user = User.query.all()

  return render_template('users.html',users=users)

from flask.views import View

class ShowUsers(View): def dispatch_request(self): users = User.query.all() return render_template('users.html', objects=users) app.add_url_rule('/users/', view_func=ShowUsers.as_view('show_users'))

正如你所见,你需要做的是创建一个 flask.views.View 的子类,并且实现 dispatch_request() 。然后我们需要用类方法 as_view() 把这个类转换到一个实际的视图函数。你传给 这个函数的字符串是视图之后的最终名称。但是用它自己实现的方法不够有效,所以我们稍微重构一下代码:

from flask.views import View

class ListView(View): def get_template_name(self): raise NotImplementedError() def render_template(self, context): return render_template(self.get_template_name(), **context) def dispatch_request(self): context = {'objects': self.get_objects()} return self.render_template(context) class UserView(ListView): def get_template_name(self): return 'users.html' def get_objects(self): return User.query.all()

这当然不是那么有助于一个小例子,但是对于解释基本规则已经很有用了。当你有一个基于类的视图,那么问题来了, self 指向什么。它工作的方式是,无论何时请求被调度,会创建这个类的一个新实例, 并且 dispatch_request() 方法会以 URL 规则为参数调用。 这个类本身会用传递到 as_view() 函数的参数来实例化。 比如,你可以像这样写一个类:

class RenderTemplateView(View):
    def __init__(self, template_name): self.template_name = template_name def dispatch_request(self): return render_template(self.template_name) 

接着你可以像这样注册它:

app.add_url_rule('/about', view_func=RenderTemplateView.as_view( 'about_page', template_name='about.html')) 

方法提示

插拨式视图通过使用 route() 或者 更好的 add_url_rule() 像一般的函数一样依附到应用。 然而这也意味着当你附加它时必须给出视图支持的 HTTP 方法的名称。为了将这个信息加入到类中, 你可以提供 methods 属性:

class MyView(View):
    methods = ['GET', 'POST'] def dispatch_request(self): if request.method == 'POST': ... ... app.add_url_rule('/myview', view_func=MyView.as_view('myview')) 

基于调度的方法

对每个 HTTP 方法执行不同的函数,对 RESTful API 非常有用。你可以通过 flask.views.MethodView 容易地实现。每个 HTTP 方法映射到同名函数(只有名称为小写的):

from flask.views import MethodView

class UserAPI(MethodView): def get(self): users = User.query.all() ... def post(self): user = User.from_form_data(request.form) ... app.add_url_rule('/users/', view_func=UserAPI.as_view('users')) 

如此你可以不提供 methods 属性。它会自动的按照类中定义的方法来设置。

装饰视图

既然视图类自己不是加入到路由系统的视图函数,那么装饰视图类并没有多大意义。 相反的,你可以手动装饰 as_view() 的返回值:

def user_required(f):
    """Checks whether user is logged in or raises error 401.""" def decorator(*args, **kwargs): if not g.user: abort(401) return f(*args, **kwargs) return decorator view = user_required(UserAPI.as_view('users')) app.add_url_rule('/users/', view_func=view) 

从 Flask 0.8 开始,你也有一种在类声明中设定一个装饰器列表的方法:

class UserAPI(MethodView):
    decorators = [user_required] 

因为从调用者的视角来看 self 是不明确的,所以你不能在单独的视图方法上使用常规的视图装饰器,请记住这些。

用于 APIs 的方法视图

Web APIs 通常和 HTTP 动词紧密合作,因此实现一个基于 MethodView 的 API 是十分有意义的。 也是说,你将会发现大部分时候 API 需要不同的 URL 规则去访问同一方法视图。例如考虑你正在网页上显示一个用户:

URLMethodDescription
/users/GETGives a list of all users
/users/POSTCreates a new user
/users/<id>GETShows a single user
/users/<id>PUTUpdates a single user
/users/<id>DELETEDeletes a single user

因此你将用 MethodView 怎么去实现?诀窍是利用你可以对相同的视图提供多个规则的事实。

让我们暂时假设视图像这样:

class UserAPI(MethodView):

    def get(self, user_id): if user_id is None: # return a list of users pass else: # expose a single user pass def post(self): # create a new user pass def delete(self, user_id): # delete a single user pass def put(self, user_id): # update a single user pass 

如此,我们怎样把它连接到路由系统中?添加两条规则,并且为每条规则显式地指出 HTTP 方法:

user_view = UserAPI.as_view('user_api') app.add_url_rule('/users/', defaults={'user_id': None}, view_func=user_view, methods=['GET',]) app.add_url_rule('/users/', view_func=user_view, methods=['POST',]) app.add_url_rule('/users/<int:user_id>', view_func=user_view, methods=['GET', 'PUT', 'DELETE']) 

如果你有许多看起来类似的 API ,你可以重构上述的注册代码:

def register_api(view, endpoint, url, pk='id', pk_type='int'): view_func = view.as_view(endpoint) app.add_url_rule(url, defaults={pk: None}, view_func=view_func, methods=['GET',]) app.add_url_rule(url, view_func=view_func, methods=['POST',]) app.add_url_rule('%s<%s:%s>' % (url, pk_type, pk), view_func=view_func, methods=['GET', 'PUT', 'DELETE']) register_api(UserAPI, 'user_api', '/users/', pk='user_id')
 

转载于:https://www.cnblogs.com/suncunxu/p/11282696.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值