赵走x博客
网站访问量：151470
首页
书籍
软件
工具
古诗词
搜索
登录
17、部署 Django 项目
16、自动化测试
14、jQuery 和 Django
13、Webhose 搜索
12、集成 Bootstrap
11、使用 Django-Registration-Redux
10、cookie 和会话
9、用户身份验证
8、模板进阶
7、表单
6、模型、模板和视图
5、模型与数据库
4、模板和媒体文件
3、Django 基础
2、前期准备工作
1、导言
7、表单
资源编号:76310
Tango with Django
Python Web
热度：81
本章说明如何通过 Web 表单捕获数据。
本章说明如何通过 Web 表单捕获数据。Django 提供的表单处理功能简单明了，根据 Django 文 档，通过这个功能可以做到： ➊ 自动生成 HTML 表单的小组件（例如文本字段或日期选择器）； ➋ 检查提交的数据是否满足验证规则； ➌ 遇到验证错误时重新显示表单； ➍ 把提交的表单数据转换成相应的 Python 数据类型。 使用 Django 表单功能的一大优势是能节省大量时间，免去自己动手创建 HTML 表单的繁琐过 程。 # 7.1 基本流程 创建表单处理用户输入的基本步骤如下。 ➊ 在 Django 应用的目录中创建 forms.py 文件，存放表单相关的类。 ➋ 为想使用表单处理的模型定义 ModelForm 类。 ➌ 根据需要定制表单。 ➍ 创建或更新视图，处理表单： * 显示表单 * 保存表单数据 * 用户输入错误的数据时（或者根本没输入数据时）报错 ➎ 创建或更新模板，显示表单。 ➏ 添加 URL 模式，映射到视图上（如果视图是新的）。 这个流程比以往复杂一些，而且相应的视图要复杂得多。不过，多做几次便能掌握。 # 7.2 网页和分类表单 本节实现的功能是为了让用户通过表单向数据库中添加分类和网页。 首先，在 Rango 应用的目录中新建一个文件，命名为 forms.py。这一步不是必须的（可以放在 models.py 文件中），但是把表单相关的代码放在单独的文件中有利于保持代码基整洁。 ### 定义 ModelForm 的子类 在 forms.py 模块中，我们将定义几个继承自 ModelForm 的类。ModelForm 是 Django 提供的辅助 类，简化了为模型创建表单的过程。Rango 应用现在有两个模型（Category 和 Page），我们将分 别为二者定义 ModelForm 的子类。 在 rango/forms.py 文件中添加下述代码。 ``` from django import forms from rango.models import Page, Category class CategoryForm(forms.ModelForm): name = forms.CharField(max_length=128, help_text='Please enter the category name.') views = forms.IntegerField(widget=forms.HiddenInput, initial=0) likes = forms.IntegerField(widget=forms.HiddenInput, initial=0) slug = forms.CharField(widget=forms.HiddenInput, required=False) # 嵌套的类，为表单提供额外信息 class Meta: # 把这个 ModelForm 与一个模型连接起来 model = Category fields = ('name',) class PageForm(forms.ModelForm): title = forms.CharField(max_length=128, help_text='Please enter the title of page.') url = forms.URLField(max_length=200, help_text='Please enter the URL of the page') views = forms.IntegerField(widget=forms.HiddenInput(), initial=0) class Meta: # 把这个 ModelForm 与一个模型连接起来 model = Page # 想在表单中放哪些字段？ # 有时不需要全部字段 # 有些字段接受空值，因此可能无需显示 # 这里我们想隐藏外键字段 # 为此，可以排除 category 字段 exclude = ('category',) # 也可以直接指定想显示的字段（不含 category 字段） fields = ('title', 'url', 'views') ``` 我们要通过 fields 指定表单中包含哪些字段，或者通过 exclude 指定排除哪些字段。 为了定制得到的表单，Django 提供了多种方式。在上述代码中，我们指明了使用什么小组件 （widget）显示各个字段。例如，在 PageForm 类中，title 字段用的是 forms.CharField，url 字 段用的是 forms.URLField。这两种小组件都用于输入文本。注意我们为字段设定的 max_length 参 数，其值与底层数据模型中设定的长度限制一样。具体限制参见第 5 章，或者看一下 Rango 应用 的 models.py 文件。 此外，两个表单中都有 IntegerField，用于呈现查看（访问）次数和点赞次数。注意，我们在参 数中设定了 widget=forms.HiddenInput()，这是为了隐藏小组件。另外，我们还设定了 initial=0，把值设为零。这是把字段的默认值设为零的一种方式。因为字段是隐藏的，用户无法 为其输入值。 然而，如 PageForm 所示，尽管有个字段是隐藏的，但是依然要将其包含在表单的字段中。如果 fields 中没有 views，表单中就没有那个字段（虽然声明了），因此那个字段的初始值也就不会 是零。在某些模型中，这样做可能导致报错。如果在模型中为字段设定了 default=0，那么便可以 交由模型自动使用默认值填充字段，从而避免 not null 错误。此时，表单中无需包含那个字段。 CategoryForm 中包含 slug 字段，但是没有为其指定初始值或默认值，而是隐藏了，并且指明这个 字段不是必须的。这是因为模型在调用 save() 方法保存时会生成这个字段的值。综上，定义模型 和表单时一定要小心，确保提供创建模型实例所需的全部数据。 除了 CharField 和 IntegerField 之外，Django 还提供了很多可用的小组件，例如 EmailField（电 子邮件地址输入框）、ChoiceField（单选按钮）和 DateField（日期/时间输入框）。 对 ModelForm 的子类来说，最重要的一点或许是定义表单对应的模型。这个信息通过嵌套的 Meta 类提供，把 model 属性设为目标模型。例如，CategoryForm 类设定的目标模型是 Category。这一 步十分重要，有了这个信息 Django 才能根据模型创建表单，并在提交表单后显示可能出现的错 误。 我们还通过 Meta 类的 fields 属性（值为一个元组）设定表单中包含哪些字段。 如果想进一步了解不同的小组件，以及定制表单的方法，请阅读 [Django 文档](https://docs.djangoproject.com/en/1.9/ref/forms/ "Django 文档")。 # 编写添加分类视图 定义好 CategoryForm 类之后，接下来要编写一个视图，用于显示表单及处理提交的数据。在 rango/views.py 文件中添加下述代码。 ``` # 在文件顶部添加这个导入语句 from rango.forms import CategoryForm def add_category(request): form = CategoryForm() # 是 HTTP POST 请求吗？ if request.method == 'POST': form = CategoryForm(request.POST) # 表单数据有效吗？ if form.is_valid(): # 把新分类存入数据库 form.save(commit=True) # 保存新分类后可以显示一个确认消息 # 不过既然最受欢迎的分类在首页 # 那就把用户带到首页吧 return index(request) else: # 表单数据有错误 # 直接在终端里打印出来 print(form.errors) # 处理有效数据和无效数据之后 # 渲染表单，并显示可能出现的错误消息 return render(request, 'rango/add_category.html', {'form': form}) ``` add_category() 视图展示了处理表单的关键步骤。首先，创建一个 CategoryForm 实例，然后检查 是不是 HTTP POST 请求，即是不是通过表单提交的数据？相同的 URL 也可以处理 GET 请求。 add_category() 视图能处理不同的情况： ❏ 显示一个空表单，让用户添加分类； ❏ 把用户提交的数据存入相应的模型，然后渲染 Rango 应用首页； ❏ 如有错误，再次显示表单，并把错误消息一并显示出来。 Django 的表单处理机制负责处理通过 HTTP POST 请求提交的数据，一切顺利时，把数据存入相 应的模型，否则生成各字段的出错消息。也就是说，如果提交的表单数据违背了数据库的引用完 整性，Django 会拒绝保存数据。例如，如果不为 category 字段提供值就会出错，因为这个字段不 能为空。 从调用 render() 函数那行可以看出，我们使用的是一个新模板，名为 add_category.html。这个页 面和表单的 HTML 代码及相关的 Django 模板代码都在这个模板中。 ### 创建添加分类页面的模板 新建 templates/rango/add_category.html 文件，写入下述 HTML 标记和 Django 模板代码。 ``` <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Rango</title> </head> <body> <h1>Add a Category</h1> <div> <form id="category_form" method="post" action="/rango/add_category/"> {% csrf_token %} {% for hidden in form.hidden_fields %} {% hidden %} {% endfor %} {% for field in form.visible_fields %} {{ field.errors }} {{ field.help_text }} {{ field }} {% endfor %} <input type="submit" name="submit" value="Create Category"/> </form> </div> </body> </html> ``` 这个 HTML 页面的 <body> 中有个 <form> 元素。通过 <form> 元素的属性可以看出，这个表单捕获 的数据通过 HTTP POST 请求发给 URL /rango/add_category/（method 属性的值不区分大小写，因 此 POST 或 post 都行）。这个表单中有两个循环： ❏ 一个显示表单的隐藏字段 ❏ 一个显示表单的可见字段 可见字段，即会显示出来的字段，由 Meta 类的 fields 属性控制。这两个循环负责生成各表单元 素的 HTML 标记。可见字段中还加上了可能出现的错误，以及辅助文本，提示用户应该输入什么。 >隐藏字段 因为 HTTP 是无状态的协议，所以除了可见字段之外，还要加上隐藏字段。由于两个 HTTP 请求之间无法持久保持状态，因此 Web 应用的某些功能难以实现。为了解决这一难题，人 们发明了隐藏字段，以便通过 HTML 表单发送对客户端来说重要的信息（在渲染的页面中 看不到），在用户提交表单时发给服务器。 请特别注意上述代码片段中的 {% csrf_token %}。这是跨站请求伪造（Cross-Site Request Forgery，CSRF）令牌，用于增强提交表单后发送的 HTTP POST 请求的安全性。Django 框 架要求表单中必须有 CSRF 令牌，否则用户提交表单后可能遇到错误。详情参见 Django 文 档（Django 1.10 的文档）。 ### 映射添加分类视图 接下来要把 add_category() 视图映射到一个 URL 上。在模板中，表单的 action 属性使用的 URL 是 /rango/add_category/。现在要把这个 URL 映射到视图上。打开 rango/urls.py 文件，修改 urlpatterns： urlpatterns = [ url(r'^$', views.index, name='index'), url(r'about/$', views.about, name='about'), url(r'^add_category/$', views.add_category, name='add_category'), url(r'^category/(?P<category_name_slug>[\w\-]+)/$', views.show_category, name='show_category'), ] 这个 URL 模式的位置没什么关系。不过，请阅读 Django 文档，了解 Django 是如何处理请求的。 添加分类页面的 URL 是 /rango/add_category/。 ### 修改首页视图 最后，在首页添加一个链接，方便用户添加分类。打开 rango/index.html 模板，在“关于”页面链接 所在的 <div> 元素中添加下述 HTML 超链接： ``` <a href="/rango/add_category/">Add a New Category</a><br /> ``` ### 检验结果 现在检验一下结果。启动或重启 Django 开发服务器，打开浏览器，访问 http://127.0.0.1:8000/rango/ 。点击新加的那个链接，跳转到添加分类页面，添加一个分类试试。下图是首页和添加分类页 面的截图。  图 7-1：通过表单添加一个分类 >分类不见了？ 你添加的分类可能不会出现在首页，这是因为首页只显示最受欢迎的前 5 个分类。登录进入 管理界面可以看到全部分类。 确认分类成功添加的另一种方法是修改 rango/views.py 文件中的 add_category() 函数，把 form.save(commit=True) 改成 cat = form.save(commit=True)，为通过表单创建的分类对象 提供一个引用，这样便可以在控制台中打印分类，例如 print(cat, cat.slug)。 ### 清理表单数据 你或许还记得，Page 模型有个 url 属性，其类型为 URLField。在对应的 HTML 表单中，Django 期望这个字段中的文本是格式正确的完整 URL。然而，用户可能觉得输入 http://www.url.com 这样 的 URL 很麻烦，甚至根本不知道何为[正确的 URL 格式](https://support.google.com/webmasters/answer/76329?hl=zh-Hans "正确的 URL 格式")。 >URL 检查 多数现代浏览器会检查 URL 的格式是否正确，因此这里所说的情况只针对旧浏览器。虽然 如此，但是其中涉及如何在存入数据库之前清理数据。如果你没有旧浏览器做试验（或者你 不相信），可以把 URLField 更换成 CharField，这样渲染得到的 HTML 便不会指示浏览器做 检查，我们编写的清理代码就能执行。 为了防止用户输入的数据有错，我们可以在 ModelForm 子类中覆盖 clean() 方法。这个方法在数 据存为新模型实例之前调用，因此在这一时刻特别适合确认（甚至修正）用户在表单中输入的数 据。我们可以检查用户在 url 字段中输入的值是否以 http:// 开头，如果不是，在用户输入的值 前面加上 http:// 。 ``` class PageForm(forms.ModelForm): def clean(self): cleaned_data=self.cleaned_data url=cleaned_data.get('url') # 如果 url 字段不为空，而且不以“http://”开头 # 在前面加上“http://” if url and not url.startswith('http://'): url='http://'+url cleaned_data['url']=url return cleaned_data ``` 在 clean() 方法中，基本的处理过程是一样的，你可以轻易套用，按照自己的方式处理表单数 据。 ➊ 表单数据从 cleaned_data 字典中获取。 ➋ 要检查的表单字段使用字典的 .get() 方法从 cleaned_data 字典中获取。如果用户未在某个表单字段中输入值，那么 cleaned_data 字典中便没有对应的键值对。此时，.get() 方法返回 None，而不抛出 KeyError 异常。这样能让代码稍微简洁一点。 ➌ 先检查要处理的表单字段中有没有值，如果有再检查值是什么。如果发现值不符合预期，那就做些处理，然后把新值存入 cleaned_data 字典。 ➍ clean() 方法的最后必须返回 cleaned_data 字典的引用。否则改动不生效。 这个简单的示例展示了如何在保存之前清理数据。clean() 方法特别有用，尤其适合为字段提供 默认值，或者为用户没有填写的字段提供值。 覆盖 Django 框架的方法能为你的应用添加额外的功能。除了 ModelForm 类的 clean() 方法之 外，还有很多方法可以放心覆盖，详情参见 Django 文档。
