GET 和 POST¶

处理表单时，只有 GET 和 POST 两种 HTTP 方法可用。

Django 的登录表单使用 POST 方法返回，浏览器将表单数据捆绑在一起，对其进行编码以进行传输，将其发送到服务器，然后接收回其响应。

GET 相反，它将提交的数据捆绑到一个字符串中，并使用它来构成一个 URL。URL 包含必须发送数据的位置以及数据键和值。如果您在 Django 文档中进行搜索，您会看到这一点，它会生成一个类似 https://docs.djangopy.cn/search/?q=forms&release=1 的 URL。

GET 和 POST 通常用于不同的目的。

任何可能用于更改系统状态的请求（例如，在数据库中进行更改的请求）都应使用 POST。GET 应仅用于不会影响系统状态的请求。

GET 也适用于密码表单，因为密码将出现在 URL 中，因此也会出现在浏览器历史记录和服务器日志中，所有这些都是纯文本。它也不适用于大量数据或二进制数据，例如图像。使用 GET 请求处理管理员表单的 Web 应用程序存在安全风险：攻击者很容易模拟表单请求以访问系统的敏感部分。POST 加上其他保护措施（如 Django 的CSRF 保护）提供了更多访问控制。

另一方面，GET 适用于 Web 搜索表单等内容，因为表示 GET 请求的 URL 可以轻松地添加书签、共享或重新提交。

Django Form 类¶

在这个组件系统的心脏地带是 Django 的 Form 类。与 Django 模型描述对象的逻辑结构、行为及其部件的表示方式非常相似，Form 类描述了一个表单，并确定其工作方式和外观。

与模型类的字段映射到数据库字段的方式类似，表单类的字段映射到 HTML 表单 <input> 元素。（一个ModelForm 通过 Form 将模型类的字段映射到 HTML 表单 <input> 元素；这就是 Django 管理员的基础。）

表单的字段本身就是类；它们在提交表单时管理表单数据并执行验证。DateField 和 FileField 处理非常不同类型的数据，并且必须对它们执行不同的操作。

表单字段在浏览器中向用户显示为 HTML“小部件”——用户界面机制的一部分。每种字段类型都有一个适当的默认Widget 类，但这些可以根据需要进行覆盖。

实例化、处理和渲染表单¶

在 Django 中渲染对象时，我们通常会：

1. 在视图中获取它（例如，从数据库中获取它）

2. 将其传递给模板上下文

3. 使用模板变量将其扩展为 HTML 标记

在模板中渲染表单的工作与渲染任何其他类型的对象几乎相同，但有一些关键区别。

对于不包含任何数据的模型实例，在模板中使用它几乎没有用处。另一方面，渲染未填充的表单很有意义——当我们希望用户填充它时，我们会这样做。

因此，当我们在视图中处理模型实例时，我们通常从数据库中检索它。当我们处理表单时，我们通常在视图中实例化它。

当我们实例化表单时，我们可以选择将其留空或预先填充它，例如：

• 来自已保存模型实例的数据（如编辑管理员表单的情况）

• 我们从其他来源收集的数据

• 从之前的 HTML 表单提交接收到的数据

最后一种情况最有趣，因为它使得用户不仅可以阅读网站，还可以向网站发送信息。

需要完成的工作¶

假设您想在您的网站上创建一个简单的表单，以获取用户的姓名。您需要在模板中添加类似这样的内容：

<form action="/your-name/" method="post">
    <label for="your_name">Your name: </label>
    <input id="your_name" type="text" name="your_name" value="{{ current_name }}">
    <input type="submit" value="OK">
</form>

这告诉浏览器使用POST方法将表单数据返回到URL /your-name/。它将显示一个文本字段，标注为“您的姓名：”，以及一个标注为“确定”的按钮。如果模板上下文包含current_name变量，则将使用该变量预填充your_name字段。

您需要一个视图来呈现包含HTML表单的模板，并且可以根据需要提供current_name字段。

提交表单时，发送到服务器的POST请求将包含表单数据。

现在，您还需要一个与/your-name/URL对应的视图，该视图将查找请求中的相应键值对，然后处理它们。

这是一个非常简单的表单。实际上，表单可能包含数十或数百个字段，其中许多字段可能需要预填充，并且我们可能希望用户在完成操作之前多次执行编辑-提交周期。

我们可能需要在浏览器中进行一些验证，甚至在提交表单之前；我们可能想要使用更复杂的字段，允许用户执行诸如从日历中选择日期等操作。

此时，让Django为我们完成大部分工作要容易得多。

在Django中创建表单¶

from django import forms


class NameForm(forms.Form):
    your_name = forms.CharField(label="Your name", max_length=100)

<label for="your_name">Your name: </label>
<input id="your_name" type="text" name="your_name" maxlength="100" required>

