【odoo】常用的odoo修饰器

概要

        浅谈odoo模型方法中常用的修饰器 ==>@api.model、@api.onchange、@api.depends、@api.constrains

使用场景

@api.model：这个修饰器用于定义模型的静态方法。它适用于不需要访问特定记录的方法，例如对模型的查询或计算。

 tip：常用于前端通过api访问模型方法。

from odoo import models, fields, api

class DemoModel(models.Model):
    _name = 'demo.model'

    name = fields.Char(string='Name', required=True)
    value = fields.Integer(string='Value')

    @api.model
    def get_total_records(self):
        return len(self.search([]))

@api.onchange：这个修饰器用于定义字段值改变时触发的动作。当指定字段的值发生变化时，被修饰的方法将被自动执行。

Tip：修饰器填写的为需要监听变动的字段名。

from odoo import models, fields, api

class DemoModel(models.Model):
    _name = 'demo.model'

    name = fields.Char(string='Name', required=True)
    value = fields.Integer(string='Value')

    @api.onchange('value')
    def onchange_value(self):
        if self.value < 0:
            self.value = 0

@api.depends：这个修饰器用于定义计算字段或存储字段的依赖关系。当依赖字段的值发生变化时，被修饰的方法将被重新计算或重新执行。

Tip：这里有两种方式

==>存在依赖字段时，依赖字段发生变化时会触发，字段被第一次安装时会触发。

==>不存在依赖字段，当记录发生增删改成时都会触发。

from odoo import models, fields, api

class DemoModel(models.Model):
    _name = 'demo.model'

    name = fields.Char(string='Name', required=True)
    value = fields.Integer(string='Value')

    value_percentage = fields.Float(string='Value Percentage', compute='_compute_value_percentage')
    new_value = fields.Integer(string='NewValue', compute='_compute_new_value')

    @api.depends('value')
    def _compute_value_percentage(self):
        for record in self:
            record.value_percentage = record.value * 0.1


    def _compute_new_value(self):
        for record in self:
            record.new_value = record.value * 0.2

@api.constrains：这个修饰器用于定义约束条件。当模型的数据不符合指定的约束条件时，被修饰的方法将会触发异常。

Tip：在odoo系统中，一般在点击保存的时候触发。

from odoo import models, fields, api

class DemoModel(models.Model):
    _name = 'demo.model'

    name = fields.Char(string='Name', required=True)
    value = fields.Integer(string='Value')

    @api.constrains('value')
    def _check_value(self):
        for record in self:
            if record.value < 0:
                raise ValueError('Value cannot be negative!')

小结

         odoo基本围绕这几个修饰器进行模型方法逻辑构造，以上几个修饰器在odoo14，odoo15，odoo16，odoo17均存在。如果原生修饰器无法满足，也可自己进行自定义修饰器（常用于对外部接口的方法封装）。