Jinja2 テンプレート — HTML ページのレンダリング
この章では、Jinja2 テンプレートエンジンを使って完全な HTML ページをレンダリングし、共通レイアウトを抽出する方法を学びます。
文字列からテンプレートへ
前の章では、ビュー関数が直接文字列を返し、その中に HTML タグが埋め込まれていたため、再利用できず、保守が困難でした。
render_template()(render_template() は)Flask がテンプレートをレンダリングする入り口です。HTML ファイルをロードし、変数を注入し、完全な HTML レスポンスを返します。
例
from flask import Flask, render_template
app = Flask(__name__)
@app.route("/")
def index():
# render_template('テンプレートファイル名', 変数名=値, ...)
return render_template('index.html', title='サンプル ブログ')
Flask はデフォルトでプロジェクトのルートディレクトリのtemplates/フォルダ内でテンプレートを検索します。
テンプレートファイルの作成
プロジェクトのルートディレクトリにtemplates/フォルダを作成し、次にindex.html。
例
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>{{ title }}</title>
</head>
<body>
<h1>{{ title }}</h1>
<p>ようこそ。これは Jinja2 テンプレートエンジンでレンダリングされたページです。</p>
</body>
</html>
Jinja2 テンプレート構文の概要
Jinja2 の構文は Django テンプレートの構文とほぼ完全に同じで、Vue3 の挿入構文(インターポレーション)にも似ています。
| 用途 | Jinja2 / Django | 説明 |
|---|---|---|
| 変数の出力 | {{ variable }} | 属性アクセスをサポート:{{ user.name }} |
| ループ | {% for item in list %}...{% endfor %} | loop.index をサポート |
| 条件 | {% if cond %}...{% endif %} | チェーン可能:{% elif %} |
| 継承 | {% extends 'base.html' %} | 最初の行にある必要があります |
| ブロック定義 | {% block name %}...{% endblock %} | 子テンプレートが親テンプレートの空き部分を埋める |
Jinja2 と Django テンプレートの構文はほぼ同じですが、Jinja2 はより柔軟です。テンプレート内でより複雑な Python 式を記述できます。Django テンプレートは、ビジネスロジックがテンプレートに漏れないようにするため、意図的にいくつかの機能を制限しています。
テンプレート継承:base.html
複数のページでナビゲーションバーとフッターを共有するには、テンプレート継承を使って HTML の重複を避けます。
base.html 親テンプレートの作成
例
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- block title:子テンプレートはページタイトルを上書きできます -->
<title>{% block title %}サンプル ブログ{% endblock %}</title>
<style>
* { margin: 0; padding: 0; box-sizing: border-box; }
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
background: #f5f5f5;
color: #333;
}
.navbar {
display: flex; justify-content: space-between; align-items: center;
padding: 16px 40px; background: #fff;
box-shadow: 0 2px 8px rgba(0,0,0,0.1);
}
.navbar .logo { font-size: 22px; font-weight: bold; color: #e74c3c; text-decoration: none; }
.navbar a { margin-left: 20px; text-decoration: none; color: #333; }
.container { max-width: 960px; margin: 40px auto; padding: 0 20px; }
.footer { text-align: center; padding: 20px; color: #999; border-top: 1px solid #eee; }
</style>
{% block extra_head %}{% endblock %}
</head>
<body>
<header class="navbar">
<a href="/" class="logo">サンプル ブログ(Flask)</a>
<nav>
<a href="/">ホーム</a>
<a href="/about">概要</a>
</nav>
</header>
<main class="container">
<!-- block content:子テンプレートはここにページのメインコンテンツを挿入します -->
{% block content %}
{% endblock %}
</main>
<footer class="footer">
<p>© 2024 サンプル ブログ. Powered by Flask.</p>
</footer>
</body>
</html>
子テンプレートが親テンプレートを継承する
例
{% extends 'base.html' %}
{% block title %}サンプル ブログ - ホーム{% endblock %}
{% block content %}
<h2>最新記事</h2>
<p>記事リストは後の章で紹介します。</p>
{% endblock %}
{% extends 'base.html' %}extends は子テンプレートの最初の行(コメントを除く)に書く必要があります。これは Jinja2 の必須要件です。テンプレートエンジンが継承関係を最初に確定する必要があるからです。
url_for() でリンクを生成する
URL をハードコードせず、url_for()関数名からアドレスを逆引きします。
例
@app.route("/")
def index(): ...
@app.route("/post/<int:post_id>")
def post_detail(post_id): ...
例
ルートが変わった場合(たとえば/post/に変更する/article/)、テンプレート内のurl_for()が新しいアドレスを自動生成します。
静的ファイルの設定
Flask はデフォルトでstatic/ディレクトリを静的ファイルのルートディレクトリとします。
blog_project/ ├── static/ │ ├── css/ │ │ └── style.css │ ├── js/ │ │ └── main.js │ └── images/ │ └── logo.png ├── templates/ └── app.py
テンプレート内ではurl_for('static', filename='css/style.css')を使って参照します。
本章のまとめ
この章では、Jinja2 テンプレートの核心を習得しました。render_template() によるテンプレートのレンダリング、{{ }} による変数の出力、{% for/if %} による制御フロー、base.html + block + extends によるテンプレート継承、url_for() によるリンク生成です。
これでブログページは構造が明確な HTML になり、共通部分は base.html に抽出されました。
その他の拡張