テンプレートで動的にURLを生成する方法 - {% url %} タグと reverse_lazy() 関数徹底解説

使い方

urls.reverse() 関数は、以下の引数を取ります。

current_app
現在のアプリケーション (オプション)
kwargs
ビュー関数に渡されるキーワード引数の辞書 (オプション)
args
ビュー関数に渡される引数のリスト (オプション)
urlconf
URLパターン定義モジュール (デフォルト: 現在使用されているモジュール)
viewname
ビュー関数名 (必須)

例:

from django.urls import reverse

url = reverse('my_view_name', args=[1, 2], kwargs={'param1': 'value1', 'param2': 'value2'})
print(url)  # 出力: /my-url/1/2/?param1=value1&param2=value2

注意点

urls.reverse() は、現在のアプリケーションコンテキストに基づいてURLを生成します。アプリケーションコンテキストが異なる場合、生成されるURLが正しくならない可能性があります。
urls.reverse() は、URLパターンの名前がグローバルに一意であることを前提としています。同じ名前のURLパターンが複数のモジュールに存在すると、誤ったURLが生成される可能性があります。
urls.reverse() は、URLパターンが正しく定義されていることを前提としています。URLパターンに誤りがあると、エラーが発生する可能性があります。

モデルインスタンスのURLを生成する
JavaScriptコードでAjaxリクエストのURLを生成する
テンプレートでリンクを生成する

Django 2.0以降では、reverse_lazy() 関数も使用できます。この関数は、URLが実際に生成されるまで遅延評価されるため、テンプレート内でURLを生成する場合に便利です。
urls.reverse() 関数は、Django 1.10以降で使用できます。

Djangoには、URLを生成する他にも様々な機能があります。詳細は、Djangoドキュメントを参照してください。

<h1>{{ article.title }}</h1>

<p>{{ article.body }}</p>

<a href="{% url 'blog:article_detail' article.id %}">Read more</a>

# urls.py

from django.urls import path
from . import views

urlpatterns = [
    path('article/<int:pk>/', views.article_detail, name='blog:article_detail'),
]

例2: JavaScriptコードでAjaxリクエストのURLを生成する

この例では、JavaScriptコードでAjaxリクエストのURLを生成する方法を示します。

function loadArticle(articleId) {
  $.ajax({
    url: {% url 'blog:article_detail' articleId %},
    success: function(data) {
      $('#article-container').html(data);
    },
  });
}

# urls.py

from django.urls import path
from . import views

urlpatterns = [
    path('article/<int:pk>/', views.article_detail, name='blog:article_detail'),
]

例3: モデルインスタンスのURLを生成する

この例では、モデルインスタンスのURLを生成する方法を示します。

from django.urls import reverse

article = Article.objects.get(pk=1)
url = reverse('blog:article_detail', args=[article.id])
print(url)  # 出力: /article/1/

# urls.py

from django.urls import path
from . import views

urlpatterns = [
    path('article/<int:pk>/', views.article_detail, name='blog:article_detail'),
]

{% url %} テンプレートタグ

テンプレート内でURLを生成するには、{% url %} テンプレートタグを使用できます。このタグは、URLパターン名とオプションの引数を使用して、URLを生成します。

例：

<a href="{% url 'blog:article_detail' article.id %}">Read more</a>

get_absolute_url() メソッド

モデルインスタンスのURLを生成するには、そのインスタンスの get_absolute_url() メソッドを使用できます。このメソッドは、モデルインスタンスのプライマリキーに基づいてURLを生成します。

article = Article.objects.get(pk=1)
url = article.get_absolute_url()
print(url)  # 出力: /article/1/

reverse_lazy() 関数

reverse_lazy() 関数は、Django 2.0以降で使用できる urls.reverse() 関数の代替手段です。この関数は、URLが実際に生成されるまで遅延評価されるため、テンプレート内でURLを生成する場合に便利です。

from django.urls import reverse_lazy

def my_view(request):
    url = reverse_lazy('blog:article_detail', args=[1, 2])
    # ...

手動でURLを生成する

単純なURLの場合は、手動で生成することもできます。

from django.conf import settings

url = f"{settings.ROOT_URLCONF}article/1/"
print(url)  # 出力: /article/1/

どの方法を使用するべきか？

使用する方法は、状況によって異なります。

URLパターンの名前がわからない場合は、 手動でURLを生成する必要があります。
モデルインスタンスのURLを生成する場合は、 get_absolute_url() メソッドを使用するのが最も適切です。
テンプレート内でURLを生成する場合は、 {% url %} テンプレートタグまたは reverse_lazy() 関数を使用するのが一般的です。

Djangoには、URLを生成する他にも様々な機能があります。詳細は、Djangoドキュメントを参照してください。