odoo17 | 计算字段和更改事件

前言

模型之间的关系是任何Odoo模块的关键组成部分。它们是任何业务案例建模所必需的。然而，我们可能希望给定模型中的字段之间存在链接。有时一个字段的值是由其他字段的值决定的，而有时我们希望帮助用户进行数据输入。

这些案例得到了计算字段和onchanges概念的支持。虽然本章在技术上并不复杂，但这两个概念的语义非常重要。这也是我们第一次编写Python逻辑。到目前为止，除了类定义和字段声明之外，我们还没有编写任何内容。

计算字段

目标

• 在房地产模型中，应计算总面积和最佳报价
  
• 在房地产报价模型中，应计算并更新有效期
  
  在我们的房地产模块中，我们定义了生活区和花园区。因此，将总面积定义为这两个字段的总和是很自然的。我们将使用计算字段的概念，即给定字段的值将根据其他字段的值计算得出。

到目前为止，字段都是直接存储在数据库中并直接从数据库中检索的。字段也可以被计算。在这种情况下，字段的值不是从数据库中检索的，而是通过调用模型的方法动态计算的。

要创建计算字段，请创建一个字段并将其属性计算设置为方法的名称。计算方法应为 self 中的每个记录设置计算字段的值。

按照惯例，计算方法是私有的，这意味着它们不能从表示层调用，只能从业务层调用。私有方法有一个以下划线 _ 开头的名称。

依赖

计算字段的值通常取决于计算记录中其他字段的值。ORM希望开发人员使用装饰器 depends()在计算方法上指定这些依赖关系。给定的依赖关系由ORM使用，以便在修改了某些依赖关系时触发字段的重新计算：

from odoo import api, fields, models

class TestComputed(models.Model):
    _name = "test.computed"

    total = fields.Float(compute="_compute_total")
    amount = fields.Float()

    @api.depends("amount")
    def _compute_total(self):
        for record in self:
            record.total = 2.0 * record.amount

注意
self 是一种集合。

对象self是一个记录集，即一个有序的记录集合。它支持集合上的标准Python操作，例如len(self)和iter(self)，以及额外的集合操作，如recs1|recs2。

遍历self会逐个给出记录，其中每个记录本身都是大小为1的集合。您可以使用点符号
访问/分配 单个记录上的字段，例如 record.name。

更多示例代码

    @api.depends('full_reconcile_id.name', 'matched_debit_ids', 'matched_credit_ids')
    def _compute_matching_number(self):
        for record in self:
            if record.full_reconcile_id:
                record.matching_number = record.full_reconcile_id.name
            elif record.matched_debit_ids or record.matched_credit_ids:
                record.matching_number = 'P'
            else:
                record.matching_number = None

    @api.depends('debit', 'credit')
    def _compute_balance(self):
        for line in self:
            line.balance = line.debit - line.credit

对于关系字段，可以使用通过字段的路径作为依赖项：

• Many2one

description = fields.Char(compute="_compute_description")
partner_id = fields.Many2one("res.partner")

@api.depends("partner_id.name")
def _compute_description(self):
    for record in self:
        record.description = "Test for partner %s" % record.partner_id.name

• Many2many & One2many.

line_ids = fields.One2many('account.reconcile.model.line', 'model_id')
show_decimal_separator = fields.Boolean(compute='_compute_show_decimal_separator', help="决定是否应该显示正则表达式匹配字段的小数分隔符的技术字段。")
@api.depends('line_ids.amount_type')
    def _compute_show_decimal_separator(self):
        for record in self:
            record.show_decimal_separator = any(l.amount_type == 'regex' for l in record.line_ids)

Inverse 反函数/逆向方法

您可能已经注意到，默认情况下计算字段是只读的。这是意料之中的，因为用户不应该设置值。

在某些情况下，仍然可以直接设置一个值。在我们的房地产例子中，我们可以为报价定义一个有效期并设置一个有效日期。我们希望能够设置一个影响另一个的持续时间或日期。

为了支持这一点，Odoo提供了使用Inverse 反函数的能力。

from odoo import api, fields, models

class TestComputed(models.Model):
    _name = "test.computed"

    total = fields.Float(compute="_compute_total", inverse="_inverse_total")
    amount = fields.Float()

    @api.depends("amount")
    def _compute_total(self):
        for record in self:
            record.total = 2.0 * record.amount

    def _inverse_total(self):
        for record in self:
            record.amount = record.total / 2.0

