django10--forms组件

0 前戏

"""
写一个注册功能
  获取用户名和密码 利用form表单提交数据
  在后端判断用户名和密码是否符合一定的条件
    用户名中不能含有金菊梅
    密码不能少于三位
	
    如何符合条件需要你将提示信息展示到前端页面
"""

def ab_form(request):
    back_dic = {'username':'','password':''}
    if request.method == 'POST':
        username = request.POST.get('username')
        password = request.POST.get('password')
        if '金菊梅' in username:
            back_dic['username'] = '不符合社会主义核心价值观'
        if len(password) < 3:
            back_dic['password'] = '不能太短 不好!'
    """
    无论是post请求还是get请求
    页面都能够获取到字典 只不过get请求来的时候 字典值都是空的
    而post请求来之后 字典才可能有值
    """
    return render(request,'ab_form.html',locals())


<form action="" method="post">
    <p>username:
        <input type="text" name="username">
        <span style="color: red">{{ back_dic.username }}</span>
    </p>
    <p>password:
        <input type="text" name="password">
        <span style="color: red">{{ back_dic.password }}</span>
    </p>
    <input type="submit" class="btn btn-info">
</form>


"""
1.手动书写前端获取用户数据的html代码	html标签渲染
2.后端对用户数据进行校验			数据校验
3.对不符合要求的数据进行前端提示		提示信息展示
"""


# 为什么数据校验非要去后端 不能在前端利用js直接完成呢?
  数据校验前端可有可无,但是后端必须要有!!!
	
  因为前端的校验是弱不禁风的 你可以直接修改
  或者利用爬虫程序绕过前端页面直接朝后端提交数据
	
  # eg:购物网站	
    选取了货物之后 会计算一个价格发送给后端 如果后端不做价格的校验
		
    实际是获取到用户选择的所有商品的主键值
    然后在后端查询出所有商品的价格 再次计算一遍
    如果跟前端一致 那么完成支付
    如果不一致直接拒绝
    
    
# form组件三大功能:
  数据校验,标签渲染,信息展示

1 基本使用

# 一般情况下是 app01下 新建form.py,进行forms类的定义

from django import forms


# 与模型层类的定义相似
class MyForm(forms.Form):
    # username字符串类型最小3位最大8位
    username = forms.CharField(min_length=3,max_length=8)  # 字段基本校验
    
    # password字符串类型最小3位最大8位
    password = forms.CharField(min_length=3,max_length=8)
    
    # email字段必须符合邮箱格式  xxx@xx.com
    email = forms.EmailField()

2 数据校验

"""
1.测试环境的准备 可以自己拷贝代码准备
2.其实在pycharm里面已经帮你准备一个测试环境
    python console
"""

from app01 import views


# 1 将带校验的数据组织成字典的形式传入即可
form_obj = views.MyForm({'username':'jason','password':'123','email':'123'})

# 2 判断数据是否合法		注意该方法只有在所有数据全部合法的情况下,才会返回True
form_obj.is_valid()		# False  也是form对象开始校验数据的入口

# 3 查看所有校验通过的数据		(字典形式)
form_obj.cleaned_data	# {'username': 'jason', 'password': '123'}

# 4 查看所有不符合校验规则以及不符合的原因		(字典形式  错误原因是列表的形式,说明可能错误原因是多条)
form_obj.errors		# { 'email': ['Enter a valid email address.'] }

# 5 校验数据只校验类中出现的字段 多传不影响 多传的字段直接忽略
form_obj = views.MyForm({'username':'jason','password':'123','email':'123@qq.com','hobby':'study'})
form_obj.is_valid()		# True

# 6 校验数据 默认情况下 类里面所有的字段都必须传值,不能少传
form_obj = views.MyForm({'username':'jason','password':'123'})
form_obj.is_valid()		# False

# 也就意味着校验数据的时候 默认情况下数据可以多传,但不可能少传

3 标签渲染

"""
1.forms组件只会自动渲染获取用户输入的标签  (input select radio checkbox)
  不能你渲染提交按钮
  
2.label属性默认展示的是类中定义的字段 首字母大写的形式
  也可以自己修改 直接给字段对象加label属性即可
     username = forms.CharField(min_length=3,max_length=8,label='用户名')
"""


def index(request):
    # 1 先产生一个空对象
    form_obj = MyForm()
    # 2 直接将该空对象传递给html页面
    return render(request,'index.html',locals())


# 前端利用空对象做操作
<p>第一种渲染方式:代码书写极少,封装程度太高 不便于后续的扩展 一般情况下只在本地测试使用</p>
{{ form_obj.as_p }}		# 自动将label文本信息 和 输入框  封装到p标签
{{ form_obj.as_ul }}		# 自动将label文本信息 和 输入框  封装到ul标签(无序列表)
{{ form_obj.as_table }}		# 自动将label文本信息 和 输入框  封装到table标签

<p>第二种渲染方式:可扩展性很强 但是需要书写的代码太多  一般情况下不用</p>
<p>{{ form_obj.username.label }}:{{ form_obj.username }}</p>
<p>{{ form_obj.password.label }}:{{ form_obj.password }}</p>
<p>{{ form_obj.email.label }}:{{ form_obj.email }}</p>

