上一節我們講完了ModelAdmin的使用, 但是在操作中也發現, 新增編輯會員時, 我們無法驗證數據是否正確, 比如
- 用戶名、手機號、郵箱都應該是唯一的
- 用戶名和密碼長度的驗證
- 編輯用戶信息時不填寫密碼則不更新密碼, 填寫了則更新密碼
- 自定義驗證不通過的文案
...
這些要求, 我們就必須得使用自定義的表單來完成了
項目地址:https://gitee.com/ccnv07/django_example
Form介紹
通過表單, 我們可以實現以下的功能
- 自定義字段的樣式
- 類似的表單可以通過類繼承減少代碼量
- 完成自定義的表單數據驗證
定義表單字段
關於表單的代碼我們一般放在每個模塊的forms.py中
表單字段類型說明
CharField
單行文本輸入字段, 對應模型的CharField字段
表單中的樣式就是input type=textmax_length: 最大長度min_length: 最小長度strip: 是否過濾左右的空格empty_value: 爲空時的值, 默認是空字符串
EmailField
郵箱輸入文本字段, 對應模型的EmailField字段
標案中是input type=text
但是會自動增加一個郵箱格式的校驗
ChoiceField
下拉單選字段, 這個在模型中是沒有的
對應表單的select標籤choices參數也是二維元組的格式
BooleanField
選擇字段, 對應表單中的checkbox
DateField
日期選擇字段input_formats: 定義時間格式, 默認是:
['%Y-%m-%d', # '2006-10-25'
'%m/%d/%Y', # '10/25/2006'
'%m/%d/%y'] # '10/25/06'DateTimeField
日期時間字段, 同DateField
TimeField
時間字段, 同DateField
DecimalField
十進制數字字段max_value: 最大值min_value: 最小值max_digits: 前置0被去除後的最大位數decimal_places: 允許的小數位的長度
FileField
文件上傳字段
IntegerField
整數字段max_value: 最大值min_value: 最小值
剩下還有很多表單字段類型, 在之後的教程中再繼續介紹， 目前這些, 就算是比較常見的字段了
通過介紹以後, 大家發現, 我沒說最常見的PasswordField, 其實django的表單中就沒有這個字段類型, 那麼, 如何實現密碼字段呢?
password = forms.CharField(widget=forms.PasswordInput(),max_length=12,min_length=6, strip=True,
help_text='編輯時爲空則不更改密碼')通過制定widget參數爲forms.PasswordInput(), 就可以實現密碼字段了
所以其實並不是Form類來規定表單字段的類型, 而是widget來實現的表單字段的類型, 對於每種表單字段的類型, django都有對應的模板, 通過字段的參數, 生成對應的html代碼
表單字段的通用參數
label: 表單字段的label標籤的名稱widget: 指定此字段採用的字段樣式類型help_text: 字段的幫助文本
表單的Meta 元類
只有ModelForm纔有元類, Form是不需要元類的
以下是一個元類的例子
from django.forms import ModelForm
class Meta:
model = Account
# 使用自定義的Form, 就必須指定fields or exclude屬性, 否則報錯
fields = ('account', 'password', 'email', 'phone', 'status')
error_messages = {
NON_FIELD_ERRORS: {
'unique_together': "%(model_name)s's %(field_labels)s are not unique.",
}
}model: 指定ModelForm綁定的模型fields: 指定後臺新增編輯時要顯示的字段error_messages: 指定通用的錯誤信息文案
其他還有一些複雜的操作, 會在之後的教程中詳細講解。現在我們的一個表單就完成了
將表單綁定到ModelAdmin中
但是如果想讓表單在後臺中生效, 就需要把表單綁定到ModelAdmin上
from django.contrib import admin
from .forms import AccountForm
@admin.register(Account)
class AccountAdmin(admin.ModelAdmin):
form = AccountForm在ModelAdmin中指定form參數, 就可以把表單綁定上去了。 點擊新增/編輯頁面, 也就可以看到表單生效了
表單數據的驗證
接下來, 我們就需要完成表單提交數據以後的驗證的方法了
其實在定義表單字段時, 我們就已經完成了一部分的驗證了
比如
account = forms.CharField(
required=True, error_messages={
'required': '請輸入用戶名',
}, label='用戶名')就定義了account字段必須填寫, 如果出錯則返回“請輸入用戶名”的提示
但是這個並不能完成我們所有的驗證, 所以我們也可以根據字段進行自定義的驗證
比如, 我要實現account用戶名字段是唯一的
from django import forms
from django.core.exceptions import ValidationError
from .models import Account
class AccountForm(forms.ModelForm):
...省略代碼
def clean_account(self):
_info = Account.objects.filter(account=self.cleaned_data['account'],
is_deleted=0).values('id')
if _info:
raise ValidationError('用戶已存在')
return self.cleaned_data['account']當我們執行form.is_valid()方法進行驗證時, django的form類會依次執行clean_字段名的自定義驗證方法, 如果有拋出異常(raise ValidationError('用戶已存在')), 則中斷並返回錯誤, 否則讀取到clean_字段名的方法的返回值, 並且寫入到cleaned_data這個字典中
根據同樣的方法, 我們也可以寫出來對email和phone字段的驗證
在ModelAdmin操作Form
以上已經基本能實現我們的功能了, 但是在後臺的操作中, 新增和編輯用的是同一個表單, 如果我們需要針對新增和編輯的不同場景, 進行一些不同的操作, 就比較麻煩了。
所以我們需要通過在ModelAdmin中, 對Form進行一定的操作, 似的Form可以完成更多的判斷
# account/admin.py
class AccountAdmin(admin.ModelAdmin):
def get_form(self, request, obj=None, **kwargs):
form = super(AccountAdmin, self).get_form(request, obj=obj, **kwargs)
# obj 保存的是models.Account的信息
# 根據是否有pk, 來賦予form不同的場景, 根據不同的場景可以進行不同的驗證
if (obj is not None):
form.id = obj.pk
form.scene = 'update'
else:
form.scene = 'insert'
return formget_form方法的參數request保存的是HttpRequest操作對象
而obj是當前操作的數據模型對象(Model), 而且在新增的操作時, obj是None, 只有在編輯時, 才存在obj
form = super(AccountAdmin, self).get_form(request, obj=obj, **kwargs) 會返回當前操作的form對象
如果obj不是None, 則當前操作是編輯, 我們就可以給form增加一個自定義的屬性scene(場景) = 'update', 否則就是新增
並且我們在Form表單中, 可以針對不同的場景, 進行不同的驗證判斷
# account/forms.py
class AccountForm(forms.ModelForm):
def clean_account(self):
# 自動驗證account字段
if self.scene == 'insert':
_info = Account.objects.filter(
account=self.cleaned_data['account'],
is_deleted=0).values('id')
elif self.scene == 'update':
_info = Account.objects.filter(~Q(id=self.id) & Q(
account=self.cleaned_data['account']) & Q(
is_deleted=0)).values('id')
if _info:
raise ValidationError('用戶已存在')
return self.cleaned_data['account']這個驗證的意思是, 如果當前場景(self.scene)是insert, 就只按照account查詢, 如果是update, 則增加id不爲當前操作id的過濾條件
Django的密碼加密方法
django.contrib.auth.hashers 有兩個關於密碼加密的操作方法
make_password和check_password
make_password 是將指定的明文密碼加密
check_password 是校驗給出的明文密碼是否正確
新增與編輯操作下密碼框的不同操作
當新增用戶時, 密碼框必填, 當編輯時, 密碼框非必填。如果填了, 則修改密碼, 如果沒填, 則不更改密碼
第一步, 我們在校驗輸入的密碼時, 同時也需要實現對密碼的加密(畢竟數據庫被人破解了, 後臺還是很嚴重的)
from django import forms
class AccountForm(forms.ModelForm):
def clean_password(self):
# 自動驗證密碼字段
if self.scene == 'insert':
if not self.cleaned_data['password']:
raise ValidationError('請輸入密碼')
elif self.scene == 'update':
if not self.cleaned_data['password']:
return None
else:
return self.cleaned_data['password']
return make_password(self.cleaned_data['password'])這個也很好理解, 如果新增用戶時, 未輸入密碼, 則返回錯誤
更新時沒有輸入密碼, 則返回None
如果輸入, 就返回make_password加密後的密碼字符串
根據之前教程的scene場景參數的指定, 就可以跟容易的實現這個功能, 但是在編輯時, 如果密碼爲空不填的話, 密碼居然也會被設置爲空。
這個是因爲, 如果不填寫密碼, 的model對象會把password=None一直帶着, 轉換爲sql執行時, 就變成password=''了
所以, 如果password沒有輸入值, 我們就要在執行保存之前, 幹掉model攜帶的password, 這樣才正確。
重寫ModelAdmin的保存方法
class AccountAdmin(admin.ModelAdmin):
def save_model(self, request, obj, form, change):
if form.cleaned_data['password'] is None:
del obj.password
super().save_model(request, obj, form, change)form.cleaned_data中就是表單提交後驗證過的數據, 如果password是None, 就del掉, 然後調用父類的save_model方法, 繼續執行保存操作。