表单:
HTML中的表单:
单纯从前端的html来说,表单是用来提交数据给服务器的,不管后台的服务器用的是Django还是PHP语言还是其他语言。只要把input标签放在form标签中,然后再添加一个提交按钮,那么以后点击提交按钮,就可以将input标签中对应的值提交给服务器了。
Django中的表单:
Django中的表单丰富了传统的HTML语言中的表单。在Django中的表单,主要做以下两件事:
- 渲染表单模板。(前后端分离的开发中,这个最好不用,画蛇添足,增加了耦合,贼鸡肋!)
- 表单验证数据是否合法。
Django中表单使用流程:
在讲解Django表单的具体每部分的细节之前。我们首先先来看下整体的使用流程。这里以一个做一个留言板为例。首先我们在后台服务器定义一个表单类,继承自django.forms.Form。示例代码如下:
# forms.pyclass MessageBoardForm(forms.Form):# label属性表示在表单中使用 {{form.as_table}}时显示的标签名title = forms.CharField(max_length=10,label='标题',min_length=2,error_messages={"min_length":'标题字符段不符合要求!'})content = forms.CharField(widget=forms.Textarea,label='内容',error_messages={"required":"必须要传content字段!"})email = forms.EmailField(label='邮箱', error_messages={"required":"必须要传email字段!"})reply = forms.BooleanField(required=False,label='回复') # required=False意味着该字段可传可不传
然后在视图中,根据是GET还是POST请求来做相应的操作。如果是GET请求,那么返回一个空的表单,如果是POST请求,那么将提交上来的数据进行校验。示例代码如下:
# views.pyclass IndexView(View):def get(self,request):form = MessageBoardForm()return render(request,'index.html',{'form':form})def post(self,request):form = MessageBoardForm(request.POST)if form.is_valid(): # 强大的is_valid()"""虽然前台会做很多验证,不通过验证的数据根本没有来这里机会,但是!如果别人直接请求API的话(比如用Postman测试),就会绕过前端的验证!所以,后端的验证是非常有必要的!这是网站的最后一道防线!"""title = form.cleaned_data.get('title')content = form.cleaned_data.get('content')email = form.cleaned_data.get('email')reply = form.cleaned_data.get('reply')# 将数据存入数据库return HttpResponse('success')else:print(form.errors)return HttpResponse('fail')
在使用GET请求的时候,我们传了一个form给模板,那么以后模板就可以使用form来生成一个表单的html代码。在使用POST请求的时候,我们根据前端上传上来的数据,构建一个新的表单,这个表单是用来验证数据是否合法的,如果数据都验证通过了,那么我们可以通过cleaned_data来获取相应的数据。在模板中渲染表单的HTML代码如下:
<form action="" method="post"><table>{{ form.as_table }}<!-- 自己只需要再写个按钮就行啦 --><tr><td></td><td><input type="submit" value="提交"></td></tr></table></form>
我们在最外面给了一个form标签,然后在里面使用了table标签来进行美化,在使用form对象渲染的时候,使用的是table的方式,当然还可以使用ul的方式(as_ul),也可以使用p标签的方式(as_p),并且在后面我们还加上了一个提交按钮,这样就可以生成一个表单了。
用表单验证数据
常用的Field:
使用Field可以是对数据验证的第一步。你期望这个提交上来的数据是什么类型,那么就使用什么类型的Field。
CharField:
用来接收文本。
参数:
- max_length:这个字段值的最大长度。
- min_length:这个字段值的最小长度。
- required:这个字段是否是必须的。默认是必须的。
- error_messages:在某个条件验证失败的时候,给出错误信息。
EmailField:
用来接收邮件,会自动验证邮件是否合法。
错误信息的key:required、invalid。
FloatField:
用来接收浮点类型,并且如果验证通过后使用表单对象的cleaned_data.get()会将这个字段的值直接转换为浮点类型。
参数:
- max_value:最大的值。
- min_value:最小的值。
错误信息的key:required、invalid、max_value、min_value。
IntegerField:
用来接收整形,并且验证通过后,会将这个字段的值转换为整形。
参数:
- max_value:最大的值。
- min_value:最小的值。
错误信息的key:required、invalid、max_value、min_value。
URLField:
用来接收url格式的字符串。
错误信息的key:required、invalid。
常用验证器:
在验证某个字段的时候,可以传递一个validators参数用来指定验证器,进一步对数据进行过滤。验证器有很多,但是很多验证器我们其实已经通过这个Field或者一些参数就可以指定了。比如EmailValidator,我们可以通过EmailField来指定,比如MaxValueValidator,我们可以通过max_value参数来指定。以下是一些常用的验证器:
MaxValueValidator:验证最大值。MinValueValidator:验证最小值。MinLengthValidator:验证最小长度。MaxLengthValidator:验证最大长度。EmailValidator:验证是否是邮箱格式。URLValidator:验证是否是URL格式。RegexValidator:如果还需要更加复杂的验证,那么我们可以通过正则表达式的验证器。比如现在要验证手机号码是否合格,那么我们可以通过以下代码实现:class MyForm(forms.Form):telephone = forms.CharField(validators=[validators.RegexValidator("1[345678]\d{9}",message='请输入正确格式的手机号码!')])
自定义验证(重要!):
有时候对一个字段验证,不是一个长度,一个正则表达式能够写清楚的,还需要一些其他复杂的逻辑,那么我们可以对某个字段,进行自定义的验证。比如在注册的表单验证中,我们想要验证手机号码是否已经被注册过了,那么这时候就需要在数据库中进行判断才知道。对某个字段进行自定义的验证方式是,定义一个方法,这个方法的名字定义规则是:clean_fieldname。如果验证失败,那么就抛出一个验证错误。比如要验证用户表中手机号码之前是否在数据库中存在,那么可以通过以下代码实现:
class MyForm(forms.Form):telephone = forms.CharField(validators=[validators.RegexValidator("1[345678]\d{9}",message='请输入正确格式的手机号码!')])def clean_telephone(self):telephone = self.cleaned_data.get('telephone')exists = User.objects.filter(telephone=telephone).exists()if exists:raise forms.ValidationError(message="%手机号码已经被注册!" % telephone)return telephone # 最后一定要再返回相应字段,这意味着你不仅可以做验证,还可以做数据处理!
以后当在视图中调用form.is_valid()时,会自动地调用上面的clean_telephone方法进行附加规则的验证,so 方便!
以上是对某个字段进行验证,如果验证数据的时候,需要针对多个字段同时进行验证,那么可以重写clean方法。比如要在注册的时候,要判断提交的两个密码是否相等。那么可以使用以下代码来完成:
class MyForm(forms.Form):telephone = forms.CharField(validators=[validators.RegexValidator("1[345678]\d{9}",message='请输入正确格式的手机号码!')])pwd1 = forms.CharField(max_length=12)pwd2 = forms.CharField(max_length=12)def clean(self):"""能够来到clean方法,说明每一个字段的单独验证已经都成功了!"""cleaned_data = super().clean()pwd1 = cleaned_data.get('pwd1')pwd2 = cleaned_data.get('pwd2')if pwd1 != pwd2:raise forms.ValidationError(message='两个密码不一致!')return cleaned_data # 最后要记得返回
提取错误信息:
如果验证失败了,那么有一些错误信息是我们需要传给前端的。这时候我们可以通过以下属性来获取:
form.errors:这个属性获取的错误信息是一个包含了html标签的错误信息。form.errors.get_json_data():这个方法获取到的是一个字典类型的错误信息。将某个字段的名字作为key,错误信息作为值的一个字典。form.as_json():这个方法是将form.get_json_data()返回的字典dump成json格式的字符串,方便进行传输。- 上述方法获取的字段的错误值,都是一个比较复杂的数据。比如以下:
{'username': [{'message': 'Enter a valid URL.', 'code': 'invalid'}, {'message': 'Ensure this value has at most 4 characters (it has 22).', 'code': 'max_length'}]}
那么如果我只想把错误信息放在一个列表中,而不要再放在一个字典中。这时候我们可以定义一个方法,把这个数据重新整理一份。实例代码如下:
class MyForm(forms.Form):username = forms.URLField(max_length=4)def get_errors(self): # 这个函数的名字没有要求,是给视图函数调用的errors = self.errors.get_json_data()new_errors = {}for key,message_dicts in errors.items():messages = []for message in message_dicts:messages.append(message['message'])new_errors[key] = messagesreturn new_errors
这样就可以返回给前端相对友好的错误提示。
ModelForm(这才是利器!)
大家在写表单的时候,会发现表单中的Field和模型中的Field基本上是一模一样的,而且表单中需要验证的数据,也就是我们模型中需要保存的。那么这时候我们就可以将模型中的字段和表单中的字段进行绑定。
比如现在有个Article的模型。示例代码如下:
from django.db import modelsfrom django.core import validatorsclass Article(models.Model):title = models.CharField(max_length=10,validators=[validators.MinLengthValidator(limit_value=3)])content = models.TextField()author = models.CharField(max_length=100)category = models.CharField(max_length=100)create_time = models.DateTimeField(auto_now_add=True)
注意:上面的title使用了一个validators参数,用来做验证!那么问题来了,如果我想像之前那样做深度验证呢?很简单,还是用在表单中定义clean_fieldname()的方式!
接下来就该ModelForm登场了,此时就不需要把Article模型中所有的字段都一个个重复写一遍了。示例代码如下:
from django import formsclass ArticleForm(forms.ModelForm):class Meta:model = Articlefields = "__all__"
ArticleForm是继承自forms.ModelForm,然后在表单中定义了一个Meta类,在Meta类中指定了model=Article,以及fields="__all__",这样就可以将Article模型中所有的字段都复制过来,进行验证。如果只想针对其中几个字段进行验证,那么可以给fields指定一个列表,将需要的字段写进去。比如只想验证title和content,那么可以使用以下代码实现:
from django import formsclass ArticleForm(forms.ModelForm):class Meta:model = Articlefields = ['title','content']
如果要验证的字段比较多,只是除了少数几个字段不需要验证,那么可以使用exclude来代替fields。比如我不想验证category,那么示例代码如下:
class ArticleForm(forms.ModelForm):class Meta:model = Articleexclude = ['category']
自定义错误消息:
使用ModelForm,因为字段都不是在表单中定义的,而是在模型中定义的,因此一些错误消息无法在字段中定义。那么这时候可以在Meta类中,定义error_messages,然后把相应的错误消息写到里面去。示例代码如下:
class ArticleForm(forms.ModelForm):class Meta:model = Articleexclude = ['category']error_messages ={'title':{'max_length': '最多不能超过10个字符!','min_length': '最少不能少于3个字符!'},'content': {'required': '必须输入content!',}}
save方法:
ModelForm还有save方法,可以在验证完成后直接调用save方法,就可以将这个数据保存到数据库中了。示例代码如下:
form = ArticleForm(request.POST)if form.is_valid():form.save() # 一行代码解决问题!人生苦短,我用Python!return HttpResponse('succes')else:print(form.get_errors())return HttpResponse('fail')
这个方法必须要在clean没有问题后才能使用,如果在clean之前使用,会抛出异常。另外,我们在调用save方法的时候,如果传入一个commit=False,那么只会生成这个模型的对象,而不会把这个对象真正的插入到数据库中。比如表单上验证的字段没有包含模型中所有的字段,这时候就可以先创建对象,再根据填充其他字段,把所有字段的值都补充完成后,再保存到数据库中。示例代码如下:
form = ArticleForm(request.POST)if form.is_valid():article = form.save(commit=False) # 只生成对象,不保存到数据库article.category = 'Python'article.save()return HttpResponse('succes')else:print(form.get_errors())return HttpResponse('fail')
这个功能在注册时很有用,因为注册时需要输入两次密码,而保存到数据库中的只有一个,所以要先使用form.save(commit=False)来生成对象,然后添加password字段,最后再执行save()。如下:
# ==============forms.py==============class RegistorForm(forms.ModelForm):# 2.再添加两个密码字段pwd1 = forms.CharField(max_length=16, min_length=6)pwd2 = forms.CharField(max_length=16, min_length=6)def clean(self):cleaned_data = super().clean()class Meta:model = Userexclude = ['password'] # 1.先排掉password字段# ==============views.py==============@require_POSTdef register(request):form = RegisterForm(request.POST)if form.is_valid():user = form.save(commit=False)user.password = form.cleaned_data.get('pwd1') # 3.再添加回password字段user.save()return HttpResponse("success!")else:return HttpResponse("fail!")
文件上传:
文件上传是网站开发中非常常见的功能。这里详细讲述如何在Django中实现文件的上传功能。
前端HTML代码实现:
- 在前端中,我们需要填入一个
form标签,然后必须在这个form标签中指定enctype="multipart/form-data",该字段用来告诉浏览器对表单数据采用何种编码方式,不然就不能上传文件。 - 在
form标签中添加一个input标签,然后指定input标签的name,以及type="file"。
以上两步的示例代码如下:
<form action="" method="post" enctype="multipart/form-data"><input type="file" name="myfile"> <!--只有设置了type="file",点击时才会调出文件管理器 --><input type="submit" value="提交"></form>
后端的代码实现:
后端的主要工作是接收文件,然后存储文件。接收文件的方式跟接收POST的方式是一样的,只不过是通过request.FILES来实现。示例代码如下:
# =============views.py===============def save_file(file):with open('somefile.txt','wb') as fp:for chunk in file.chunks():fp.write(chunk)def index(request):if request.method == 'GET':form = MyForm()return render(request,'index.html',{'form':form})else:myfile = request.FILES.get('myfile')save_file(myfile)return HttpResponse('success')
以上代码通过request.FILES接收到文件后,再写入到指定的地方。上述代码没有指定地址,会保存在项目的更目录下。这样就可以完成一个文件的上传功能了。
使用模型来处理上传的文件:
在定义模型的时候,我们可以给存储文件的字段指定为FileField,这个Field可以传递一个upload_to参数,用来指定上传上来的文件保存到哪里。比如我们让他保存到项目的files文件夹下,那么示例代码如下:
# models.pyclass Article(models.Model):title = models.CharField(max_length=100)content = models.TextField()thumbnail = models.FileField(upload_to="files") # 使用FileField字段,就不用自己写save_file()函数了!# views.pydef index(request):if request.method == 'GET':return render(request,'index.html')else:title = request.POST.get('title')content = request.POST.get('content')thumbnail = request.FILES.get('thumbnail')article = Article(title=title, content=content, thumbnail=thumbnail)article.save()return HttpResponse('success')
调用完article.save()方法,就会把文件保存到files下面,并且会将这个文件的路径存储到数据库中。
指定MEDIA_ROOT和MEDIA_URL:
以上我们是使用了upload_to来指定上传的文件的目录。我们也可以指定MEDIA_ROOT,就不需要在FielField中指定upload_to,他会自动的将文件上传到MEDIA_ROOT的目录下。
# settings.pyMEDIA_ROOT = os.path.join(BASE_DIR,'media')MEDIA_URL = '/media/'
然后我们可以在urls.py中添加MEDIA_ROOT目录下的访问路径。示例代码如下:
from django.urls import pathfrom front import viewsfrom django.conf.urls.static import staticfrom django.conf import settingsurlpatterns = [path('', views.index),] + static(settings.MEDIA_URL,document_root=settings.MEDIA_ROOT)
如果我们同时指定MEDIA_ROOT和upload_to,那么会将文件上传到MEDIA_ROOT下的upload_to文件夹中。示例代码如下:
class Article(models.Model):title = models.CharField(max_length=100)content = models.TextField()thumbnail = models.FileField(upload_to="%Y/%m/%d/") # 这样会在MEDIA_ROOT下建立一个三级目录:2022/04/07
限制上传的文件拓展名:
如果想要限制上传的文件的拓展名,那么我们就需要用到表单来进行限制。我们可以使用普通的Form表单,也可以使用ModelForm,直接从模型中读取字段。示例代码如下:
# models.pyclass Article(models.Model):title = models.CharField(max_length=100)content = models.TextField()thumbnial = models.FileField(upload_to='%Y/%m/%d/',validators=[validators.FileExtensionValidator(['txt','pdf']),message="thumbnial必须为txt或者md类型的文件!"])# forms.pyclass ArticleForm(forms.ModelForm):class Meta:model = Articlefields = "__all__"# views.pyclass ArticleView(View):def get(self, request):return render(request, 'article.html')def post(self, request):form = ArticleForm(request.POST, request.FILES)if form.is_valid():form.save()return HttpResponse("success")else:print(form.errors.get_json_data())return HttpResponse("fail")
上传图片:
上传图片跟上传普通文件是一样的。只不过是上传图片的时候Django会判断上传的文件是否是图片的格式(除了判断后缀名,还会判断是否是可用的图片)。如果不是,那么就会验证失败。我们首先先来定义一个包含ImageField的模型。示例代码如下:
class Article(models.Model):title = models.CharField(max_length=100)content = models.TextField()thumbnail = models.ImageField(upload_to="%Y/%m/%d/")
因为要验证是否是合格的图片,因此我们还需要用一个表单来进行验证。表单我们直接就使用ModelForm就可以了。示例代码如下:
class ArticleForm(forms.ModelForm):class Meta:model = Articlefields = "__all__"error_messages = {thumbnail: {'invalid_image': "请上传合法的图片!"}}
注意:使用ImageField,必须要先安装Pillow库:
pip install pillow
