---
title: "クラスベースのビューでフォームを扱う"
version: 6.1
locale: ja
source: https://docs.djangoproject.com/ja/6.1/topics/class-based-views/generic-editing/
canonical: https://djangodocs.dev/ja/6.1/topics/class-based-views/generic-editing/
---
# クラスベースのビューでフォームを扱う

フォームの処理には、一般に3つの場合分けが存在します。

- 最初の GET リクエスト (空白またはデフォルト値が埋め込まれたフォームを返す)
- 無効なデータの POST リクエスト (よくあるパターンは、エラー表示を追加したフォームを再表示する)
- 有効なデータの POST リクエスト (データを処理し、普通はリダイレクトを行う)

これらの処理を自分で実装しようとすると、多くの場合、多数の繰り返しの定型コードを書くことになってしまいます ([ビューでフォームを使う](/ja/6.1/topics/forms/#using-a-form-in-a-view) を参照)。これを避けるために、Django はフォームを処理するための一般的なクラスビューを用意しています。

## 基本的なフォーム

以下のようなコンタクトフォームがあったとします。

*`forms.py`*

```python
from django import forms

class ContactForm(forms.Form):
    name = forms.CharField()
    message = forms.CharField(widget=forms.Textarea)

    def send_email(self):
        # send email using the self.cleaned_data dictionary
        pass
```

このとき、ビューは `FormView` を使うことで構築できます。

*`views.py`*

```python
from myapp.forms import ContactForm
from django.views.generic.edit import FormView

class ContactFormView(FormView):
    template_name = "contact.html"
    form_class = ContactForm
    success_url = "/thanks/"

    def form_valid(self, form):
        # This method is called when valid form data has been POSTed.
        # It should return an HttpResponse.
        form.send_email()
        return super().form_valid(form)
```

メモ:

- FormView は [`TemplateResponseMixin`](/ja/6.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin) を継承するため、ここでは [`template_name`](/ja/6.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin.template_name) を使うことができます。
- [`form_valid()`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.FormMixin.form_valid) デフォルトの実装は、ただ単に [`success_url`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.FormMixin.success_url) にリダイレクトするというものです。

## モデルフォーム

Generic views really shine when working with models. These generic
views will automatically create a [`ModelForm`](/ja/6.1/topics/forms/modelforms/#django.forms.ModelForm), so long as
they can work out which model class to use:

- [`model`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.ModelFormMixin.model) 属性が与えられた場合には、そのモデルクラスが使用されます。
- If [`get_object()`](/ja/6.1/ref/class-based-views/mixins-single-object/#django.views.generic.detail.SingleObjectMixin.get_object)
  returns an object, the class of that object will be used.
- [`queryset`](/ja/6.1/ref/class-based-views/mixins-single-object/#django.views.generic.detail.SingleObjectMixin.queryset) が与えられた場合には、そのクエリセットに対するモデルが使用されます。

Model form views provide a
[`form_valid()`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.ModelFormMixin.form_valid) implementation
that saves the model automatically. You can override this if you have any
special requirements; see below for examples.

You don't even need to provide a `success_url` for
[`CreateView`](/ja/6.1/ref/class-based-views/generic-editing/#django.views.generic.edit.CreateView) or
[`UpdateView`](/ja/6.1/ref/class-based-views/generic-editing/#django.views.generic.edit.UpdateView) \- they will use
[`get_absolute_url()`](/ja/6.1/ref/models/instances/#django.db.models.Model.get_absolute_url) on the model object if
available.

カスタムの [`ModelForm`](/ja/6.1/topics/forms/modelforms/#django.forms.ModelForm) を使いたい場合 (インスタンスでバリデーションを追加したい場合)、 [`form_class`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.FormMixin.form_class) をビューに指定してください。

> **Note**
>
> カスタムのフォームクラスを指定した場合、[`form_class`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.FormMixin.form_class) が [`ModelForm`](/ja/6.1/topics/forms/modelforms/#django.forms.ModelForm) だったとしても、モデルを指定する必要があります。

First we need to add [`get_absolute_url()`](/ja/6.1/ref/models/instances/#django.db.models.Model.get_absolute_url) to our
`Author` class:

*`models.py`*

```python
from django.db import models
from django.urls import reverse

class Author(models.Model):
    name = models.CharField(max_length=200)

    def get_absolute_url(self):
        return reverse("author-detail", kwargs={"pk": self.pk})
```

そうしたら、[`CreateView`](/ja/6.1/ref/class-based-views/flattened-index/#CreateView) およびその仲間たちを使って実際に動作させることができます。ここでは一般的なクラスベースのビューのみを設定している点が重要です; 自分自身でロジックを書く必要はありません:

*`views.py`*

```python
from django.urls import reverse_lazy
from django.views.generic.edit import CreateView, DeleteView, UpdateView
from myapp.models import Author

class AuthorCreateView(CreateView):
    model = Author
    fields = ["name"]

class AuthorUpdateView(UpdateView):
    model = Author
    fields = ["name"]

class AuthorDeleteView(DeleteView):
    model = Author
    success_url = reverse_lazy("author-list")
```

> **Note**
>
> ファイルがインポートされるときに urls は読み込まれないので、 [`reverse_lazy()`](/ja/6.1/ref/urlresolvers/#django.urls.reverse_lazy) を `reverse()` の代わりに使う必要があります。

`fields` 属性は [`ModelForm`](/ja/6.1/topics/forms/modelforms/#django.forms.ModelForm) の内部 `Meta` クラスの `fields` 属性と同じように動作します。別の方法でフォームクラスを定義しない限り、この属性は必須であり、属性がない場合、ビューは [`ImproperlyConfigured`](/ja/6.1/ref/exceptions/#django.core.exceptions.ImproperlyConfigured) 例外を発生させます。

[`fields`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.ModelFormMixin.fields) 属性と [`form_class`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.FormMixin.form_class) 属性の両方を指定した場合、 [`ImproperlyConfigured`](/ja/6.1/ref/exceptions/#django.core.exceptions.ImproperlyConfigured) 例外が発生します。

最後に、これらの新しいビューをURLconfにフックします:

*`urls.py`*

```python
from django.urls import path
from myapp.views import AuthorCreateView, AuthorDeleteView, AuthorUpdateView

urlpatterns = [
    # ...
    path("author/add/", AuthorCreateView.as_view(), name="author-add"),
    path("author/<int:pk>/", AuthorUpdateView.as_view(), name="author-update"),
    path("author/<int:pk>/delete/", AuthorDeleteView.as_view(), name="author-delete"),
]
```

> **Note**
>
> これらのビューは [`SingleObjectTemplateResponseMixin`](/ja/6.1/ref/class-based-views/mixins-single-object/#django.views.generic.detail.SingleObjectTemplateResponseMixin) を継承しており、 [`template_name_suffix`](/ja/6.1/ref/class-based-views/mixins-single-object/#django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix) を使ってモデルに基づいて [`template_name`](/ja/6.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin.template_name) を構成します。
>
> この例では:
>
> - [`CreateView`](/ja/6.1/ref/class-based-views/flattened-index/#CreateView) と [`UpdateView`](/ja/6.1/ref/class-based-views/flattened-index/#UpdateView) は `myapp/author_form.html` を使用します。
> - [`DeleteView`](/ja/6.1/ref/class-based-views/flattened-index/#DeleteView) は `myapp/author_confirm_delete.html` を使用します。
>
> [`CreateView`](/ja/6.1/ref/class-based-views/flattened-index/#CreateView) と [`UpdateView`](/ja/6.1/ref/class-based-views/flattened-index/#UpdateView) で別々のテンプレートを使いたい場合は、 [`template_name`](/ja/6.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin.template_name) か [`template_name_suffix`](/ja/6.1/ref/class-based-views/mixins-single-object/#django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix) をビュークラスに指定します。

## モデルと `request.user`

[`CreateView`](/ja/6.1/ref/class-based-views/flattened-index/#CreateView) を使ってオブジェクトを作成したユーザを追跡するには、カスタムの [`ModelForm`](/ja/6.1/topics/forms/modelforms/#django.forms.ModelForm) を使います。まず、モデルに外部キー関係を追加します：

*`models.py`*

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

class Author(models.Model):
    name = models.CharField(max_length=200)
    created_by = models.ForeignKey(User, on_delete=models.CASCADE)

    # ...
```

In the view, ensure that you don't include `created_by` in the list of fields
to edit, and override
[`form_valid()`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.ModelFormMixin.form_valid) to add the user:

*`views.py`*

```python
from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic.edit import CreateView
from myapp.models import Author

class AuthorCreateView(LoginRequiredMixin, CreateView):
    model = Author
    fields = ["name"]

    def form_valid(self, form):
        form.instance.created_by = self.request.user
        return super().form_valid(form)
```

[`LoginRequiredMixin`](/ja/6.1/topics/auth/default/#django.contrib.auth.mixins.LoginRequiredMixin) prevents users who
aren't logged in from accessing the form. If you omit that, you'll need to
handle unauthorized users in [`form_valid()`](/ja/6.1/ref/class-based-views/mixins-editing/#django.views.generic.edit.ModelFormMixin.form_valid).

## コンテンツネゴシエーションの例

ここでは、API ベースのワークフローと「通常の」フォーム POST で動作するフォームの実装例を紹介します:

```
from django.http import JsonResponse
from django.views.generic.edit import CreateView
from myapp.models import Author

class JsonableResponseMixin:
    """
    Mixin to add JSON support to a form.
    Must be used with an object-based FormView (e.g. CreateView)
    """

    def form_invalid(self, form):
        response = super().form_invalid(form)
        if self.request.accepts("text/html"):
            return response
        else:
            return JsonResponse(form.errors, status=400)

    def form_valid(self, form):
        # We make sure to call the parent's form_valid() method because
        # it might do some processing (in the case of CreateView, it will
        # call form.save() for example).
        response = super().form_valid(form)
        if self.request.accepts("text/html"):
            return response
        else:
            data = {
                "pk": self.object.pk,
            }
            return JsonResponse(data)

class AuthorCreateView(JsonableResponseMixin, CreateView):
    model = Author
    fields = ["name"]
```

上の例では、クライアントが `text/html` をサポートしている場合、それを優先するという前提になっています。しかし、これは常に正しいとは限りません。たとえば、`.css` ファイルをリクエストする際、多くのブラウザは `Accept: text/css,*/*;q=0.1` というヘッダーを送信し、CSS を優先するが他の形式でも構わないという意図を示します。この場合でも `request.accepts("text/html")` は `True` を返します。

クライアントの優先度を考慮して正しいフォーマットを判断するには、 [`django.http.HttpRequest.get_preferred_type()`](/ja/6.1/ref/request-response/#django.http.HttpRequest.get_preferred_type) を使用してください。

```
class JsonableResponseMixin:
    """
    Mixin to add JSON support to a form.
    Must be used with an object-based FormView (e.g. CreateView).
    """

    accepted_media_types = ["text/html", "application/json"]

    def dispatch(self, request, *args, **kwargs):
        if request.get_preferred_type(self.accepted_media_types) is None:
            # No format in common.
            return HttpResponse(
                status_code=406, headers={"Accept": ",".join(self.accepted_media_types)}
            )

        return super().dispatch(request, *args, **kwargs)

    def form_invalid(self, form):
        response = super().form_invalid(form)
        accepted_type = self.request.get_preferred_type(self.accepted_media_types)
        if accepted_type == "text/html":
            return response
        elif accepted_type == "application/json":
            return JsonResponse(form.errors, status=400)

    def form_valid(self, form):
        # We make sure to call the parent's form_valid() method because
        # it might do some processing (in the case of CreateView, it will
        # call form.save() for example).
        response = super().form_valid(form)
        accepted_type = self.request.get_preferred_type(self.accepted_media_types)
        if accepted_type == "text/html":
            return response
        elif accepted_type == "application/json":
            data = {
                "pk": self.object.pk,
            }
            return JsonResponse(data)
```