<p>第三种渲染方式(推荐使用):代码书写简单 并且扩展性也高</p>
{% for form in form_obj %}
    <p>{{ form.label }}:{{ form }}</p>
{% endfor %}

4 提示信息展示

"""
浏览器会自动帮你校验数据 但是前端的校验弱不禁风
如何让浏览器不做校验	添加novalidate
    <form action="" method="post" novalidate>
"""

from django.shortcuts import render, HttpResponse, redirect

##### views.py
def index(request):
    # 1 先产生一个空对象
    form_obj = MyForm()  # get请求:会访问到这个form空对象,然后利用这个空对象去前端渲染标签样式
    
    if request.method == 'POST':
        # 获取用户数据并且校验
        """
        1.数据获取繁琐
        2.校验数据需要构造成字典的格式传入才行
        ps:但是request.POST可以看成就是一个字典,就可以直接传入
        """
        # 3.校验数据
        form_obj = MyForm(request.POST)  
        # post请求:取名同空form对象一样,这样就可以替换前端渲染标签form空对象,此时页面就保留了传入的数据
        """
         注意,此时生成form对象 form_obj,并不会开始校验数据
         form_obj.is_valid(),调用该方法后,form对象才会开始执行校验
        """
       
        # 4.判断数据是否合法
        if form_obj.is_valid():
            # 5.如果合法 操作数据库存储数据
            return HttpResponse('OK')
        # 5.不合法 有错误
            # 则前端 通过模板语法 显示提示信息 {{ form.errors.0 }}   
            # 注意:form.errors是一个列表(因为出现错误可能是多种原因) 前端默认会渲染成无序列表
        
    # 2 直接将该空对象传递给html页面
    return render(request,'index.html',locals())


##### index.html
{% for form in form_obj %}
    <p>
        {{ form.label }}:{{ form }}
	<span style="color: red">{{ form.errors.0 }}</span>
    </p>
{% endfor %}


"""
1.必备的条件 get请求和post传给html页面对象变量名必须一样
2.forms组件当你的数据不合法的情况下 会保存你上次的数据 让你基于之前的结果进行修改 更加的人性化
"""

# 针对错误的提示信息还可以自己自定制
class MyForm(forms.Form):
    # username字符串类型最小3位最大8位
    username = forms.CharField(min_length=3,max_length=8,label='用户名',
                               error_messages={
                                   'min_length':'用户名最少3位',
                                   'max_length':'用户名最大8位',
                                   'required':"用户名不能为空"
                               })
    # password字符串类型最小3位最大8位
    password = forms.CharField(min_length=3,max_length=8,label='密码',
                               error_messages={
                                   'min_length': '密码最少3位',
                                   'max_length': '密码最大8位',
                                   'required': "密码不能为空"
                               })
    # email字段必须符合邮箱格式  xxx@xx.com
    email = forms.EmailField(label='邮箱',
                             error_messages={
                                 'invalid':'邮箱格式不正确',  # 邮箱特别之处
                                 'required': "邮箱不能为空"
                             })

5 数据校验进阶

5.1 正则校验函数

from django.core.validators import RegexValidator


class MyForm(Form):
    phone = fields.CharField(
        validators=[
             RegexValidator(r'^[0-9]+$', '请输入数字'), 		
	     RegexValidator(r'^159[0-9]+$', '数字必须以159开头')
        ],
    )
    
# 步骤:
  1.导入正则校验函数类 RegexValidator
  2.RegexValidator('正则表达式', '错误提示信息')
  3.校验字段的validators参数:以列表的形式传参

5.2 钩子函数(HOOK)

# 钩子函数的定义:
  在特定的节点,自动触发完成响应操作

# Forms组件的钩子函数:    
  就类似于第二道关卡,
  都是基于检验成功的数据cleaned_data做操作 
  能够让我们自定义校验规则

    
# forms组件中有两类钩子
  在自定义的form类里面,书写方法即可
    
  1.局部钩子
    当你需要给单个字段增加校验规则的时候可以使用
    
  2.全局钩子
    当你需要给多个字段增加校验规则的时候可以使用


# 实际案例
  1.校验用户名中不能含有666	 只是校验username字段  局部钩子

  2.校验密码和确认密码是否一致	password confirm两个字段	全局钩子

5.2.1 局部钩子

# 局部钩子:
  1.定义函数名:'clean_' + '校验的字段名'
  2.函数内做数据校验处理
  3.必须返回校验的字段   不然后续获取不到
    
# 添加错误信息:
  方式一:self.add_error (推荐使用)
  方式二:raise ValidationError  (了解即可)


def clean_username(self):
    # 获取到用户名
    username = self.cleaned_data.get('username')
    if '666' in username:
        # 提示前端展示错误信息
        # 方式一:直接add_error('字段名', '错误信息') 
        self.add_error('username','光喊666是不行滴~')
        # 方式二: 抛出异常
        raise ValidationError('光喊666是不行滴~')  
        # 内部源码实际就是方式一,默认给'校验的字段名'  加错误信息
    
    return username # 将钩子函数钩去出来的数据再放回去

