Odoo 16：在表单视图中动态修改树视图属性的可靠方法

本教程旨在解决 odoo 16 中，在表单视图内基于当前记录动态调整树视图属性（如分页限制）的问题。针对 `get_view()` 方法中 `active_id` 上下文可能不准确的情况，本文详细阐述了如何通过 `self.env.context['params'].get('id')` 确保获取正确的记录 id，从而实现视图的个性化定制，并提供完整的代码示例及实现步骤。

引言：Odoo 动态视图修改的需求

在 Odoo 开发中，有时我们需要根据当前表单记录的特定数据来动态调整其内部的树视图（Tree View）属性，例如设置不同的分页限制、隐藏或显示某些列等。这种需求使得用户界面更加灵活和个性化，能够更好地适应业务场景。Odoo 提供了 get_view() 方法作为一种机制来在视图加载前对其 XML 架构进行修改。

挑战：get_view() 中 active_id 的局限性

当尝试在 get_view() 方法中获取当前正在编辑或查看的表单记录 ID 时，开发者可能会直观地尝试使用 self.env.context.get('active_id')。然而，在某些特定场景下，尤其是在表单视图首次加载时，active_id 在 self.env.context 中可能并不总是指向当前打开的记录，或者可能指向一个不相关的记录，导致视图修改逻辑失效或作用于错误的记录。

解决方案：利用 params 上下文获取准确记录 ID

经过实践验证，在 get_view() 方法中，获取当前表单记录 ID 的更可靠方式是访问 self.env.context['params'].get('id')。params 上下文字典通常包含当前请求的详细参数，其中包括了正在操作的记录的 ID。通过这种方式，可以确保在处理视图架构时，始终能够准确地关联到正确的业务记录。

实现步骤与代码示例

以下是实现动态修改树视图属性的详细步骤和相应的 Odoo 16 代码示例。我们将以一个具体的例子来演示：根据当前 stock.picking 记录上设置的 limit 字段值，动态调整其内部 move_ids_without_package 树视图的分页限制。

Matlab语言的特点 中文WORD版

本文档主要讲述的是Matlab语言的特点；Matlab具有用法简单、灵活、程式结构性强、延展性好等优点，已经逐渐成为科技计算、视图交互系统和程序中的首选语言工具。特别是它在线性代数、数理统计、自动控制、数字信号处理、动态系统仿真等方面表现突出，已经成为科研工作人员和工程技术人员进行科学研究和生产实践的有利武器。希望本文档会给有需要的朋友带来帮助；感兴趣的朋友可以过来看看

下载

1. 重写 get_view() 方法

首先，我们需要在模型中继承并重写 get_view() 方法。这个方法在 Odoo 加载视图时被调用，允许我们在视图渲染之前对其 XML 架构进行修改。

from odoo import models, fields, api
from lxml import etree # 用于解析和修改XML
import logging

_logger = logging.getLogger(__name__)

class StockPicking(models.Model):
    _inherit = "stock.picking"

    limit = fields.Integer(string="Tree Pagination Limit", default=0,
                           help="Set a custom pagination limit for the moves tree view.")

    # ... 其他方法 ...

    @api.model
    def get_view(self, view_id=None, view_type='form', **options):
        _logger.info("Custom get_view called for model %s, view_type %s", self._name, view_type)

        # 调用父类的get_view方法获取原始视图架构
        result = super(StockPicking, self).get_view(view_id=view_id, view_type=view_type, **options)

        # 仅在处理表单视图时执行修改逻辑
        if view_type == 'form':
            # 将XML架构字符串解析为lxml对象
            doc = etree.XML(result['arch'])

            # 关键步骤：从params上下文中获取当前记录ID
            active_id = None
            if 'params' in self.env.context and self.env.context['params'].get('id'):
                active_id = self.env.context['params'].get('id')
                _logger.info(f"Retrieved active_id from params: {active_id}")
            else:
                _logger.warning("Could not find 'id' in self.env.context['params'].")

            # 如果成功获取到active_id，则继续处理
            if active_id:
                try:
                    current_record = self.browse(active_id)
                    if current_record and current_record.limit > 0:
                        # 查找名为'move_ids_without_package'的field标签下的所有tree视图
                        for tree_node in doc.xpath("//field[@name='move_ids_without_package']/tree"):
                            # 设置tree视图的limit属性
                            tree_node.set('limit', str(current_record.limit))
                            _logger.info(f"Set tree view limit to {current_record.limit} for record ID {active_id}")
                except Exception as e:
                    _logger.error(f"Error setting limit on tree view for record ID {active_id}: {e}")

            # 将修改后的lxml对象重新序列化为XML字符串，并更新到结果中
            result['arch'] = etree.tostring(doc, encoding='unicode')

        return result

2. 代码解析

• _inherit = "stock.picking": 继承 stock.picking 模型，以便添加自定义字段和重写方法。
• limit = fields.Integer(...): 添加一个名为 limit 的整数字段，用于存储用户为该记录设置的树视图分页限制。
• @api.model: 装饰器表明 get_view 是一个模型方法，不与特定记录绑定。
• super(StockPicking, self).get_view(...): 调用父类的 get_view 方法，获取原始的视图 XML 架构。这是修改视图的基础。
• etree.XML(result['arch']): 使用 lxml 库将从 result['arch'] 获取的 XML 字符串解析成一个可操作的 XML 树对象。
• active_id = self.env.context['params'].get('id'): 这是本教程的核心。它从 self.env.context['params'] 字典中安全地获取当前表单记录的 ID。
• self.browse(active_id): 根据获取到的 active_id 浏览到当前记录。
• doc.xpath("//field[@name='move_ids_without_package']/tree"): 使用 XPath 表达式定位到表单中嵌入的特定树视图。这里查找的是 name 为 move_ids_without_package 的 标签下的所有 标签。
• tree_node.set('limit', str(current_record.limit)): 如果 current_record.limit 大于 0，则动态设置找到的树视图的 limit 属性。
• etree.tostring(doc, encoding='unicode'): 将修改后的 XML 树对象重新序列化为 Unicode 字符串，并将其赋值回 result['arch']，以便 Odoo 使用修改后的架构渲染视图。

注意事项与最佳实践

1. 错误处理: 在代码中加入了 try-except 块，以捕获在处理记录或修改 XML 时可能发生的异常，增强代码的健壮性。
2. 性能考量: get_view() 方法在每次视图加载时都会执行。频繁的 XML 解析和修改可能会对性能产生轻微影响。确保你的 XPath 表达式足够精确，避免不必要的遍历。
3. 上下文判断: 始终检查 view_type == 'form'，以确保只在处理表单视图时执行相关逻辑，避免影响其他视图类型。
4. 模块依赖: 确保 lxml 库已安装。在 Odoo 环境中，它通常是默认依赖项。
5. 视图更新: 在修改了模型和视图逻辑后，可能需要更新 Odoo 模块才能使更改生效。
6. 替代方法: 对于更简单的视图修改，Odoo 的 attrs 属性在 XML 中提供了基于字段值的动态属性控制。但对于动态设置 limit 这种复杂场景，重写 get_view() 是一个直接且强大的方法。

总结

通过重写 get_view() 方法并利用 self.env.context['params'].get('id') 这一可靠机制，Odoo 开发者可以有效地在表单视图中根据当前记录的数据动态修改内嵌树视图的属性。这不仅解决了 active_id 上下文可能不准确的问题，也为构建更具交互性和业务适应性的 Odoo 界面提供了强大的工具。掌握这种技术，能够帮助你更好地应对复杂的视图定制需求。