from django.http import HttpResponseRedirect
from django.shortcuts import render

from .forms import NameForm


def get_name(request):
    # if this is a POST request we need to process the form data
    if request.method == "POST":
        # create a form instance and populate it with data from the request:
        form = NameForm(request.POST)
        # check whether it's valid:
        if form.is_valid():
            # process the data in form.cleaned_data as required
            # ...
            # redirect to a new URL:
            return HttpResponseRedirect("/thanks/")

    # if a GET (or any other method) we'll create a blank form
    else:
        form = NameForm()

    return render(request, "name.html", {"form": form})

<form action="/your-name/" method="post">
    {% csrf_token %}
    {{ form }}
    <input type="submit" value="Submit">
</form>

绑定和未绑定表单实例¶

绑定和未绑定表单之间的区别很重要

• 未绑定表单没有任何与其关联的数据。当呈现给用户时，它将为空或包含默认值。

• 绑定表单具有提交的数据，因此可用于判断该数据是否有效。如果呈现无效的绑定表单，它可以包含内联错误消息，告知用户需要更正哪些数据。

表单的is_bound属性将告诉您表单是否绑定了数据。

关于字段的更多信息¶

考虑一个比我们上面最小的示例更有用的表单，我们可以使用它来实现个人网站上的“联系我”功能：

from django import forms


class ContactForm(forms.Form):
    subject = forms.CharField(max_length=100)
    message = forms.CharField(widget=forms.Textarea)
    sender = forms.EmailField()
    cc_myself = forms.BooleanField(required=False)

我们之前的表单使用了一个单一字段，your_name，一个CharField。在本例中，我们的表单有四个字段：subject、message、sender和cc_myself。CharField、EmailField和BooleanField只是三种可用的字段类型；完整的列表可以在表单字段中找到。

from django.core.mail import send_mail

if form.is_valid():
    subject = form.cleaned_data["subject"]
    message = form.cleaned_data["message"]
    sender = form.cleaned_data["sender"]
    cc_myself = form.cleaned_data["cc_myself"]

    recipients = ["info@example.com"]
    if cc_myself:
        recipients.append(sender)

    send_mail(subject, message, sender, recipients)
    return HttpResponseRedirect("/thanks/")

可重用表单模板¶

呈现表单时的HTML输出本身是通过模板生成的。您可以通过创建合适的模板文件并设置自定义FORM_RENDERER来使用该form_template_name在站点范围内。您还可以通过覆盖表单的template_name属性使用自定义模板呈现表单，或者通过将模板名称直接传递给Form.render()来自定义每个表单。

下面的示例将导致{{ form }}被渲染为form_snippet.html模板的输出。

在您的模板中

# In your template:
{{ form }}

# In form_snippet.html:
{% for field in form %}
    <div class="fieldWrapper">
        {{ field.errors }}
        {{ field.label_tag }} {{ field }}
    </div>
{% endfor %}

然后，您可以配置FORM_RENDERER设置

from django.forms.renderers import TemplatesSetting


class CustomFormRenderer(TemplatesSetting):
    form_template_name = "form_snippet.html"


FORM_RENDERER = "project.settings.CustomFormRenderer"

……或单个表单

class MyForm(forms.Form):
    template_name = "form_snippet.html"
    ...

……或单个表单实例的渲染，将模板名称传递给Form.render()。这是一个在视图中使用的示例

def index(request):
    form = MyForm()
    rendered_form = form.render("form_snippet.html")
    context = {"form": rendered_form}
    return render(request, "index.html", context)

有关更多详细信息，请参阅将表单输出为HTML。

可重用字段组模板¶

每个字段都可以作为表单的属性使用，在模板中使用{{ form.name_of_field }}。字段具有一个as_field_group()方法，该方法将字段的相关元素作为组呈现，包括其标签、小部件、错误和帮助文本。

这允许编写通用的模板来按所需布局排列字段元素。例如

{{ form.non_field_errors }}
<div class="fieldWrapper">
  {{ form.subject.as_field_group }}
</div>
<div class="fieldWrapper">
  {{ form.message.as_field_group }}
</div>
<div class="fieldWrapper">
  {{ form.sender.as_field_group }}
</div>
<div class="fieldWrapper">
  {{ form.cc_myself.as_field_group }}
</div>

默认情况下，Django 使用"django/forms/field.html"模板，该模板设计用于与默认的"django/forms/div.html"表单样式一起使用。

可以通过在项目级别的FORM_RENDERER中设置field_template_name来自定义默认模板

from django.forms.renderers import TemplatesSetting


class CustomFormRenderer(TemplatesSetting):
    field_template_name = "field_snippet.html"

……或单个字段

class MyForm(forms.Form):
    subject = forms.CharField(template_name="my_custom_template.html")
    ...

……或通过调用BoundField.render()并提供模板名称，在每次请求的基础上。