5.2.2 全局钩子

# 全局钩子  
  1.定义函数名:'clean'
  2.函数内做数据校验处理
  3.必须返回校验的所有字段   不然后续获取不到

    
def clean(self):
    password = self.cleaned_data.get('password')
    confirm_password = self.cleaned_data.get('confirm_password')
    if not confirm_password == password:
        # 方式一:直接add_error('字段名', '错误信息')
        self.add_error('confirm_password','两次密码不一致')
        # 方式二: 抛出异常
        raise ValidationError('两次密码不一致')  # 这种默认给'None'字段,添加错误信息
    
    return self.cleaned_data  # 将钩子函数钩出来的全部数据再放回去

6 其他参数

# 校验字段的其他参数:
label  # 字段文本描述信息 (通常是字段名)

error_messages  #  自定义报错信息

initial   #  默认值	 adj. 最初的

required  #  控制字段是否必填


validators  #   校验器  支持正则校验
  eg:
    from django.core.validators import RegexValidator
    validators=[
        RegexValidator(r'^[0-9]+$', '请输入数字'),
        RegexValidator(r'^159[0-9]+$', '数字必须以159开头')
    ]

    
widget  # 标签渲染样式      n. 装饰物;小机械;小部件

  # 渲染标签时,针对不同类型的input框 如何自定义样式   普通字段是没有样式的
    通过参数 widget,既可以修改input框的type类型,还可以操作标签的属性

  # eg:
    widget=forms.widgets.PasswordInput(attrs={'class':'form-control c1 c2'})
    # 多个属性值的话 直接空格隔开即可

6.1 input框其他类型渲染

# text		
  widget=forms.widgets.TextInput()
    
# password	
  widget=forms.widgets.PasswordInput()

# radio  圆圈选项(单选)
  gender = forms.ChoiceField(
      choices=((1, "男"), (2, "女"), (3, "保密")),
      label="性别",
      initial=3,
      widget=forms.widgets.RadioSelect()
  )
    
# select  下拉框
  hobby = forms.ChoiceField(
      choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
      label="爱好",
      initial=3,
      widget=forms.widgets.Select()
  )
    
# 多选select
  hobby1 = forms.MultipleChoiceField(
      choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
      label="爱好",
      initial=[1, 3],
      widget=forms.widgets.SelectMultiple()
  )
    
# 单选checkbox  打√复选框
  keep = forms.ChoiceField(
      label="是否记住密码",
      initial="checked",
      widget=forms.widgets.CheckboxInput()
  )
    
# 多选checkbox
  hobby2 = forms.MultipleChoiceField(
      choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
      label="爱好",
      initial=[1, 3],
      widget=forms.widgets.CheckboxSelectMultiple()
  )

7 forms组件源码解读

"""
切入点:
    form_obj.is_valid()   # 开始校验数据的入口
"""
# 顺序依次点进:
def is_valid(self):
    """ Returns True if the form has no errors. Otherwise, False. If errors are being ignored, returns False."""
    return self.is_bound and not self.errors
    # 如果is_valid要返回True的话 那么self.is_bound要为True 且self.errors要为Flase

    
self.is_bound = data is not None or files is not None   # 只要你传值了肯定为True


@property
def errors(self):
    """ Returns an ErrorDict for the data provided for the form """
    if self._errors is None:  # 内部定义:self._errors = none  所以肯定执行下面的 self.full_clean()
        self.full_clean()
    return self._errors

    
# forms组件所有的功能基本都出自于该方法(***逻辑核心***)
def full_clean(self):
    self._clean_fields()  # 校验字段 + 局部钩子 (看源码得出:局部钩子除了add_errors()可以添加错误信息,还可以通过抛出异常的形式:raise 异常)
    self._clean_form()  # 全局钩子
    self._post_clean()  
    
    
# forms组件源码执行流程
    form.is_valid()  # 开始执行 form对象的is_valid()方法 开始校验
    1.内部起了一个for循环,检验每个字段:
        1.1 先去校验该字段配置的规则
        1.2 再走该字段的局部钩子函数( clean_字段() )   
    2.最后走全局钩子( clean() )
    3.全部校验完成,self就会有clean_data和errors
    
# 流程-依次点入:
    1 form.is_valid()
    2 self.errors
    3 self.full_clean()
    4 self._clean_fields()  # 局部字段的校验(自己的和局部钩子)
        if hasattr(self, 'clean_%s' % name):
            func=getattr(self, 'clean_%s' % name)
            value = func()
            self.cleaned_data[name] = value  # 所以,这里是为什么局部钩子必须将 字段返回出来
        
      self._clean_form()  # 全局钩子
      self._post_clean()  # 源码,再预留了一个内部钩子,基本用不到
posted @ 2021-09-15 01:33  Edmond辉仔  阅读(32)  评论(0编辑  收藏  举报