{"title":"クラスベースビュー","version":"3.0","locale":"ja","docname":"topics/class-based-views/index","url":"/ja/3.0/topics/class-based-views/","canonical":"https://djangodocs.dev/ja/3.0/topics/class-based-views/","summary":"A view is a callable which takes a request and returns a response. This can be more than just a function, and Django provides an example of some classes which can…","html":"<h1>クラスベースビュー<a class=\"heading-anchor\" href=\"#class-based-views\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>A view is a callable which takes a request and returns a\nresponse. This can be more than just a function, and Django provides\nan example of some classes which can be used as views. These allow you\nto structure your views and reuse code by harnessing inheritance and\nmixins. There are also some generic views for tasks which we'll get to later,\nbut you may want to design your own structure of reusable views which suits\nyour use case. For full details, see the <a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/\"><span class=\"doc\">class-based views reference\ndocumentation</span></a>.</p>\n<div class=\"toctree-wrapper compound\">\n<ul>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"/ja/3.0/topics/class-based-views/intro/\">クラスベースビュー入門</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"/ja/3.0/topics/class-based-views/generic-display/\">ビルトインのクラスベースのジェネリックビュー</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"/ja/3.0/topics/class-based-views/generic-editing/\">クラスベースのビューでフォームを扱う</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"/ja/3.0/topics/class-based-views/mixins/\">クラスベースのビューでミックスインを使用する</a></li>\n</ul>\n</div>\n<section id=\"basic-examples\">\n<h2>基本的な例<a class=\"heading-anchor\" href=\"#basic-examples\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Django provides base view classes which will suit a wide range of applications.\nAll views inherit from the <a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.View\" title=\"django.views.generic.base.View\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">View</span></code></a> class, which\nhandles linking the view into the URLs, HTTP method dispatching and other\ncommon features. <a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.RedirectView\" title=\"django.views.generic.base.RedirectView\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">RedirectView</span></code></a> provides a\nHTTP redirect, and <a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.TemplateView\" title=\"django.views.generic.base.TemplateView\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">TemplateView</span></code></a> extends the\nbase class to make it also render a template.</p>\n</section>\n<section id=\"usage-in-your-urlconf\">\n<h2>Usage in your URLconf<a class=\"heading-anchor\" href=\"#usage-in-your-urlconf\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>The most direct way to use generic views is to create them directly in your\nURLconf. If you're only changing a few attributes on a class-based view, you\ncan pass them into the <a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.View.as_view\" title=\"django.views.generic.base.View.as_view\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">as_view()</span></code></a> method\ncall itself:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.urls</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">path</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.views.generic</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">TemplateView</span>\n\n<span class=\"n\">urlpatterns</span> <span class=\"o\">=</span> <span class=\"p\">[</span>\n    <span class=\"n\">path</span><span class=\"p\">(</span><span class=\"s1\">&#39;about/&#39;</span><span class=\"p\">,</span> <span class=\"n\">TemplateView</span><span class=\"o\">.</span><span class=\"n\">as_view</span><span class=\"p\">(</span><span class=\"n\">template_name</span><span class=\"o\">=</span><span class=\"s2\">&quot;about.html&quot;</span><span class=\"p\">)),</span>\n<span class=\"p\">]</span>\n</code></pre></div>\n<p><a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.View.as_view\" title=\"django.views.generic.base.View.as_view\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">as_view()</span></code></a> に渡されたすべての引数は、クラスで設定された属性を上書きします。次の例では <code class=\"docutils literal notranslate\"><span class=\"pre\">TemplateView</span></code> の <code class=\"docutils literal notranslate\"><span class=\"pre\">template_name</span></code> を設定しています。同様の上書きのパターンは、<a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.RedirectView\" title=\"django.views.generic.base.RedirectView\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">RedirectView</span></code></a> の <code class=\"docutils literal notranslate\"><span class=\"pre\">url</span></code> 属性でも使えます。</p>\n</section>\n<section id=\"subclassing-generic-views\">\n<h2>ジェネリックビューのサブクラス化<a class=\"heading-anchor\" href=\"#subclassing-generic-views\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>The second, more powerful way to use generic views is to inherit from an\nexisting view and override attributes (such as the <code class=\"docutils literal notranslate\"><span class=\"pre\">template_name</span></code>) or\nmethods (such as <code class=\"docutils literal notranslate\"><span class=\"pre\">get_context_data</span></code>) in your subclass to provide new values\nor methods. Consider, for example, a view that just displays one template,\n<code class=\"docutils literal notranslate\"><span class=\"pre\">about.html</span></code>. Django has a generic view to do this -\n<a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.TemplateView\" title=\"django.views.generic.base.TemplateView\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">TemplateView</span></code></a> - so we can subclass it, and\noverride the template name:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"c1\"># some_app/views.py</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.views.generic</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">TemplateView</span>\n\n<span class=\"k\">class</span><span class=\"w\"> </span><span class=\"nc\">AboutView</span><span class=\"p\">(</span><span class=\"n\">TemplateView</span><span class=\"p\">):</span>\n    <span class=\"n\">template_name</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;about.html&quot;</span>\n</code></pre></div>\n<p>Then we need to add this new view into our URLconf.\n<a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.TemplateView\" title=\"django.views.generic.base.TemplateView\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">TemplateView</span></code></a> is a class, not a function, so\nwe point the URL to the <a class=\"reference internal\" href=\"/ja/3.0/ref/class-based-views/base/#django.views.generic.base.View.as_view\" title=\"django.views.generic.base.View.as_view\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">as_view()</span></code></a> class\nmethod instead, which provides a function-like entry to class-based views:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"c1\"># urls.py</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.urls</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">path</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">some_app.views</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">AboutView</span>\n\n<span class=\"n\">urlpatterns</span> <span class=\"o\">=</span> <span class=\"p\">[</span>\n    <span class=\"n\">path</span><span class=\"p\">(</span><span class=\"s1\">&#39;about/&#39;</span><span class=\"p\">,</span> <span class=\"n\">AboutView</span><span class=\"o\">.</span><span class=\"n\">as_view</span><span class=\"p\">()),</span>\n<span class=\"p\">]</span>\n</code></pre></div>\n<p>組み込みのジェネリックビューの使用方法の詳細については、次のトピック <a class=\"reference internal\" href=\"/ja/3.0/topics/class-based-views/generic-display/\"><span class=\"doc\">generic class-based views</span></a> を参照してください。</p>\n<section id=\"supporting-other-http-methods\">\n<span id=\"id1\"></span><h3>その他の HTTP メソッドをサポートする<a class=\"heading-anchor\" href=\"#supporting-other-http-methods\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>誰かが私たちの図書館に HTTP 経由でアクセスして、ビューを API として使用したいという状況を考えてください。API クライアントはたびたびコネクションを張り、最終訪問日時以降に出版された本のデータをダウンロードするとします。しかし、新しい本の情報が存在しない場合には、データベースから本のデータを取得し、レスポンステキストをレンダリングし、クライアントに送信し返すための CPU タイムとバンド幅は無駄になってしまいます。最新の本が出版された時点で API に問い合わせた方が好ましいかもしれません。</p>\n<p>そのために、URLconf 内で、本のリストビューへの URL を次のようにマッピングします。</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.urls</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">path</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">books.views</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">BookListView</span>\n\n<span class=\"n\">urlpatterns</span> <span class=\"o\">=</span> <span class=\"p\">[</span>\n    <span class=\"n\">path</span><span class=\"p\">(</span><span class=\"s1\">&#39;books/&#39;</span><span class=\"p\">,</span> <span class=\"n\">BookListView</span><span class=\"o\">.</span><span class=\"n\">as_view</span><span class=\"p\">()),</span>\n<span class=\"p\">]</span>\n</code></pre></div>\n<p>そして、ビューには次のように書きます。</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.http</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">HttpResponse</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">django.views.generic</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">ListView</span>\n<span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">books.models</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">Book</span>\n\n<span class=\"k\">class</span><span class=\"w\"> </span><span class=\"nc\">BookListView</span><span class=\"p\">(</span><span class=\"n\">ListView</span><span class=\"p\">):</span>\n    <span class=\"n\">model</span> <span class=\"o\">=</span> <span class=\"n\">Book</span>\n\n    <span class=\"k\">def</span><span class=\"w\"> </span><span class=\"nf\">head</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"p\">,</span> <span class=\"o\">*</span><span class=\"n\">args</span><span class=\"p\">,</span> <span class=\"o\">**</span><span class=\"n\">kwargs</span><span class=\"p\">):</span>\n        <span class=\"n\">last_book</span> <span class=\"o\">=</span> <span class=\"bp\">self</span><span class=\"o\">.</span><span class=\"n\">get_queryset</span><span class=\"p\">()</span><span class=\"o\">.</span><span class=\"n\">latest</span><span class=\"p\">(</span><span class=\"s1\">&#39;publication_date&#39;</span><span class=\"p\">)</span>\n        <span class=\"n\">response</span> <span class=\"o\">=</span> <span class=\"n\">HttpResponse</span><span class=\"p\">()</span>\n        <span class=\"c1\"># RFC 1123 date format</span>\n        <span class=\"n\">response</span><span class=\"p\">[</span><span class=\"s1\">&#39;Last-Modified&#39;</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"n\">last_book</span><span class=\"o\">.</span><span class=\"n\">publication_date</span><span class=\"o\">.</span><span class=\"n\">strftime</span><span class=\"p\">(</span><span class=\"s1\">&#39;</span><span class=\"si\">%a</span><span class=\"s1\">, </span><span class=\"si\">%d</span><span class=\"s1\"> %b %Y %H:%M:%S GMT&#39;</span><span class=\"p\">)</span>\n        <span class=\"k\">return</span> <span class=\"n\">response</span>\n</code></pre></div>\n<p>If the view is accessed from a <code class=\"docutils literal notranslate\"><span class=\"pre\">GET</span></code> request, an object list is returned in\nthe response (using the <code class=\"docutils literal notranslate\"><span class=\"pre\">book_list.html</span></code> template). But if the client issues\na <code class=\"docutils literal notranslate\"><span class=\"pre\">HEAD</span></code> request, the response has an empty body and the <code class=\"docutils literal notranslate\"><span class=\"pre\">Last-Modified</span></code>\nheader indicates when the most recent book was published.  Based on this\ninformation, the client may or may not download the full object list.</p>\n</section>\n</section>","rootId":"class-based-views","toc":[{"title":"基本的な例","anchor":"basic-examples","children":[]},{"title":"Usage in your URLconf","anchor":"usage-in-your-urlconf","children":[]},{"title":"ジェネリックビューのサブクラス化","anchor":"subclassing-generic-views","children":[{"title":"その他の HTTP メソッドをサポートする","anchor":"supporting-other-http-methods","children":[]}]}],"breadcrumbs":[{"docname":"topics/index","title":"Django を使う","url":"/ja/3.0/topics/"}],"prev":{"docname":"topics/templates","title":"テンプレート","url":"/ja/3.0/topics/templates/"},"next":{"docname":"topics/class-based-views/intro","title":"クラスベースビュー入門","url":"/ja/3.0/topics/class-based-views/intro/"},"formats":{"html":"/ja/3.0/topics/class-based-views/","markdown":"/ja/3.0/topics/class-based-views.md","json":"/ja/3.0/topics/class-based-views.json"},"source":"https://github.com/django/django/blob/stable/3.0.x/docs/topics/class-based-views/index.txt","official":"https://docs.djangoproject.com/ja/3.0/topics/class-based-views/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","pt-br","ko","es","el","pl"]}