Djangoの汎用ビュー入門（DetailView）

Djangoは、汎用ビューを使って簡易的なコーディングでアプリケーションを作成することができます。今回はDetailViewを使用します。

DetailView

DetailViewは汎用ビューの一つで、個別詳細ページを作る時に使用します。ListViewでテーブルからデータ一覧を取得し、DetailViewで個別詳細ページを表示するのが一般的です。

汎用ビューについては、以下の説明を参考にして下さい。

→Djangoの汎用ビュー入門（TemplateView）

具体例

前回の続きです。ListViewを利用し、Postモデルの一覧を以下のように表示します。「続きを読む」をクリックすると、個別詳細ページに進みます。

Postモデルの個別詳細ページです。ここでDetailViewを使用します。

前提

①以下のようなDjangoアプリ構成を作ります。プロジェクト名が「pj1」で、アプリケーション名が「users」です。プロジェクトの設定は済ませたものとします。赤字のファイルは、今回変更する部分です。

②表示するデータとして、models.pyに以下のモデルを定義します。

from django.contrib.auth.models import User
from django.db import models

class Category(models.Model):
    """カテゴリー"""
 
    name = models.CharField(max_length=255)
 
    def __str__(self):
        return self.name
 
 
class Post(models.Model):
    """ブログのポスト"""
 
    title = models.CharField(max_length=255)
    text = models.TextField()
    category = models.ManyToManyField(Category)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
 
    def __str__(self):
        return self.title

③Postモデル一覧を表示するhtmlテンプレートを用意します。

{% extends "base.html" %}
{% block content %}
<div class="container-fluid" style="margin-top: 60px;">
  <div class="row">
    <div class="col-md-6 offset-md-3" >
      <div class="card">
        <div class="card-header">記事一覧</div>
	  {% for post in post_list %}
          <div class="card-body p-3">
            <p class="card-text">
	      タイトル:{{ post.title }} 
	      日付:{{ post.created_at }}
	    </p>
            <a href="{% url 'users:detail' post.pk %}" class="card-link">続きを読む</a>
         </div><!-- end card-body -->
	 {% endfor %}
      </div><!-- end card -->
    </div><!-- end col-md-6 offset-md-3 -->
  </div><!-- end row -->
</div><!-- end container-fluid -->
{% endblock %}

④個別詳細ページを表示するテンプレートです。

{% extends "base.html" %}
{% block content %}
<div class="container-fluid" style="margin-top: 60px;">
  <div class="row">
    <div class="col-md-6 offset-md-3" >

	<div class="alert alert-success" role="alert">
	  <h4 class="alert-heading">{{ post.title }}</h4>
	  <p>{{ post.text | linebreaksbr}}</p>
	  <p class="text-muted">作成日:{{ post.created_at 	}}</p>
	  <p class="text-muted">更新日:{{ post.updated_at }}</p>
	  <p>{% for category in post.category.all %}{{ category }},{% endfor %}</p>
	  <a class="btn btn-primary" href="javascript:void(0);" onclick="window.history.back();">戻る</a>
	</div>

    </div><!-- end col-md-6 offset-md-3 -->
  </div><!-- end row -->
</div><!-- end container-fluid -->
{% endblock %}

DetailView使い方

汎用ビューは主にviews.pyで使用されます。また、そのViewをurls.pyでas_view()という関数でURLを紐つけます。Djangoプロジェクト内に「user」というアプリケーションを作成したとします。

from django.views.generic import ListView
from foo.model import Post, Category

class PostView(generic.ListView):
    model = Post
    template_name = 'post_list.html'

class PostDetailView(generic.DetailView):
    model = Post
    template_name = 'post_detail.html'

「model = Post」はリストを作成するモデルです。

from foo.views import SampleTemplateView

urlpatterns = [
    url(r'^sample$', PostView.as_view()),
    url(r'^detail/(?P<pk>[0-9]+)/$', views.PostDetailView.as_view(), name='detail'),
]

「/detail」にアクセス際にPostDetailViewが処理を行います。

	<div class="alert alert-success" role="alert">
	  <h4 class="alert-heading">{{ post.title }}</h4>
	  <p>{{ post.text | linebreaksbr}}</p>
	  <p class="text-muted">作成日:{{ post.created_at 	}}</p>
	  <p class="text-muted">更新日:{{ post.updated_at }}</p>
	  <p>{% for category in post.category.all %}{{ category }},{% endfor %}</p>
	  <a class="btn btn-primary" href="javascript:void(0);" onclick="window.history.back();">戻る</a>
	</div>

テンプレートでは、上記のように記述します。

モデル指定方法

class PostDetailView(generic.DetailView):
    model = Post
    template_name = 'post_detail.html'

上記のようにモデル（テーブル）を指定します。「model = Post」とすることで、今回の例だと「Post.objects.all()」を裏側で行ってくれます。ListViewと同じです。

class PostDetailView(generic.DetailView):
    queryset = Post.objects.all()
    template_name = 'post_detail.html'

上記のようにquerysetを指定してもOKです。内部では、このquerysetに対して「pk」を使って「.filter(pk=pk)」のようなことを行っています。

class PostDetailView(generic.DetailView):
    model = Post
    pk_url_kwarg = 'id'

以下のようにすると、pkという文字列を変えれます。変更したら、urls.pyにも反映しましょう。

class DetailView(generic.DetailView):
    model = Post
    slug_field = "title"  # モデルのフィールドの名前
    slug_url_kwarg = "title"  # urls.pyでのキーワードの名前

pkを使わず、また数字ではない記事のタイトルをurlに入れたい場合などもあります。そのような場合は上記のようにします。

URL

urlpatterns = [
    ・・・
    url(r'^detail/(?P<pk>[0-9]+)/$', views.PostDetailView.as_view(), name='detail'),
]

「/detail」にアクセス際にPostDetailViewが処理を行います。

urlpatterns = [
    ・・・
    url(r'^detail/(?P<pk>\d+)/$', views.PostDetailView.as_view(), name='detail'),
]

上記のように記述することもできます。「‘\d+’（一桁以上の数字）」をpk（PrimaryKey）としたデータがテンプレートに反映されます。ここでのpkは決まり文句で、slugによって変更できます。

テンプレート指定方法

class PostView(ListView):
    model = Post
    template_name = 'mymodel.html'

上記のようにすると、どのテンプレートを使うか指定できます。

<app name>/<model name>_detail.html

テンプレートにはデフォルト値があります。（今回の例だとusers/post_detail.htmlになります。）

テンプレートへのデータ受け渡し

	<div class="alert alert-success" role="alert">
	  <h4 class="alert-heading">{{ post.title }}</h4>
	  <p>{{ post.text | linebreaksbr}}</p>
	  <p class="text-muted">作成日:{{ post.created_at 	}}</p>
	  <p class="text-muted">更新日:{{ post.updated_at }}</p>
	  <p>{% for category in post.category.all %}{{ category }},{% endfor %}</p>
	  <a class="btn btn-primary" href="javascript:void(0);" onclick="window.history.back();">戻る</a>
	</div>

テンプレートでは、上記のように記述します。「Post」モデルならば、「post」でtemplateへわたります。又は、「object」でもアクセス可能です。