一個非常實用的小方法
試想一下,Django中如果我們想對保存進數據庫的數據做校驗,有哪些實現的方法?
我們可以在view中去處理,每當view接收請求,就對提交的數據做校驗,校驗不通過直接返回錯誤,不寫數據庫,校驗通過再調用create
或update
方法寫入數據庫
以上方式比較簡單,容易理解,但隨之又帶來了麻煩,我們需在所有接收數據的地方都要去校驗,那么有沒有更加優雅的方式呢?如果你看過我之前的文章『Django使用Signals監測model字段變化發送通知』]就能想到可以通過signals信號來處理,添加一個pre_save
的信號,每當數據庫數據變更前都會觸發pre_save
方法,可以在這里進行校驗,免去了view中多個地方校驗的麻煩
而今天要說的並不是signals,而是另一種比較常用的做法:重寫model的save方法
重寫save方法
save方法的主要作用就是將一個對象保存到數據庫。如果我們想在數據入庫之前做一些處理,除了上邊提到的signals
之外,還可以通過重寫save方法來實現。具體實現方式看下面這個例子
假如我們定義了model如下:
class TempTask(models.Model):
...
exechost = models.CharField(max_length=64, default='localhost', verbose_name='執行主機')
execuser = models.ForeignKey(ExecUser, null=True, on_delete=models.PROTECT, db_constraint=False)
exechost默認為Localhost,execuser默認為空,現有需求:當exechost不為localhost時,他必須符合ip:port
的格式,且execuser不能為空。這是一個比較復雜的校驗方式,我們可以通過重寫save方法來處理
class TempTask(models.Model):
...
def save(self, *args, **kwargs):
if self.exechost and (self.exechost.strip() != 'localhost'):
if len(self.exechost.split(':')) != 2:
raise ValidationError('執行主機格式錯誤,應為ip:port格式')
if not self.execuser:
raise ValidationError('當執行主機存在時執行用戶不能為空')
super().save(*args, **kwargs)
我們可以在save函數內執行各種自定義邏輯,但需要注意的是,最后必須要調用super().save()
方法來保證執行了父類的save()
,這樣才能保證數據寫入了數據庫。
這樣在當我們執行create語句插入數據的時候就會先去執行save中的校驗方法進行校驗了
TempTask.objects.create(**postdata)
update踩坑
就當我以為一切都要結束准備起身沖杯咖啡的時候,我發現新加數據可以正常進行校驗,但更新數據卻不行,更新的代碼如下:
TempTask.objects.filter(id=pk).update(**postdata)
經過一番查找發現了問題所在,官方文檔中有這么一句話
Unfortunately, there isn’t a workaround when creating or updating objects in bulk, since none of save(), pre_save, and post_save are called.
也就是說,當使用查詢集批量更新對象時,將不會為每個對象調用save()方法,連pre_save
和post_save
也不會被調用。與save()
類似的還有model的delete()
方法,當批量刪除的時候,同樣不會調用model的delete()
方法,但delete是可以使用pre_delete
或post_delete
信號的
解決這個問題的方法很簡單,那就是將更新的代碼換成下邊這種,保證調用到save方法
_t = TempTask.objects.get(id=pk)
_t.__dict__.update(**postdata)
_t.save()