約束(Constraints)
上一章介紹了向模型中新增一些業務邏輯的能力。我們現在可以將按鈕連結到業務程式碼，但如何防止使用者輸入錯誤的資料？例如，在我們的房地產模組中，沒有什麼可以阻止使用者設定負預期價格。
odoo提供了兩種設定自動驗證恆定式的方法：Python約束 and SQL約束。
SQL
參考：與此主題相關的文件可以檢視 Models 和PostgreSQL文件
我們透過模型屬性_sql_constraints來定義SQL約束，該屬性被賦值為一個包含三元組(name, sql_definition, message)的列表，其中name為一個合法的SQL約束名稱， sql_definition 為表約束表示式，message為錯誤訊息。
class AccountAnalyticDistribution(models.Model):
_name = 'account.analytic.distribution'
_description = 'Analytic Account Distribution'
_rec_name = 'account_id'
account_id = fields.Many2one('account.analytic.account', string='Analytic Account', required=True)
percentage = fields.Float(string='Percentage', required=True, default=100.0)
name = fields.Char(string='Name', related='account_id.name', readonly=False)
tag_id = fields.Many2one('account.analytic.tag', string="Parent tag", required=True)
_sql_constraints = [
('check_percentage', 'CHECK(percentage >= 0 AND percentage <= 100)',
'The percentage of an analytic distribution should be between 0 and 100.')
]
一個簡單的示例--唯一約束
class BlogTagCategory(models.Model):
_name = 'blog.tag.category'
_description = 'Blog Tag Category'
_order = 'name'
name = fields.Char('Name', required=True, translate=True)
tag_ids = fields.One2many('blog.tag', 'category_id', string='Tags')
_sql_constraints = [
('name_uniq', 'unique (name)', "Tag category already exists !"),
]
練習--新增SQL約束
新增以下約束到對應模型:
- 房產預期價格必須為正數
- 房產售價必須為正數
- 報價必須為正數
- 房產標籤名稱和型別名稱必須唯一
使用-u estate選項重新啟動伺服器以檢視結果。請注意，可能存在阻止設定SQL約束的資料。可能會彈出類似以下內容的錯誤訊息：
ERROR rd-demo odoo.schema: Table 'estate_property_offer': unable to add constraint 'estate_property_offer_check_price' as CHECK(price > 0)
例如，如果某些報價的價格為零，則無法應用約束。可以刪除、修正有問題的資料以應用新的約束。
修改odoo14\custom\estate\models\estate_property.py，新增SQL約束
_sql_constraints = [
('check_expected_price', 'CHECK(expected_price > 0)', 'expected price should be positive.'),
('check_selling_price', 'CHECK(selling_price > 0)', 'selling price should be positive.')
]
注意：當selling_price為null時，也透過CHECK(selling_price > 0)校驗的
修改odoo14\custom\estate\models\estate_property_tag.py，新增SQL約束
_sql_constraints = [('check_tag', 'unique(name)', 'Tag name must be unique !')]
修改odoo14\custom\estate\models\estate_property_type.py，新增SQL約束
_sql_constraints = [('check_name', 'unique(name)', 'Type name must be unique !')]
重啟服務驗證
預期效果動畫：https://www.odoo.com/documentation/14.0/zh_CN/_images/sql_01.gif
https://www.odoo.com/documentation/14.0/zh_CN/_images/sql_02.gif
Python
參考: 主題關聯文件可檢視constrains().
SQL約束是確保資料一致性的有效方法。然而，可能需要進行更復雜的檢查，這需要Python程式碼。在這種情況下，我們需要一個Python約束。
Python約束定義為用 constrains()修飾的方法，並在記錄集上呼叫。修飾符指定約束中涉及哪些欄位。當修改這些欄位中的任何欄位時，將自動計算約束。如果不滿足該方法的恆定式，則該方法將引發異常：
from odoo.exceptions import ValidationError
...
@api.constrains('date_end')
def _check_date_end(self):
for record in self:
if record.date_end < fields.Date.today():
raise ValidationError("The end date cannot be set in the past")
# all records passed the test, don't return anything
@api.constrains('quantity')
def check_quantity(self):
for quant in self:
if quant.location_id.usage != 'inventory' and quant.lot_id and quant.product_id.tracking == 'serial' \
and float_compare(abs(quant.quantity), 1, precision_rounding=quant.product_uom_id.rounding) > 0:
raise ValidationError(_('The serial number has already been assigned: \n Product: %s, Serial Number: %s') % (quant.product_id.display_name, quant.lot_id.name))
練習--新增Python約束
新增售價不能低於預期價格90%的約束
提示: 報價生效前，保持售價為0。你需要對校驗進行微調，以便把這個考慮在內。
警告
當和浮點數打交道時，總是使用從
odoo.tools.float_utils匯入的float_compare()和float_is_zero()方法
確保每次售價或者預期價格改變時，自動觸發約束
修改odoo14\custom\estate\models\estate_property.py
匯入 ValidationError
from odoo.exceptions import ValidationError
最末尾新增以下程式碼
@api.constrains('selling_price', 'expected_price')
def _check_selling_price(self):
for record in self:
if record.selling_price < self.expected_price * 0.9:
raise ValidationError("selling price can`t not lower then 90 percent of expected price")
重啟服務，瀏覽器中驗證
預期效果動畫：https://www.odoo.com/documentation/14.0/zh_CN/_images/python.gif
SQL約束通常比Python約束更效率。當效能很重要時，總是首選SQL約束而不是Python約束。