django的Form组件
Form类
创建Form类时，主要涉及到 【字段】 和 【插件】，字段用于对用户请求数据的验证，插件用于自动生成HTML，而且前端用submit提交的时候，虽然刷新页面，但是可以保留上一次提交的数据;
新URL操作：验证+ 生成HTML
Ajax：验证+HTML 或 验证
Form操作
1、数据验证（强大）
- 每一个字段（正则，字段钩子）
- clean
- _post_clean
整体错误信息：__all__
1、Django内置字段如下：
Field required=True, 是否允许为空 widget=None, HTML插件 label=None, 用于生成Label标签或显示内容 initial=None, 初始值 help_text='', 帮助信息(在标签旁边显示) error_messages=None, 错误信息 {'required': '不能为空', 'invalid': '格式错误'} show_hidden_initial=False, 是否在当前插件后面再加一个隐藏的且具有默认值的插件（可用于检验两次输入是否一致） validators=[], 自定义验证规则 localize=False, 是否支持本地化 disabled=False, 是否可以编辑 label_suffix=None Label内容后缀 CharField(Field) max_length=None, 最大长度 min_length=None, 最小长度 strip=True 是否移除用户输入空白 IntegerField(Field) max_value=None, 最大值 min_value=None, 最小值 FloatField(IntegerField) ... DecimalField(IntegerField) max_value=None, 最大值 min_value=None, 最小值 max_digits=None, 总长度 decimal_places=None, 小数位长度 BaseTemporalField(Field) input_formats=None 时间格式化 DateField(BaseTemporalField) 格式：2015-09-01 TimeField(BaseTemporalField) 格式：11:12 DateTimeField(BaseTemporalField)格式：2015-09-01 11:12 DurationField(Field) 时间间隔：%d %H:%M:%S.%f ... RegexField(CharField) regex, 自定制正则表达式 max_length=None, 最大长度 min_length=None, 最小长度 error_message=None, 忽略，错误信息使用 error_messages={'invalid': '...'} EmailField(CharField) ... FileField(Field) allow_empty_file=False 是否允许空文件 ImageField(FileField) ... 注：需要PIL模块，pip3 install Pillow 以上两个字典使用时，需要注意两点： - form表单中 enctype="multipart/form-data" - view函数中 obj = MyForm(request.POST, request.FILES) URLField(Field) ... BooleanField(Field) ... NullBooleanField(BooleanField) ... ChoiceField(Field) ... choices=(), 选项，如：choices = ((0,'上海'),(1,'北京'),) required=True, 是否必填 widget=None, 插件，默认select插件 label=None, Label内容 initial=None, 初始值 help_text='', 帮助提示 ModelChoiceField(ChoiceField) ... django.forms.models.ModelChoiceField queryset, # 查询数据库中的数据 empty_label="---------", # 默认空显示内容 to_field_name=None, # HTML中value的值对应的字段 limit_choices_to=None # ModelForm中对queryset二次筛选 ModelMultipleChoiceField(ModelChoiceField) ... django.forms.models.ModelMultipleChoiceField TypedChoiceField(ChoiceField) coerce = lambda val: val 对选中的值进行一次转换 empty_value= '' 空值的默认值 MultipleChoiceField(ChoiceField) ... TypedMultipleChoiceField(MultipleChoiceField) coerce = lambda val: val 对选中的每一个值进行一次转换 empty_value= '' 空值的默认值 ComboField(Field) fields=() 使用多个验证，如下：即验证最大长度20，又验证邮箱格式 fields.ComboField(fields=[fields.CharField(max_length=20), fields.EmailField(),]) MultiValueField(Field) PS: 抽象类，子类中可以实现聚合多个字典去匹配一个值，要配合MultiWidget使用 SplitDateTimeField(MultiValueField) input_date_formats=None, 格式列表：['%Y--%m--%d', '%m%d/%Y', '%m/%d/%y'] input_time_formats=None 格式列表：['%H:%M:%S', '%H:%M:%S.%f', '%H:%M'] FilePathField(ChoiceField) 文件选项，目录下文件显示在页面中 path, 文件夹路径 match=None, 正则匹配 recursive=False, 递归下面的文件夹 allow_files=True, 允许文件 allow_folders=False, 允许文件夹 required=True, widget=None, label=None, initial=None, help_text='' GenericIPAddressField protocol='both', both,ipv4,ipv6支持的IP格式 unpack_ipv4=False 解析ipv4地址，如果是::ffff:192.0.2.1时候，可解析为192.0.2.1， PS：protocol必须为both才能启用 SlugField(CharField) 数字，字母，下划线，减号（连字符） ... UUIDField(CharField) uuid类型 ...
注：UUID是根据MAC以及当前时间等创建的不重复的随机字符串
>>> import uuid # make a UUID based on the host ID and current time >>> uuid.uuid1() # doctest: +SKIP UUID('a8098c1a-f86e-11da-bd1a-00112444be1e') # make a UUID using an MD5 hash of a namespace UUID and a name >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org') UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e') # make a random UUID >>> uuid.uuid4() # doctest: +SKIP UUID('16fd2706-8baf-433b-82eb-8c7fada847da') # make a UUID using a SHA-1 hash of a namespace UUID and a name >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org') UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d') # make a UUID from a string of hex digits (braces and hyphens ignored) >>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}') # convert a UUID to a string of hex digits in standard form >>> str(x) '00010203-0405-0607-0809-0a0b0c0d0e0f' # get the raw 16 bytes of the UUID >>> x.bytes b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f' # make a UUID from a 16-byte string >>> uuid.UUID(bytes=x.bytes) UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
2、Django内置插件：
TextInput(Input)
NumberInput(TextInput)
EmailInput(TextInput)
URLInput(TextInput)
PasswordInput(TextInput)
HiddenInput(TextInput)
Textarea(Widget)
DateInput(DateTimeBaseInput)
DateTimeInput(DateTimeBaseInput)
TimeInput(DateTimeBaseInput)
CheckboxInput
Select
NullBooleanSelect
SelectMultiple
RadioSelect
CheckboxSelectMultiple
FileInput
ClearableFileInput
MultipleHiddenInput
SplitDateTimeWidget
SplitHiddenDateTimeWidget
SelectDateWidget
常用选择插件
单radio方法一：
# 单radio，值为字符串 # user = fields.CharField( # initial=2, # widget=widgets.RadioSelect(choices=((1,'上海'),(2,'北京'),)) # ) 单radio方法二： # 单radio，值为字符串 # user = fields.ChoiceField( # choices=((1, '上海'), (2, '北京'),), # initial=2, # widget=widgets.RadioSelect # ) 单select方法一： # 单select，值为字符串 # user = fields.CharField( # initial=2, # widget=widgets.Select(choices=((1,'上海'),(2,'北京'),)) # ) 单select方法二： # 单select，值为字符串 # user = fields.ChoiceField( # choices=((1, '上海'), (2, '北京'),), # initial=2, # widget=widgets.Select # ) # 多选select，值为列表 # user = fields.MultipleChoiceField( # choices=((1,'上海'),(2,'北京'),), # initial=[1,], # widget=widgets.SelectMultiple # ) # 单checkbox # user = fields.CharField( # widget=widgets.CheckboxInput() # ) # 多选checkbox,值为列表 # user = fields.MultipleChoiceField( # initial=[2, ], # choices=((1, '上海'), (2, '北京'),), # widget=widgets.CheckboxSelectMultiple # )
Form操作动态Select数据
在使用选择标签时，需要注意choices的选项可以从数据库中获取，但是由于是静态字段 ***获取的值无法实时更新***，那么需要自定义构造方法从而达到此目的。
实例：（推荐方式一）
视图函数
from django import forms from app01 import models from django.forms import fields from django.forms import widgets class FM(forms.Form): user = fields.CharField( error_messages={'required':'用户名不能为空'}, widget=widgets.TextInput(attrs={'class':'c1'}), # attrs给这个标签添加属性 label='用户名', # initial='Admin', ) passwd = fields.CharField( max_length=12, min_length=6, error_messages={ 'required':'密码不能为空', 'max_length':'密码长度不能大于12', 'min_length':'密码长度不能小于6'}, widget=widgets.PasswordInput ) email = fields.EmailField( error_messages={ 'required':'邮箱不能为空', 'invalid':'邮箱格式不正确' }) city = fields.ChoiceField( # choices=[(0,'上海'),(1,'广州'),(2,'东莞')], # choices=models.UserType.objects.values_list('id','name'), # choices=[], # initial=2, widget=widgets.Select, #方式一（推荐） ) city2 = fields.CharField(widget=widgets.Select(choices=[])) # 方式二 def __init__(self,*args,**kwargs): # 重写构造方法 super(FM,self).__init__(*args,**kwargs) # 执行父类构造方法 self .fields['city'].choices = models.UserType.objects.values_list('id','name') # 方式一（推荐） self.fields['city2'].widget.choices = models.UserType.objects.values_list('id', 'name') # 方式二 def fm(request): if request.method == 'GET': dic={ 'user':'root', 'passwd':'123', 'email':'840003308@qq.com', 'city':2, 'hoby':[1,2], } obj = FM(initial=dic) return render(request,'fm.html',{'obj':obj}) elif request.method == 'POST': obj = FM(request.POST) if obj.is_valid(): print(obj.cleaned_data) #返回的正确信息，字典类型 models.User.objects.create(**obj.cleaned_data) return HttpResponse('OK') else: print(obj.errors.as_json()) #返回的所有错误信息 # print(obj.errors['user']) return render(request,'fm.html',{'obj':obj})
fm.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <form action="/fm/" method="POST"> {% csrf_token %} <p>{{ obj.user.label }}{{ obj.user }} {{ obj.errors.user.0 }}</p> <p>{{ obj.passwd }} {{ obj.errors.passwd.0 }}</p> <p>{{ obj.email }} {{ obj.errors.email.0 }}</p> <p>{{ obj.city }}</p> <P>{{ obj.city2 }}</P> <p><input type="submit" value="提交"></p> </form> </body> </html>
方式二：
使用django提供的ModelChoiceField和ModelMultipleChoiceField字段来实现
from django import forms from django.forms import fields from django.forms import widgets from django.forms import models as form_model from django.core.exceptions import ValidationError from django.core.validators import RegexValidator class FInfo(forms.Form): authors = form_model.ModelMultipleChoiceField(queryset=models.NNewType.objects.all()) # authors = form_model.ModelChoiceField(queryset=models.NNewType.objects.all())
自定义验证规则
方式一：
from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.validators import RegexValidator class MyForm(Form): user = fields.CharField( validators=[RegexValidator(r'^[0-9]+$', '请输入数字'), RegexValidator(r'^159[0-9]+$', '数字必须以159开头')], )
方式二：
import re from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.exceptions import ValidationError # 自定义验证规则 def mobile_validate(value): mobile_re = re.compile(r'^(13[0-9]|15[012356789]|17[678]|18[0-9]|14[57])[0-9]{8}$') if not mobile_re.match(value): raise ValidationError('手机号码格式错误') class PublishForm(Form): title = fields.CharField(max_length=20, min_length=5, error_messages={'required': '标题不能为空', 'min_length': '标题最少为5个字符', 'max_length': '标题最多为20个字符'}, widget=widgets.TextInput(attrs={'class': "form-control", 'placeholder': '标题5-20个字符'})) # 使用自定义验证规则 phone = fields.CharField(validators=[mobile_validate, ], error_messages={'required': '手机不能为空'}, widget=widgets.TextInput(attrs={'class': "form-control", 'placeholder': u'手机号码'})) email = fields.EmailField(required=False, error_messages={'required': u'邮箱不能为空','invalid': u'邮箱格式错误'}, widget=widgets.TextInput(attrs={'class': "form-control", 'placeholder': u'邮箱'}))
方法三：自定义方法
from django import forms from django.forms import fields from django.forms import widgets from django.core.exceptions import ValidationError from django.core.validators import RegexValidator class FInfo(forms.Form): username = fields.CharField(max_length=5, validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid extension.', 'invalid')], ) email = fields.EmailField() def clean_username(self): """ Form中字段中定义的格式匹配完之后，执行此方法进行验证 :return: """ value = self.cleaned_data['username'] if "666" in value: raise ValidationError('666已经被玩烂了...', 'invalid') return value
方式四：同时生成多个标签进行验证
from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.validators import RegexValidator ############## 自定义字段 ############## class PhoneField(fields.MultiValueField): def __init__(self, *args, **kwargs): # Define one message for all fields. error_messages = { 'incomplete': 'Enter a country calling code and a phone number.', } # Or define a different message for each field. f = ( fields.CharField( error_messages={'incomplete': 'Enter a country calling code.'}, validators=[ RegexValidator(r'^[0-9]+$', 'Enter a valid country calling code.'), ], ), fields.CharField( error_messages={'incomplete': 'Enter a phone number.'}, validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid phone number.')], ), fields.CharField( validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid extension.')], required=False, ), ) super(PhoneField, self).__init__(error_messages=error_messages, fields=f, require_all_fields=False, *args, **kwargs) def compress(self, data_list): """ 当用户验证都通过后，该值返回给用户 :param data_list: :return: """ return data_list ############## 自定义插件 ############## class SplitPhoneWidget(widgets.MultiWidget): def __init__(self): ws = ( widgets.TextInput(), widgets.TextInput(), widgets.TextInput(), ) super(SplitPhoneWidget, self).__init__(ws) def decompress(self, value): """ 处理初始值，当初始值initial不是列表时，调用该方法 :param value: :return: """ if value: return value.split(',') return [None, None, None]
初始化数据
1、Form
from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.validators import RegexValidator class MyForm(Form): user = fields.CharField() city = fields.ChoiceField( choices=((1, '上海'), (2, '北京'),), widget=widgets.Select )
2、Views
from django.shortcuts import render, redirect from .forms import MyForm def index(request): if request.method == "GET": values = {'user': 'root', 'city': 2} obj = MyForm(values) return render(request, 'index.html', {'form': obj}) elif request.method == "POST": return redirect('http://www.google.com') else: return redirect('http://www.google.com')
3、HTML
<form method="POST" enctype="multipart/form-data"> {% csrf_token %} <p>{{ form.user }} {{ form.user.errors }}</p> <p>{{ form.city }} {{ form.city.errors }}</p> <input type="submit"/> </form>
实例：
视图函数
from django import forms from app01 import models from django.forms import fields from django.forms import widgets class FM(forms.Form): user = fields.CharField( #这里的user如果是form生成的可以随便写，前端用的时候直接用创建的FM()对象obj,obj.user填到前端页面就既可以验证，又可以创建HTML标签，如果是自己的的前端，要跟前端的name的值一致。 error_messages={'required':'用户名不能为空'}, widget=widgets.TextInput(attrs={'class':'c1'}), label='用户名', # initial='Admin', ) passwd = fields.CharField( max_length=12, min_length=6, error_messages={ 'required':'密码不能为空', 'max_length':'密码长度不能大于12', 'min_length':'密码长度不能小于6'}, widget=widgets.PasswordInput ) email = fields.EmailField( error_messages={ 'required':'邮箱不能为空', 'invalid':'邮箱格式不正确' }) city = fields.ChoiceField( choices=[(0,'上海'),(1,'广州'),(2,'东莞')], # initial=2, widget=widgets.Select, ) hoby = fields.MultipleChoiceField( choices=[(0,'抽烟'),(1,'喝酒'),(2,'烫头')] ) hoby1 = fields.CharField( label='同意协议', widget=widgets.CheckboxInput() ) def fm(request): if request.method == 'GET': dic={ 'user':'root', 'passwd':'123', 'email':'840003308@qq.com', 'city':2, 'hoby':[1,2], } obj = FM(initial=dic) return render(request,'fm.html',{'obj':obj}) elif request.method == 'POST': obj = FM(request.POST) if obj.is_valid(): print(obj.cleaned_data) #返回的正确信息 models.User.objects.create(**obj.cleaned_data) return HttpResponse('OK') else: print(obj.errors.as_json()) #返回的所有错误信息 # print(obj.errors['user']) return render(request,'fm.html',{'obj':obj})
fm.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <form action="/fm/" method="POST"> {% csrf_token %} <p>{{ obj.user.label }}{{ obj.user }} {{ obj.errors.user.0 }}</p> <p>{{ obj.passwd }} {{ obj.errors.passwd.0 }}</p> <p>{{ obj.email }} {{ obj.errors.email.0 }}</p> <p>{{ obj.city }}</p> <p>{{ obj.hoby }}</p> <p>{{ obj.hoby1 }}{{ obj.hoby1.label }}</p> <p><input type="submit" value="提交"></p> </form> </body> </html>
Form的钩子
字段钩子
视图函数
from django import forms from app01 import models from django.forms import fields from django.forms import widgets class FM(forms.Form): user = fields.CharField( #这里的user最好跟数据库里的字段一致，方便用cleaned_data提交数据到数据库 error_messages={'required':'用户名不能为空'}, widget=widgets.TextInput(attrs={'class':'c1'}), label='用户名', # initial='Admin', ) passwd = fields.CharField( max_length=12, min_length=6, error_messages={ 'required':'密码不能为空', 'max_length':'密码长度不能大于12', 'min_length':'密码长度不能小于6'}, widget=widgets.PasswordInput ) email = fields.EmailField( error_messages={ 'required':'邮箱不能为空', 'invalid':'邮箱格式不正确' }) def clean_user(self): # 字段钩子clean_fieldname，对单个字段再加验证。 c = models.User.objects.filter(user=self.cleaned_data['user']).count() if not c: return self.cleaned_data['user'] else: raise ValidationError('用户名已经存在',code = 'xxx') def clean_email(self): c = models.User.objects.filter(email=self.cleaned_data['email']).count() if not c: return self.cleaned_data['email'] else: raise ValidationError('邮箱已经存在',code='emailxxx') def fm(request): if request.method == 'GET': dic={ 'user':'root', 'passwd':'123', 'email':'840003308@qq.com', 'city':2, 'hoby':[1,2], } obj = FM(initial=dic) return render(request,'fm.html',{'obj':obj}) elif request.method == 'POST': obj = FM(request.POST) if obj.is_valid(): print(obj.cleaned_data) #返回的正确信息，字段类型 models.User.objects.create(**obj.cleaned_data) return HttpResponse('OK') else: print(obj.errors.as_json()) #返回的所有错误信息 # print(obj.errors['user']) #obj.errors['user']是user的错误信息，obj.errors['__all__']是整体的错误信息 return render(request,'fm.html',{'obj':obj})
fm.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <form action="/fm/" method="POST"> {% csrf_token %} <p>{{ obj.user.label }}{{ obj.user }} {{ obj.errors.user.0 }}</p> <p>{{ obj.passwd }} {{ obj.errors.passwd.0 }}</p> <p>{{ obj.email }} {{ obj.errors.email.0 }}</p> <p><input type="submit" value="提交"></p> </form> </body> </html>
整体钩子(clean)
视图函数
class Login(forms.Form): user = fields.CharField() passwd = fields.CharField() def clean(self): c = models.User.objects.filter(user=self.cleaned_data['user'],passwd=self.cleaned_data['passwd']).count() if c: return self.cleaned_data else: raise ValidationError('用户名或密码错误', code='xxx') def login2(request): if request.method == 'POST': obj = Login(request.POST) if obj.is_valid(): print(obj.cleaned_data) return HttpResponse('OK') else: print(obj.errors.as_json()) #返回的所有错误信息 return render(request,'login2.html',{'obj':obj}) else: obj = Login() return render(request,'login2.html',{'obj':obj})
login2.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <form action="/login2/" method="POST"> {% csrf_token %} <p>{{ obj.user.label }}{{ obj.user }} {{ obj.errors.user.0 }}</p> <p>{{ obj.passwd }} {{ obj.errors.passwd.0 }}</p> {% for k in obj.errors.values %} <p>{{ k.0 }}</p> {% endfor %} <input type="submit" value="提交"> </form> </body> </html>
额外自定义的钩子_post_clean
钩子流程
序列化
关于Django中的序列化主要应用在将数据库中检索的数据返回给客户端用户，特别的Ajax请求一般返回的为Json格式。
方法一：serializers
from django.core import serializers ret = models.BookType.objects.all() data = serializers.serialize("json", ret)
序列化后的对象是经过django特殊处理的，列表字典，方便前端处理。
方法二：
def index2(request): import json v = models.User.objects.values('id','name') v = list(v) return HttpResponse(json.dumps(v)) # 如果v里面没有datetime,不需要重写JsonCustomEncoder
Form内置序列化错误信息
json知识补充
import json from django.core.exceptions import ValidationError class JsonCustomEncoder(json.JSONEncoder): def default(self, field): if isinstance(field, ValidationError): return {'code':field.code,'message':field.message} else: return json.JSONEncoder.default(self, field)
json.dumps(ret)就是对ret里面的所有元素执行JsonCustomEncoder的default方法
实例：
视图函数
import json from django import forms from app01 import models from django.forms import fields from django.forms import widgets class Login(forms.Form): user = fields.CharField() passwd = fields.CharField(min_length=6) from django.core.exceptions import ValidationError class JsonCustomEncoder(json.JSONEncoder): def default(self, field): if isinstance(field, ValidationError): return {'code': field.code, 'messages': field.messages} else: return json.JSONEncoder.default(self, field) def login3(request): if request.method == 'GET': return render(request,'login3.html') else: ret = {'status':True,'error':None,'data':None} obj = Login(request.POST) if obj.is_valid(): print(obj.cleaned_data) ret['data'] = obj.cleaned_data else: ret['status'] = False ret['error'] = obj.errors.as_data() #返回一个原生的字典，这个字典里的value为ValidationError，不能被序列化。 result = json.dumps(ret, cls=JsonCustomEncoder) #cls是对每一个字段序列化都要调用里面的default方法 return HttpResponse(result)
前端页面
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <form id="fm" action="/login3/" method="POST"> {% csrf_token %} <p><input type="text" name="user"></p> <p><input type="password" name="passwd"></p> <p id="error"></p> <p><input id="submit" type="button" value="提交"></p> </form> <script src="/static/jquery-1.12.4.js"></script> <script> $(function () { $('#submit').click(function () { $.ajax({ url:'/login3/', type:'POST', data:$('#fm').serialize(), success: function (arg) { console.log(arg); # 字符串类型
arg = JSON.parse(arg); # 反序列化为字典类型 }, error:function () { } }) }) }) </script>
浙公网安备 33010602011771号