
本文详细介绍了在odoo 16中,如何通过重写`get_view`方法,根据当前表单记录的数据动态修改内嵌tree视图的属性,例如分页限制。文章重点纠正了在`get_view`中获取当前记录id的常见误区,并提供了使用`self.env.context['params'].get('id')`的正确方法,确保属性修改能准确作用于当前打开的记录。
在Odoo开发中,我们有时需要根据当前表单记录的特定数据,动态调整其内部嵌入的Tree视图(列表视图)的属性。一个常见的场景是,根据父记录的设置,为子记录列表动态设置不同的分页限制(limit属性)。本文将指导您如何通过重写Odoo模型中的get_view方法,实现这一高级定制。
动态修改Tree视图属性的需求背景
Odoo的XML视图是静态定义的,但业务需求往往是动态变化的。例如,在一个销售订单或库存调拨单中,其包含的行项目(如order_line或move_ids_without_package)通常以Tree视图形式展示。如果希望根据销售订单的类型或库存调拨单的特定配置,来决定其行项目Tree视图默认显示多少条记录,这就需要动态修改Tree视图的limit属性。
核心实现方法:重写 get_view
get_view方法是Odoo视图加载流程中的一个关键点,它负责获取并返回指定视图类型的XML架构。通过重写此方法,我们可以在视图架构被渲染到前端之前,对其进行编程修改。
1. 定义存储动态值的字段
首先,在您希望控制Tree视图属性的模型上,定义一个字段来存储动态值。例如,在stock.picking模型上定义一个整数字段来存储分页限制:
from odoo import models, fields, api
from lxml import etree
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 move lines tree view. "
"Set to 0 or leave empty for default Odoo pagination.")2. 重写 get_view 方法
接下来,重写目标模型的get_view方法。在此方法中,我们将执行以下步骤:
- 调用父类的get_view方法,获取原始视图架构。
- 使用lxml库解析XML架构。
- 定位到需要修改的Tree视图字段。
- 关键点: 获取当前表单记录的ID。
- 根据当前记录的数据,修改Tree视图的属性。
- 将修改后的XML架构序列化回字符串。
@api.model
def get_view(self, view_id=None, view_type='form', **options):
_logger.debug("Custom get_view called for view_type: %s", view_type)
# 1. 调用父类方法获取原始视图结果
result = super(StockPicking, self).get_view(view_id=view_id, view_type=view_type, **options)
# 2. 仅在加载表单视图时进行修改
if view_type == 'form':
# 3. 使用lxml解析视图架构
doc = etree.XML(result['arch'])
# 4. 定位到目标Tree视图字段(例如:'move_ids_without_package')
# 使用XPath找到所有名为'move_ids_without_package'的field标签下的tree标签
for tree_node in doc.xpath("//field[@name='move_ids_without_package']/tree"):
# 5. 关键:获取当前表单记录的ID
# 在get_view方法中,active_id在self.env.context中可能不总是指向当前打开的表单记录
# 正确的方法是从self.env.context['params']中获取id
active_id = self.env.context.get('params', {}).get('id')
if active_id:
try:
# 6. 浏览当前记录
current_record = self.browse(active_id)
if current_record and current_record.limit > 0:
# 7. 根据记录数据修改Tree视图属性
tree_node.set('limit', str(current_record.limit))
_logger.info(f"Set tree view limit for picking {active_id} to {current_record.limit}")
elif current_record and current_record.limit == 0:
# 如果设置为0,则移除limit属性,使用Odoo默认分页
if 'limit' in tree_node.attrib:
del tree_node.attrib['limit']
_logger.info(f"Removed tree view limit for picking {active_id}")
except Exception as e:
_logger.error(f"Error setting limit on tree view for record {active_id}: {e}")
# 8. 将修改后的XML架构序列化回字符串
result['arch'] = etree.tostring(doc, encoding='unicode')
return result代码解析与注意事项
- lxml库: Odoo使用lxml来处理XML视图。您需要确保您的Odoo环境中安装了lxml。
- view_type == 'form': 确保只在加载表单视图时才进行修改,避免影响其他视图类型(如列表视图)。
- 定位Tree视图: 使用XPath表达式"//field[@name='move_ids_without_package']/tree"来精确查找目标Tree视图。这表示查找所有名为move_ids_without_package的field标签下的tree标签。
-
获取当前记录ID的正确姿势:
- 常见误区: 尝试使用self.env.context.get('active_id')。在get_view方法被调用时,active_id在self.env.context中可能不总是指向当前正在加载的表单记录。它可能来自上一个上下文(例如,从一个列表视图点击进入表单,active_id可能指向列表视图中的选中项,而不是当前表单的ID)。
- 正确方法: self.env.context.get('params', {}).get('id')。当Odoo渲染一个表单视图时,当前记录的ID通常会通过params字典传递到上下文。这是获取当前正在加载的表单记录ID最可靠的方式。
- 属性修改: tree_node.set('limit', str(current_record.limit))用于设置XML元素的属性。如果current_record.limit为0,我们选择移除limit属性,让Odoo使用默认分页行为。
- 错误处理: 使用try-except块捕获可能发生的异常,例如记录不存在或XML解析错误,并记录日志。
- 性能考量: 每次加载表单视图时都会执行XML解析和修改。对于非常复杂的视图或高并发场景,这可能会带来轻微的性能开销。通常情况下,对于常规业务流程,这种开销是可接受的。
完整示例代码(stock_picking_limit.py)
from odoo import models, fields, api
from lxml import etree
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 move lines tree view. "
"Set to 0 or leave empty for default Odoo pagination.")
@api.model
def get_view(self, view_id=None, view_type='form', **options):
_logger.debug("Custom get_view called for view_type: %s", view_type)
# 1. 调用父类方法获取原始视图结果
result = super(StockPicking, self).get_view(view_id=view_id, view_type=view_type, **options)
# 2. 仅在加载表单视图时进行修改
if view_type == 'form':
try:
# 3. 使用lxml解析视图架构
doc = etree.XML(result['arch'])
# 4. 定位到目标Tree视图字段(例如:'move_ids_without_package')
for tree_node in doc.xpath("//field[@name='move_ids_without_package']/tree"):
# 5. 关键:获取当前表单记录的ID
active_id = self.env.context.get('params', {}).get('id')
if active_id:
current_record = self.browse(active_id)
if current_record and current_record.limit > 0:
# 6. 根据记录数据修改Tree视图属性
tree_node.set('limit', str(current_record.limit))
_logger.info(f"Set tree view limit for picking {active_id} to {current_record.limit}")
elif current_record and current_record.limit == 0:
# 如果设置为0,则移除limit属性,使用Odoo默认分页
if 'limit' in tree_node.attrib:
del tree_node.attrib['limit']
_logger.info(f"Removed tree view limit for picking {active_id}")
else:
_logger.debug("No active_id found in params for form view, skipping limit modification.")
# 7. 将修改后的XML架构序列化回字符串
result['arch'] = etree.tostring(doc, encoding='unicode')
except etree.XMLSyntaxError as e:
_logger.error(f"XML Syntax Error while parsing view architecture: {e}")
except Exception as e:
_logger.error(f"An unexpected error occurred during get_view modification: {e}")
return result部署与测试
- 将上述代码保存为一个Python文件(例如models/stock_picking_limit.py),并将其添加到您的Odoo自定义模块中。
- 在模块的__init__.py文件中导入该文件。
- 确保您的模块依赖于stock模块。
- 升级您的Odoo模块。
- 打开一个库存调拨单(stock.picking)的表单视图。
- 在调拨单上设置Tree Pagination Limit字段的值(例如:5)。
- 保存调拨单。
- 刷新页面或重新打开该调拨单,您会发现其“操作”选项卡下的物料移动列表(move_ids_without_package)现在只会显示您设置的限制数量的记录。
总结
通过重写Odoo模型的get_view方法,并结合lxml库对XML视图架构进行操作,我们可以实现高度灵活的视图定制。关键在于正确获取当前表单记录的ID,即使用self.env.context.get('params', {}).get('id'),以确保您的动态修改准确作用于当前用户正在交互的记录。这种技术为Odoo开发者提供了强大的能力,能够根据复杂的业务逻辑,动态调整用户界面的行为和展现。










