在Odoo中,添加模型约束验证是一种确保数据一致性和业务规则执行的常用方法。约束可以是SQL约束或Python约束。SQL约束用于数据库级别的限制,比如唯一性(UNIQUE)约束;而Python约束则允许实现更复杂的逻辑判断。
Python约束
Python约束通过在模型中使用api.constrains
装饰器来实现。这种方法允许你在数据写入数据库之前,执行自定义的Python代码来检查数据是否满足特定条件。
代码示例
假设我们有一个名为sale.order
的Odoo模型,并且我们想要确保订单的date_order
(订单日期)不晚于date_confirm
(确认日期)。
首先,你需要从odoo
导入api
和models
。
from odoo import models, fields, api
from odoo.exceptions import ValidationError
然后,定义你的模型类并且添加约束:
class SaleOrder(models.Model):
_inherit = 'sale.order'
date_order = fields.Datetime('Order Date')
date_confirm = fields.Datetime('Confirmation Date')
@api.constrains('date_order', 'date_confirm')
def _check_dates(self):
for record in self:
if record.date_order and record.date_confirm and record.date_order > record.date_confirm:
raise ValidationError("The order date must be earlier than the confirmation date.")
解析
@api.constrains('date_order', 'date_confirm')
: 这行代码是一个装饰器,它告诉Odoo当date_order
或date_confirm
字段发生变化时,应该触发_check_dates
函数。_check_dates
函数遍历当前记录集(在大多数情况下可能只包含一个记录),并对每一条记录进行检查。- 如果订单日期晚于确认日期,则抛出一个
ValidationError
异常,Odoo会捕获这个异常并将其展示给用户,作为一个警告信息。
SQL 约束
SQL约束是在模型定义中通过_sql_constraints
类属性来添加的。它允许你直接在数据库层面强制执行数据完整性规则。
代码示例
假设我们要为sale.order
模型的order_reference
字段添加一个唯一性约束。
class SaleOrder(models.Model):
_inherit = 'sale.order'
order_reference = fields.Char("Order Reference")
_sql_constraints = [
('order_reference_unique', 'UNIQUE(order_reference)', "The order reference must be unique."),
]
解析
_sql_constraints
是一个列表,其中的每一个元组定义了一个SQL约束。- 每个元组包含三个元素:约束名、约束类型和定义(在这个例子中是
UNIQUE(order_reference)
),以及违反约束时显示的错误信息。 - 当尝试插入或更新违反此约束的记录时,数据库将拒绝操作,并显示相应的错误信息。