Flask クラスビュー API
Flask は2種類のクラスビューを提供し、オブジェクト指向の方法でビューロジックを整理できます。
View最も基本的なクラスビューです。MethodViewHTTP メソッドに従って自動的にディスパッチします。
View 基底クラス
| 属性/メソッド | 説明 |
|---|---|
| methods | クラス属性。ビューが受け付けるHTTPメソッドのリスト。デフォルトはNone(add_url_rule のデフォルト値を使用) |
| decorators | クラス属性。デコレータのリスト。生成されたビュー関数に順番に適用されます |
| init_every_request | クラス属性、bool。True(デフォルト)の場合、リクエストごとに新しいインスタンスを作成し、Falseの場合は単一インスタンスを再利用します |
| provide_automatic_options | クラス属性。OPTIONS を自動的に実装するかどうか。デフォルトはNone(アプリケーション設定を使用) |
| dispatch_request(**kwargs) | コアメソッド。オーバーライドする必要があります。kwargs は URL 変数です |
| as_view(name, *class_args, **class_kwargs) | クラスメソッド。add_url_rule で使用できるビュー関数を作成します |
MethodView クラス
View から継承し、HTTP メソッドに応じて対応するインスタンスメソッドに自動的にディスパッチします。
| メソッド命名規則 | 説明 |
|---|---|
| get(self, **kwargs) | GET リクエストを処理します |
| post(self, **kwargs) | POST リクエストを処理します |
| put(self, **kwargs) | PUT リクエストを処理します |
| delete(self, **kwargs) | DELETE リクエストを処理します |
| patch(self, **kwargs) | PATCH リクエストを処理します |
これらのメソッドを定義すると、methods属性は定義されたメソッドに基づいて自動的に設定されます。
View vs MethodView
| 特徴 | View | MethodView |
|---|---|---|
| ディスパッチ方法 | 単一の dispatch_request がすべてのメソッドを処理します | メソッド名に応じて自動的にディスパッチ(get→GET など) |
| 適用シーン | 汎用ビュー、テンプレートレンダリング | RESTful API |
コード例
例
from flask import Flask, request, session, redirect, url_for
from flask.views import View, MethodView
app = Flask(__name__)
# 基本的な View:単一の dispatch_request
class HelloView(View):
def dispatch_request(self, name):
return f"<h1>Hello, {name}!</h1>"
app.add_url_rule("/hello/<name>", view_func=HelloView.as_view("hello"))
# MethodView:RESTful API
class PostAPI(MethodView):
# カスタム初期化(リクエストごとに呼び出されます)
def __init__(self):
self.db = get_database_connection()
def get(self, post_id=None):
if post_id is None:
posts = self.db.query_all_posts()
return {"posts": posts}
return self.db.get_post(post_id)
def post(self):
data = request.json
post_id = self.db.create_post(data["title"], data["body"])
return {"id": post_id}, 201
def delete(self, post_id):
self.db.delete_post(post_id)
return {"message": "deleted"}
# 登録:同じビュー関数で複数のメソッドを処理
post_view = PostAPI.as_view("post_api")
app.add_url_rule("/api/posts", defaults={"post_id": None},
view_func=post_view, methods=["GET", "POST"])
app.add_url_rule("/api/posts/<int:post_id>",
view_func=post_view, methods=["GET", "DELETE"])
from flask.views import View, MethodView
app = Flask(__name__)
# 基本的な View:単一の dispatch_request
class HelloView(View):
def dispatch_request(self, name):
return f"<h1>Hello, {name}!</h1>"
app.add_url_rule("/hello/<name>", view_func=HelloView.as_view("hello"))
# MethodView:RESTful API
class PostAPI(MethodView):
# カスタム初期化(リクエストごとに呼び出されます)
def __init__(self):
self.db = get_database_connection()
def get(self, post_id=None):
if post_id is None:
posts = self.db.query_all_posts()
return {"posts": posts}
return self.db.get_post(post_id)
def post(self):
data = request.json
post_id = self.db.create_post(data["title"], data["body"])
return {"id": post_id}, 201
def delete(self, post_id):
self.db.delete_post(post_id)
return {"message": "deleted"}
# 登録:同じビュー関数で複数のメソッドを処理
post_view = PostAPI.as_view("post_api")
app.add_url_rule("/api/posts", defaults={"post_id": None},
view_func=post_view, methods=["GET", "POST"])
app.add_url_rule("/api/posts/<int:post_id>",
view_func=post_view, methods=["GET", "DELETE"])