ModelForm

ModelForm

Model可以理解为数据库，Form是Form组建， ModelForm一个Form组建的扩展类，可直接关联Model， 也就是说会有强耦合。但是用起来简单哇

举个栗子

先直接看例子吧

model.py

class User(models.Model):
    """用户信息表"""
    user = models.CharField(max_length=32, verbose_name='用户名')  # 用户名
    pwd = models.CharField(max_length=32, verbose_name='密码')  # 密码

    def __str__(self):
        return self.user

    class Meta:
        verbose_name_plural = "用户表"

很简单的创建了一个用户信息表

view.py

class UserForm(ModelForm):
    class Meta:
        model = User
        fields = '__all__'
        labels = {
            'user': '用户名',
            'pwd': '密码',
            'role': '角色'
        }
        widgets = {
            'user': widgets.TextInput(attrs={'class': 'form-control'}),
            'pwd': widgets.PasswordInput(attrs={'class': 'form-control'}),
            'role': widgets.SelectMultiple(attrs={'class': 'form-control'})
        }

        error_messages = {
            'user': {
                'required': '用户名不能为空',
            },
            'pwd': {
                'required': '密码不能为空',
            },
            'role': {
                'required': '角色不能为空',
            }
        }


# 查
def user(request):
    """显示用户页面"""
    user_list = User.objects.all()
    path = Path(request)
    return render(request, 'user.html', {'data_list': user_list, 'path': path})


# 增
def add_user(request):
    """添加用户页面"""
    userform = UserForm(request.POST)
    if request.method == 'POST':
        if userform.is_valid():
            userform.save()
            return redirect('rbac:user')
        else:
            return render(request, 'change_data.html', {'dataform': userform, 'error': userform.errors})
    userform.errors.clear()
    return render(request, 'change_data.html', {'dataform': userform})
    # pass


# 删
def del_user(request, nid):
    """删除用户页面"""
    User.objects.filter(pk=nid).first().delete()
    return redirect('rbac:user')


# 改
def edit_user(request, nid):
    """修改用户页面"""
    user_obj = User.objects.filter(pk=nid).first()
    if request.method == 'POST':
        userform = UserForm(request.POST, instance=user_obj)
        if userform.is_valid():
            userform.save()
            return redirect('rbac:user')
        else:
            return render(request, 'change_data.html', {'dataform': userform, 'error': userform.errors})
    userform = UserForm(instance=user_obj)

    return render(request, 'change_data.html', {'dataform': userform})

html

<form method="POST" action="" class="form-horizontal" novalidate>
  {% csrf_token %}

  {% for data in dataform %}
  <div class="form-group">
    <label class="col-sm-2 control-label" for="{{ data.id_for_label }}">{{ data.label }}</label>
    <div class="col-sm-10">{{ data }}</div>
    <span class="error pull-right">{{ data.errors }}</span>
  </div>
  {% endfor %}

  <input type="submit" value="提交" class="btn btn-info col-md-offset-2 col-md-10"/>
</form>

可以发现：使用ModelForm组建进行校验是十分的简单

具体功能

ModelForm组件

ModelForm
    a.  class Meta:
            model,                           # 对应Model的
            fields=None,                     # 字段
            exclude=None,                    # 排除字段
            labels=None,                     # 提示信息
            help_texts=None,                 # 帮助提示信息
            widgets=None,                    # 自定义插件
            error_messages=None,             # 自定义错误信息（整体错误信息from django.core.exceptions import NON_FIELD_ERRORS）
            field_classes=None               # 自定义字段类 （也可以自定义字段）
            localized_fields=('birth_date',) # 本地化，如：根据不同时区显示数据
            如：
                数据库中
                    2016-12-27 04:10:57
                setting中的配置
                    TIME_ZONE = 'Asia/Shanghai'
                    USE_TZ = True
                则显示：
                    2016-12-27 12:10:57
    b. 验证执行过程
        is_valid -> full_clean -> 钩子 -> 整体错误

    c. 字典字段验证
        def clean_字段名(self):
            # 可以抛出异常
            # from django.core.exceptions import ValidationError
            return "新值"
    d. 用于验证
        model_form_obj = XXOOModelForm()
        model_form_obj.is_valid()
        model_form_obj.errors.as_json()
        model_form_obj.clean()
        model_form_obj.cleaned_data
    e. 用于创建
        model_form_obj = XXOOModelForm(request.POST)
        #### 页面显示，并提交 #####
        # 默认保存多对多
            obj = form.save(commit=True)
        # 不做任何操作，内部定义 save_m2m（用于保存多对多）
            obj = form.save(commit=False)
            obj.save()      # 保存单表信息
            obj.save_m2m()  # 保存关联多对多信息

    f. 用于更新和初始化
        obj = model.tb.objects.get(id=1)
        model_form_obj = XXOOModelForm(request.POST,instance=obj)
        ...

        PS: 单纯初始化
            model_form_obj = XXOOModelForm(initial={...})