def index(request):
    form = ContactForm()
    subject = form["subject"]
    context = {"subject": subject.render("my_custom_template.html")}
    return render(request, "index.html", context)

手动呈现字段¶

还可以对字段渲染进行更细粒度的控制。这可能是在自定义字段模板中，以允许模板编写一次并对每个字段重复使用。但是，它也可以直接从表单上的字段属性访问。例如

{{ form.non_field_errors }}
<div class="fieldWrapper">
    {{ form.subject.errors }}
    <label for="{{ form.subject.id_for_label }}">Email subject:</label>
    {{ form.subject }}
</div>
<div class="fieldWrapper">
    {{ form.message.errors }}
    <label for="{{ form.message.id_for_label }}">Your message:</label>
    {{ form.message }}
</div>
<div class="fieldWrapper">
    {{ form.sender.errors }}
    <label for="{{ form.sender.id_for_label }}">Your email address:</label>
    {{ form.sender }}
</div>
<div class="fieldWrapper">
    {{ form.cc_myself.errors }}
    <label for="{{ form.cc_myself.id_for_label }}">CC yourself?</label>
    {{ form.cc_myself }}
</div>

完整的<label>元素也可以使用label_tag()生成。例如

<div class="fieldWrapper">
    {{ form.subject.errors }}
    {{ form.subject.label_tag }}
    {{ form.subject }}
</div>

<ul class="errorlist">
    <li>Sender is required.</li>
</ul>

{% if form.subject.errors %}
    <ol>
    {% for error in form.subject.errors %}
        <li><strong>{{ error|escape }}</strong></li>
    {% endfor %}
    </ol>
{% endif %}

<ul class="errorlist nonfield">
    <li>Generic validation error</li>
</ul>

循环遍历表单字段¶

如果每个表单字段都使用相同的 HTML，则可以通过使用 {% for %} 循环依次遍历每个字段来减少重复代码。

{% for field in form %}
    <div class="fieldWrapper">
        {{ field.errors }}
        {{ field.label_tag }} {{ field }}
        {% if field.help_text %}
          <p class="help" id="{{ field.auto_id }}_helptext">
            {{ field.help_text|safe }}
          </p>
        {% endif %}
    </div>
{% endfor %}

{{ field }} 的有用属性包括：

{{ field.errors }}

输出一个包含与该字段对应的任何验证错误的 <ul class="errorlist">。你可以使用 {% for error in field.errors %} 循环来自定义错误的显示方式。在这种情况下，循环中的每个对象都是包含错误消息的字符串。

{{ field.field }}

来自表单类的 Field 实例，该 BoundField 包装了它。你可以用它来访问 Field 属性，例如 {{ char_field.field.max_length }}。

{{ field.help_text }}

与字段关联的任何帮助文本。

{{ field.html_name }}

将在输入元素的 name 字段中使用的字段名称。如果已设置，则会考虑表单前缀。

{{ field.id_for_label }}

将用于此字段的 ID（上例中的 id_email）。如果你正在手动构建标签，你可能希望使用它来代替 label_tag。例如，如果你有一些内联 JavaScript 并想要避免硬编码字段的 ID，它也很有用。

{{ field.is_hidden }}

如果表单字段是隐藏字段，则此属性为 True，否则为 False。作为模板变量，它并不是特别有用，但在条件测试中可能很有用，例如：

{% if field.is_hidden %}
   {# Do something special #}
{% endif %}

{{ field.label }}

字段的标签，例如 Email address。

{{ field.label_tag }}

用适当的 HTML <label> 标签包装的字段标签。这包括表单的 label_suffix。例如，默认的 label_suffix 是冒号。

<label for="id_email">Email address:</label>

{{ field.legend_tag }}

类似于 field.label_tag，但使用 <legend> 标签代替 <label>，用于包含在 <fieldset> 中的多个输入的 widget。

{{ field.use_fieldset }}

如果表单字段的 widget 包含多个输入，这些输入应该在语义上分组到一个 <fieldset> 中，并带有 <legend> 以提高可访问性，则此属性为 True。模板中的示例用法：

{% if field.use_fieldset %}
  <fieldset>
  {% if field.label %}{{ field.legend_tag }}{% endif %}
{% else %}
  {% if field.label %}{{ field.label_tag }}{% endif %}
{% endif %}
{{ field }}
{% if field.use_fieldset %}</fieldset>{% endif %}

{{ field.value }}

字段的值，例如 someone@example.com。

{# Include the hidden fields #}
{% for hidden in form.hidden_fields %}
{{ hidden }}
{% endfor %}
{# Include the visible fields #}
{% for field in form.visible_fields %}
    <div class="fieldWrapper">
        {{ field.errors }}
        {{ field.label_tag }} {{ field }}
    </div>
{% endfor %}