计算方法设置字段，而反函数/逆向方法设置字段的依赖关系。

请注意，在保存记录时调用反函数/逆向方法，而在每次更改其依赖关系时调用计算方法。

其他信息

默认情况下，计算字段不会存储在数据库中。因此，除非定义了搜索方法，否则无法在计算字段上进行搜索。此主题超出了本培训的范围，因此我们不会涉及。可以在此处找到示例。

 is_ongoing = fields.Boolean('Is Ongoing', compute='_compute_is_ongoing', search='_search_is_ongoing')

另一种解决方案是使用store=True属性存储字段。虽然这通常很方便，但要注意给模型增加的潜在计算负载。让我们重新使用我们的例子

description = fields.Char(compute="_compute_description", store=True)
partner_id = fields.Many2one("res.partner")

@api.depends("partner_id.name")
def _compute_description(self):
    for record in self:
        record.description = "Test for partner %s" % record.partner_id.name

每次更改合作伙伴名称时，都会自动重新计算所有引用它的记录的描述！当数百万条记录需要重新计算时，这很快就会变得难以实现。

值得注意的是，一个计算字段可以依赖于另一个计算字段。ORM足够智能，可以按正确的顺序重新计算所有依赖关系……但有时会以性能下降为代价。

一般来说，在定义计算字段时，必须始终牢记性能。计算字段越复杂（例如，具有大量依赖关系或计算字段依赖于其他计算字段），计算所需的时间就越长。始终花一些时间提前评估计算字段的成本。大多数时候，只有当你的代码到达生产服务器时，你才会意识到它减慢了整个过程。

Onchanges 更改

目标：

• 启用花园将设置默认区域 10 和 朝向北方。
  
  在我们的房地产模块中，我们还想帮助用户进行数据输入。当“garden”字段被设置时，我们想为garden area和orientation提供一个默认值。此外，当“garden”字段未设置时，我们希望garden area重置为零，方向被删除。在这种情况下，给定字段的值会修改其他字段的值。

“onchange”机制为客户端界面提供了一种更新表单的方法，当用户填写字段值时，无需将任何内容保存到数据库。为此，我们定义了一个方法，其中self表示表单视图中的记录，并用onchange()装饰它，以指定它是由哪个字段触发的。您对self所做的任何更改都会反映在表单上：

from odoo import api, fields, models

class TestOnchange(models.Model):
    _name = "test.onchange"

    name = fields.Char(string="Name")
    description = fields.Char(string="Description")
    partner_id = fields.Many2one("res.partner", string="Partner")

    @api.onchange("partner_id")
    def _onchange_partner_id(self):
        self.name = "Document for %s" % (self.partner_id.name)
        self.description = "Default description for %s" % (self.partner_id.name)

在这个例子中，更改合作伙伴也会更改名称和描述值。之后是否更改名称和描述值由用户决定。另请注意，我们不会在self上循环，这是因为该方法仅在表单视图中触发，其中self始终是单个记录。

其他信息

Onchanges 方法还可以返回非阻塞警告消息

    @api.onchange('provider', 'check_validity')
    def onchange_check_validity(self):
        if self.provider == 'authorize' and self.check_validity:
            self.check_validity = False
            return {'warning': {
                'title': _("Warning"),
                'message': ('This option is not supported for Authorize.net')}}

如何使用它们？

对于计算字段和onchanges的使用没有严格的规定。

在许多情况下，计算字段和onchanges都可以用来实现相同的结果。总是首选计算字段，因为它们也在表单视图上下文之外触发。永远不要使用onchanges向模型添加业务逻辑。这是一个非常糟糕的想法，因为通过编程方式创建记录时，onchanges不会自动触发；它们只在表单视图中触发。

计算字段和onchanges的常见陷阱是试图通过添加过多的逻辑来变得“过于智能”。这可能会产生与预期相反的结果：最终用户对所有自动化感到困惑。

计算字段往往更容易调试：这样的字段是由给定的方法设置的，因此很容易跟踪值的设置时间。另一方面，onchanges可能会令人困惑：很难知道onchanges的范围。由于几个onchanges方法可能会设置相同的字段，因此很容易难以跟踪值的来源。

使用存储的计算字段时，请密切关注依赖关系。当计算字段依赖于其他计算字段时，更改一个值可能会触发大量的重新计算。这会导致性能不佳。

在下一章中，我们将看到如何在单击按钮时触发一些业务逻辑。