Flask ルーティング

ルーティング(Routing)はWebフレームワークの中核となる機能の1つであり、どのURLをどの関数が処理するかを決定します。

Flask ルーティングは、WebアプリケーションにおいてURLをPython関数にマッピングする仕組みです。

Flask ルーティングはFlaskアプリケーションの核心部分であり、さまざまなURLのリクエストを処理し、リクエストの処理を対応するビュー関数に委任します。

以下はFlaskルーティングの詳細な説明です。ルーティングの定義、パラメータ、メソッド、ルールなどを含みます。


基本ルーティング

使用@app.route()デコレータはURLパスをビュー関数にバインドします:

例

from flask import Flask

app = Flask(__name__)

# ルートパス "/" をバインド
@app.route("/")
def index():
    return "これはホームページです"

# "/hello" パスをバインド
@app.route("/hello")
def hello():
    return "Hello, サンプル!"

# 異なるパスは異なる関数に対応します
@app.route("/about")
def about():
    return "关于本站"

アクセスhttp://127.0.0.1:5000/hello時、Flask は呼び出しますhello()関数。

アクセスhttp://127.0.0.1:5000/about時、Flask は呼び出しますabout()関数。


変数ルール

実際のアプリケーションでは、URLには通常、ユーザーIDや記事タイトルなどの動的な部分が含まれます。

Flask は<変数名>構文を使用してURL内で動的部分を定義し、対応するパラメータは自動的にビュー関数に渡されます。

文字列変数(デフォルトタイプ)

型を指定しない場合、変数はデフォルトで文字列となり、マッチするのはスラッシュ以外/の任意の文字:

例

# <username> は動的変数で、Flask はその値を keyword パラメータとしてビュー関数に渡します
@app.route("/user/<username>")
def show_user(username):
    # 注意:username には悪意のあるスクリプトが含まれる可能性があるため、実際の本番環境ではエスケープが必要です
    return f"<h1>用户:{username}</h1>"

# テストアクセス:
# /user/サンプル → ページに表示 "用户:サンプル"
# /user/サンプル → ページに表示 "用户:サンプル"

型コンバータ

Flask には複数のコンバータが組み込まれており、<型:変数名>構文で指定します:

コンバータ 説明 URL例 マッチ結果
string デフォルト、/ を含まないテキストを受け入れます /user/サンプル username = "サンプル"
int 正の整数 /post/42 post_id = 42
float 正の浮動小数点数 /price/19.99 price = 19.99
path / を含む文字列を受け入れます /file/a/b/c.txt filepath = "a/b/c.txt"
uuid UUID 形式の文字列 /item/550e8400-e29b-41d4-a716-446655440000 item_id = UUID 文字列

例

# int コンバータ:数字のみがマッチし、/post/abc は 404 を返します
@app.route("/post/<int:post_id>")
def show_post(post_id):
    # post_id の型は int で、文字列ではありません
    return f"<h1>文章 #{post_id}</h1>"

# path コンバータ:/ を含むパスにマッチできます
@app.route("/file/<path:filepath>")
def show_file(filepath):
    return f"<p>文件路径:{filepath}</p>"

# float コンバータ:浮動小数点数にマッチします
@app.route("/price/<float:amount>")
def show_price(amount):
    return f"<p>价格:¥{amount}</p>"

# uuid コンバータ:標準の UUID 形式のみ受け入れます
@app.route("/item/<uuid:item_id>")
def show_item(item_id):
    return f"<p>商品 ID:{item_id}</p>"

コンバータは型検証を行うだけでなく、マッチした値を対応するPython型に自動的に変換します。例えば<int:post_id>ビュー関数に渡されるのはintではなくstr。


末尾スラッシュのリダイレクト動作

URL末尾の/はルーティングのマッチ動作に直接影響します。この点は多くの初心者が混乱するところです。

例

# ルール1:/ で終わる——ディレクトリと同様
# /projects へのアクセスは自動的に /projects/ へ 308 リダイレクトされます
@app.route("/projects/")
def projects():
    return "项目列表页面"

# ルール2:/ で終わらない——ファイルと同様
# /about/ へのアクセスは 404 Not Found を返します
@app.route("/about")
def about():
    return "关于页面"
ルート定義 /projects へのアクセス /projects/ へのアクセス
@app.route("/projects/") /projects/ へ 308 リダイレクト 正常に返る
@app.route("/about") 正常に返る 404 Not Found

