Djangoの汎用ビュー入門（CreateView、UpdateView）

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

CreateView

CreateViewは新たにレコードを追加するフォームを提供するビューです。

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

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

DetailViewについては、以下の説明を参考にして下さい。

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

DetailViewについては、以下の説明を参考にして下さい。

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

具体例

前回の続きです。ListViewを利用し、Postモデルの一覧を以下のように表示します。「新規作成」をクリックすると、記事の新規投稿ページに進みます。

Postモデル（記事）の新規投稿ページです。ここでCreateViewを使用します。

新規作成が成功すると、Postモデルの一覧ページに戻ります。

前提

①以下のような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 mb-3" >
      <a href="{% url 'users:post_create' %}" class="btn btn-primary">新規作成</a>
    </div><!-- end col-md-6 offset-md-3 -->
  </div><!-- end row -->
  <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 %}

CreateView使い方

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

from django import forms
from users.models import Post

class PostForm(forms.ModelForm):
  
    class Meta:
        model = Post
        fields = ['title', 'text', 'category']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['title'].widget.attrs['class'] = 'form-control'
        self.fields['title'].widget.attrs['placeholder'] = 'タイトル'
        self.fields['title'].widget.attrs['maxlength'] = '50'
        self.fields['text'].widget.attrs['class'] = 'form-control'
        self.fields['text'].widget.attrs['placeholder'] = '本文'
        self.fields['text'].widget.attrs['maxlength'] = '200'
        self.fields['category'].widget.attrs['class'] = 'form-control'
        self.fields['category'].widget.attrs['size'] = '5'

テンプレートに表示するフォーム（PostForm）を定義します。

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

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

class PostCreateView(generic.CreateView):
    model = Post
    form_class = PostForm
    template_name = "post_create_form.html"
    success_url = reverse_lazy('users:post')

    def form_valid(self, form):
        result = super().form_valid(form)
        messages.success(
            self.request, '「{}」を作成しました'.format(form.instance))
        return result

「model = Post」は記事のモデルです。

from foo.views import SampleTemplateView

urlpatterns = [
    url(r'^post$', PostView.as_view()),
    url(r'^post_create/$', views.PostCreateView.as_view(), name='post_create'),
]

「/post」にアクセスする際にPostViewが処理を行います。「/post_create」は、アクセスする際にPostCreateView.as_view()が処理を行います。

{% extends "base.html" %}
{% block content %}
<div class="container-fluid" style="margin-top: 0px;">
  <div class="row">
    <div class="col-md-6 offset-md-3" >
    　　<form method="post">
    　　{% csrf_token %}
      　　<div class="row">
        　　<div class="form-group col-md-11">
            <label for="id_title">タイトル</label>
            {{ form.title }}
          </div>
        　　<div class="form-group col-md-11">
            <label for="id_text">本文</label>
            {{ form.text }}
          </div>
        　　<div class="form-group col-md-11">
            <label for="id_category">カテゴリ</label>
            {{ form.category }}
          </div>
        　　<div class="form-group col-md-11">
          　　<button type="submit" class="btn btn-block btn-outline-primary">save</button>
          </div>
        </div>
    　　</form>
    </div><!-- end col-md-6 offset-md-3 -->
  </div><!-- end row -->
</div><!-- end container-fluid -->
{% endblock %}

テンプレートでは、上記のように記述します。PostCreateView（CreateView）のフォームを表示します。

CreateViewの基礎

from django.views.generic.edit import CreateView

class MyCreateView(CreateView):
    model = MyModel
    fields = ("name", )  # リストもしくはタプル

基本は、上記このように定義します。CreateViewやUpdateViewにはfieldsという変数を定義する必要があります。これは、フォームからデータが入力されても、fieldsに定義したフィールド以外は無視するというものです。

全fields指定

from django.views.generic.edit import CreateView

class MyCreateView(CreateView):
    model = MyModel
    fields = "__all__"

「fields = “__all__”」とすると全部受け入れます。フィールドが多いモデルだとすごく便利ですが、自動で値が決まるフィールドもありますので、これは使わないようにしましょう。

CreateViewのテンプレート

<form method="post">
    {% csrf_token %}
    <table>
        {{ form }}
    </table>
    <input type="submit">
</form>

CreateViewやUpdateViewが他の汎用ビューと異なる点は、「フォームを作成」するということです。そのため、objectやobject_listではなくformという変数を生成します。form変数にはフォームを作成するためのデータが格納されているため、フォームを簡単に作成できます。

ModelForm

from django import forms
from myapp.model import MyModel

class MyModelForm(forms.ModelForm):
    class Meta:
        model = MyModel
        fields = ("name", )

フォームを定義します。

from forms import MyModelForm

class MyCreateView(CreateView):
    form_class = MyModelForm

Views側で、ModelFormなどのフォームオブジェクトを利用することもできます。このようにして、簡単に既存のフォームクラスを利用することができます。

バリデーション

せっかくフォームを送信しても、バリデーションでエラーになりなることがあります。追加・更新されない場合、ユーザーに通知する必要があります。

from django.views.generic.edit import CreateView
from django.contrib import messages  # メッセージフレームワーク

from myapp.models import MyModel


class MyCreateView(CreateView):
    model = MyModel

    def form_valid(self, form):
        ''' バリデーションを通った時 '''
        messages.success(self.request, "保存しました")
        return super().form_valid(form)

    def form_invalid(self, form):
        ''' バリデーションに失敗した時 '''
        message.warning(self.request, "保存できませんでした")
        return super().form_invalid(form)

上記の例では、バリデーションに成功した時はform_validメソッドが呼ばれ、バリデーションに失敗した時にはform_invalidを呼びます。これらのメソッドを使えば、独自の処理を追加できます。独自の処理を終えたら、継承元のメソッドを呼び出して、戻り値を返します。

汎用ビューにはform_validとform_invalidというメソッドが定義されています。バリデーションが通ったか否かで自身が必要な処理を実行できます。例えば、送信したフォームが上手く保存されたかどうかをユーザーに通知することは良くあります。

{% if messages %}
<ul class="messages">
    {% for message in messages %}
    <li{% if message.tags %} class="{{ message.tags }}"{% endif %}>{{ message }}</li>
    {% endfor %}
</ul>
{% endif %}

メッセージを表示するには上記のようにします。