为什么modelForm里也能做验证？

form里面有is_valid，cleaned_data，errors，

# Form验证：
    UserInfoForm -> Form -> BaseForm( 包含is_valid等方法)

# ModelForm验证：
    UserInfoModelForm -> ModelForm -> BaseModelForm -> BaseForm

ModelForm 数据库操作

1.1、创建数据save

如果数据验证是ok的，那么save，就直接在数据库中创建完数据了

if obj.is_valid():
    obj.save()      # 创建数据12

在如下一对多、多对多关系中：

class UserType(models.Model):
    caption = models.CharField(max_length=32)

class UserGroup(models.Model):
    name = models.CharField(max_length=32)

class UserInfo(models.Model):
    username = models.CharField(max_length=32)
    email = models.EmailField()
    user_type = models.ForeignKey(to='UserType',to_field='id')
    u2g = models.ManyToManyField(UserGroup)1234567891011

这样的话，执行上面的obj.save()会在UserInfo表和多对多关系表里都增加数据。

views.py

def index(request):
    if request.method == "GET":
        obj = UserInfoModelForm()
        return render(request,'index.html',{'obj': obj})
    elif request.method == "POST":
        obj = UserInfoModelForm(request.POST)
        if obj.is_valid():
            obj.save()  # 等价以下三句
            # instance = obj.save(False)
            # instance.save()
            # obj.save_m2m()
        return render(request,'index.html',{'obj': obj})123456789101112

1.2、save 做了哪些操作？

save源码里：

def save(self, commit=True):
    """"""
    if commit:
        self.instance.save()    # 指的当前model对象
        self._save_m2m()        # 指：保存m2m对象
    else:
        self.save_m2m = self._save_m2m
    return self.instance    # model 类的对象
    """"""123456789

所以instance = obj.save(False)时，什么都不会操作。

if obj.is_valid():
    instance = obj.save(False)
    instance.save()     # 当前对象表数据创建
    obj.save_m2m()      # 多对多表数据创建
    # 上面这三句完成的是和上面 obj.save 一样的操作。拆开就可以自定制操作了12345

2、修改数据

修改表数据是，记得把instance信息也传进去，不然是新建数据，而不是对某行数据进行修改。

编辑用户信息，新url方式保留默认数据

urls.py

    url(r'^user_list/', views.user_list),
    url(r'^edit-(\d+)/', views.user_edit),12

views.py

def user_list(request):
    li = models.UserInfo.objects.all().select_related('user_type')  # 这里只能是外键，多对多字段也不可以
    return render(request,'user_list.html',{'li': li})

def user_edit(request, nid):
    # 获取当前id对象的用户信息
    # 显示用户已经存在数据
    if request.method == "GET":
        user_obj = models.UserInfo.objects.filter(id=nid).first()
        mf = UserInfoModelForm(instance=user_obj)   # 把默认数据传递进去
        return render(request,'user_edit.html',{'mf': mf, 'nid': nid})
    elif request.method == 'POST':
        # 数据修改的信息，给数据库的哪一行做修改？
        user_obj = models.UserInfo.objects.filter(id=nid).first()
        mf = UserInfoModelForm(request.POST,instance=user_obj)  # 指定给谁做修改
        if mf.is_valid():
            mf.save()
        else:
            print(mf.errors.as_json())
        return render(request,'user_edit.html',{'mf': mf, 'nid': nid})1234567891011121314151617181920

user_list.html

<body>
    <ul>
        {% for row in li %}
            <li>{{ row.username }} - {{ row.user_type.caption }} - <a href="/edit-{{ row.id }}/">编辑</a></li>
        {% endfor %}
    </ul>
</body>1234567

user_edit.html

<body>
    <form method="POST" action="/edit-{{ nid }}/">
        {% csrf_token %}
    {{ mf.as_p }}
        <input type="submit" value="提交" />
    </form>
</body>

ModelForm钩子、额外字段

数据验证钩子

从上面的Form和ModelForm中，他们都是继承了BaseForm，而is_valid是在BaseForm中定义的，所以ModelForm也能和Form一样使用各种钩子

额外字段

像网页上的checkbox，一个月内免登陆，用提交到数据库么？这个只需要设置session和cookie就可以了。

views.py

class UserInfoModelForm(forms.ModelForm):

    is_rmb = fields.CharField(widget=widgets.CheckboxInput())  # 额外字段

    class Meta:
        model = models.UserInfo
        fields = '__all__'1234567

6、总结

    1. 生成HTML标签：class Meta: ...
    2. mf = xxxModelForm(instance=ModelObj) 生成默认值
    3. 额外的标签， is_rmb = Ffields.CharField(widget=Fwidgets.CheckboxInput())
    4. 各种验证 is_valid() -> 各种钩子...
    5.  mf.save()
        # 或
        instance = mf.save(False)
        instance.save()
        mf.save_m2m()123456789

ModelForm因为model和form耦合太密切，所以一般写小程序用它。