この設計はSEOに役立ちます。同じコンテンツに対して標準URLが1つだけであることを保証し、検索エンジンが同じページを2回インデックスするのを防ぎます。


URL 構築——url_for

url_for()は Flask 組み込みの URL 生成関数で、ビュー関数名に基づいて対応する URL を生成します。

これはURL文字列をハードコードするよりも多くの利点があります:

  • 後でURLルートを変更した場合、すべてのurl_for生成箇所は自動的に更新されます
  • 特殊文字のエスケープを自動的に処理します
  • 生成されるパスは常に絶対パスです

例

from flask import Flask, url_for

app = Flask(__name__)

@app.route("/")
def index():
    return "首页"

@app.route("/login")
def login():
    return "登录页面"

@app.route("/user/<username>")
def profile(username):
    return f"{username} の個人ホームページ"

# test_request_context() を使用してリクエストコンテキストをシミュレートします
# これにより url_for() は正しく URL を生成できます
with app.test_request_context():
    print(url_for("index"))                    # 出力 /
    print(url_for("login"))                    # 出力 /login
    print(url_for("login", next="/"))          # 出力 /login?next=%2F
    print(url_for("profile", username="サンプル"))  # 出力 /user/サンプル

url_for()の最初のパラメータはビュー関数名です(関数名であって、URLパスではないことに注意)。

URLに動的変数が含まれる場合は、対応する値をキーワード引数として渡すだけです。

余分な未知のパラメータは自動的にクエリ文字列として連結されます。


HTTP メソッド

デフォルトでは、ルートはGETリクエストにのみ応答します。

を通じてmethodsパラメータで許可されるHTTPメソッドを指定できます:

例

from flask import Flask, request

app = Flask(__name__)

# 同じURLがGETとPOSTリクエストの両方に応答します
@app.route("/login", methods=["GET", "POST"])
def login():
    # request.method を使用して現在のリクエストタイプを判定します
    if request.method == "POST":
        # ログインフォームの送信を処理します(POSTリクエスト時に実行)
        username = request.form.get("username")
        return f"<h1>欢迎回来,{username}!</h1>"
    else:
        # ログインフォームを表示します(GETリクエスト時に実行)
        return """
        <form method="post">
<input type="text" name="username" placeholder="用户名">
<input type="submit" value="登录">
        </form>
        """

ショートカットメソッドデコレータ

Flask は一般的な HTTP メソッドに対して省略記法のデコレータを提供し、コードをより明確にします:

例

# @app.route("/login", methods=["GET"]) と同等
@app.get("/login")
def login_form():
    return "<form>...</form>"

# @app.route("/login", methods=["POST"]) と同等
@app.post("/login")
def login_submit():
    return "登录成功"

# さらに @app.put()、@app.delete()、@app.patch() もサポートしています
@app.delete("/post/<int:post_id>")
def delete_post(post_id):
    # 記事削除の API
    return f"文章 {post_id} 已删除"
ショートカットデコレータ 同等の記述 典型的な用途
@app.get("/path") @app.route("/path", methods=["GET"]) データ取得、ページ表示
@app.post("/path") @app.route("/path", methods=["POST"]) データ作成、フォーム送信
@app.put("/path") @app.route("/path", methods=["PUT"]) データ更新(完全置換)
@app.delete("/path") @app.route("/path", methods=["DELETE"]) データ削除
@app.patch("/path") @app.route("/path", methods=["PATCH"]) データ更新(部分更新)

自動処理:ルートが定義されている場合、GETメソッドに対して、Flask は自動的にHEADメソッドのサポートを追加します。同時にOPTIONSメソッドも通常は自動的に処理されます。


複数のルートを同時にバインド

同じビュー関数に複数のルートをバインドできます:

例

# 2つの異なるURLが同じビュー関数を指す
@app.route("/hello")
@app.route("/hello/<name>")
def greet(name=None):
    # nameのデフォルト値はNoneで、/helloにアクセスするとnameはNoneになる
    if name is None:
        return "<h1>Hello, World!</h1>"
    return f"<h1>Hello, {name}!</h1>"

アクセス/hello 时 nameデフォルト値を取得None、アクセス/hello/サンプル 时 nameために"サンプル"。

その他の拡張機能