首页 > 基础资料 博客日记

筑基期:掌握Odoo基础核心知识点02(Odoo XML 开发方式详解)

2026-04-16 18:30:02基础资料围观1

本篇文章分享筑基期:掌握Odoo基础核心知识点02(Odoo XML 开发方式详解),对你有帮助的话记得收藏一下,看极客资料网收获更多编程知识

Odoo XML 开发方式详解

目录


1. record — 创建或覆盖记录

1.1 基本概念

<record> 是 Odoo XML 中最基础的操作,用于在数据库中创建覆盖一条记录。几乎所有其他标签(menuitem、act_window 等)本质上都是 record 的简写。

1.2 创建新记录

<record id="my_custom_action" model="ir.actions.act_window">
    <field name="name">My Custom Action</field>
    <field name="res_model">my.model</field>
    <field name="view_mode">tree,form</field>
</record>

要点:

  • id:只写名称(不带模块前缀),表示在当前模块中创建新记录
  • model:指定要创建记录的模型(数据库表)
  • <field>:设置该记录各个字段的值

1.3 覆盖已有记录

<!-- 覆盖 emabc_base 模块中定义的 to_approve_action -->
<record id="emabc_base.to_approve_action" model="ir.actions.act_window">
    <field name="context">{"search_default_not_approved":1, 'show_batch_without_transfer':True,
        "hide_hly_reimbursement": True}
    </field>
</record>

要点:

  • id 写成 模块名.外部ID(如 emabc_base.to_approve_action),Odoo 会找到该记录并更新,而不是新建
  • 只写需要修改的 <field>,未写的字段保持原值不变
  • 这是整体覆盖,写什么就改什么,没写的不管

1.4 实际项目中的例子

例1:覆盖 action 的 context

<record id="emabc_base.to_approve_action" model="ir.actions.act_window">
    <field name="context">{"search_default_not_approved":1, 'show_batch_without_transfer':True,
        "hide_hly_reimbursement": True}
    </field>
</record>

解读:

  • 找到 emabc_base 模块中 id 为 to_approve_actionir.actions.act_window 记录
  • 只修改它的 context 字段
  • 其他字段(name、res_model、domain、view_mode 等)保持原值

⚠️ 注意: 由于是覆盖而非继承,context 的内容必须完整重写。如果原 context 有 {"search_default_not_approved":1, "show_batch_without_transfer":True},而你只写了 {"hide_hly_reimbursement": True},那原来的内容就丢了。

例2:创建视图记录

<record id="expense_reimbursement_from_view" model="ir.ui.view">
    <field name="name">General Reimbursement</field>
    <field name="model">emabc.expense.reimbursement</field>
    <field name="inherit_id" ref="emabc_expense.expense_reimbursement_from_view"/>
    <field name="arch" type="xml">
        <!-- 这里放视图的 XML 结构 -->
    </field>
</record>

解读:

  • 创建一条 ir.ui.view 记录
  • inherit_id 指定继承哪个已有视图(配合 xpath 或字段定位使用)
  • arch 中定义视图的 XML 结构

1.5 field 的常用写法

<!-- 普通文本值 -->
<field name="name">My Name</field>

<!-- 布尔值 -->
<field name="active">True</field>

<!-- 整数值 -->
<field name="sequence">10</field>

<!-- 引用其他记录的 ID(Many2one 字段) -->
<field name="inherit_id" ref="emabc_expense.expense_reimbursement_from_view"/>
<!-- ref="模块名.外部ID" 引用其他模块中定义的记录 -->

<!-- eval 表达式 -->
<field name="context" eval="{'search_default_not_approved': 1}"/>
<!-- eval 中写 Python 表达式,值可以是字典、列表等 -->

<!-- domain 过滤 -->
<field name="domain">[('reimbursement_type_state', '=', 'project')]</field>

<!-- many2many / one2many 字段 -->
<field name="groups_id" eval="[(6,0,[ref('emabc_base.expense_group_loan_reimbursement')])]"/>
<!-- (6,0,[id1,id2]) = 替换整个列表 -->
<!-- (4,id) = 添加一条 -->
<!-- (3,id) = 删除一条 -->
<!-- (5,0,[]) = 清空所有 -->

2. xpath — 继承修改视图

2.1 基本概念

xpath 用于在已有的视图上做局部修改,而不是重写整个视图。这是 Odoo 中最常用的视图定制方式。

2.2 使用前提

必须配合 ir.ui.view 记录和 inherit_id 使用:

<record id="my_view_inherit" model="ir.ui.view">
    <field name="name">My View Inherit</field>
    <field name="model">emabc.expense.reimbursement</field>
    <field name="inherit_id" ref="emabc_expense.expense_reimbursement_from_view"/>
    <field name="arch" type="xml">
        <!-- xpath 写在这里面 -->
    </field>
</record>

2.3 xpath 语法

<xpath expr="定位表达式" position="操作方式">
    <!-- 要插入/替换的内容 -->
</xpath>
  • expr:XPath 表达式,定位到原视图中的某个节点
  • position:操作方式

2.4 position 操作方式详解

position 值 作用 说明
after 在定位节点后面插入 最常用,在某个字段后面加新字段
before 在定位节点前面插入 在某个字段前面加新字段
inside 在定位节点内部插入 在 group、page 等容器内追加内容
replace 替换定位节点 整个替换原来的元素
attributes 修改定位节点的属性 必须配合 <attribute> 标签使用

2.5 实际项目中的例子详解

例1:修改按钮属性(position="attributes")

<xpath expr="//button[@name='loan_reconcile_wizard']" position="attributes">
    <attribute name="attrs">{'invisible':['|', ('state','not in',['financial_audit','partly_paid']), ('is_corporate_import', '=', True)]}</attribute>
</xpath>

逐步解读:

  1. expr="//button[@name='loan_reconcile_wizard']" — 找到原视图中 name 为 loan_reconcile_wizard 的 button

    • // 表示在任意层级查找
    • [@name='xxx'] 是属性选择器,筛选 name 属性等于 xxx 的元素
  2. position="attributes" — 要修改这个按钮的属性

  3. <attribute name="attrs">...</attribute> — 修改 attrs 属性的值为新的表达式

效果: 让"借款核销"按钮在"对公账单导入"时隐藏

例2:在字段后面插入新字段(position="after")

<xpath expr="//field[@name='actual_payee_bank']" position="after">
    <field name="is_corporate_import" readonly="1" options="{'readonly_save':True}"/>
</xpath>

逐步解读:

  1. expr="//field[@name='actual_payee_bank']" — 找到 name 为 actual_payee_bank 的 field
  2. position="after" — 在它后面插入
  3. 插入一个新的 is_corporate_import 字段

效果: 在"实际收款银行"字段后面添加"对公账单导入"字段

2.6 常用 xpath 表达式

<!-- 找 name 为 xxx 的 field -->
<xpath expr="//field[@name='xxx']" ...>

<!-- 找 name 为 xxx 的 button -->
<xpath expr="//button[@name='xxx']" ...>

<!-- 找 string 为 xxx 的 page -->
<xpath expr="//page[@string='xxx']" ...>

<!-- 找 name 为 xxx 的 group -->
<xpath expr="//group[@name='xxx']" ...>

<!-- 找第一个 form 下的 header -->
<xpath expr="//form/header" ...>

<!-- 找 notebook 下的第一个 page -->
<xpath expr="//notebook/page[1]" ...>

<!-- 找有特定 class 的元素 -->
<xpath expr="//div[@class='oe_title']" ...>

<!-- 组合条件:找 form 下 name 为 xxx 的 field -->
<xpath expr="//form//field[@name='xxx']" ...>

2.7 多个 xpath 修改同一个视图

一个继承视图中可以写多个 xpath,每个修改不同位置:

<record id="expense_reimbursement_from_view" model="ir.ui.view">
    <field name="name">General Reimbursement</field>
    <field name="model">emabc.expense.reimbursement</field>
    <field name="inherit_id" ref="emabc_expense.expense_reimbursement_from_view"/>
    <field name="arch" type="xml">
        <!-- 第1处修改:改按钮属性 -->
        <xpath expr="//button[@name='loan_reconcile_wizard']" position="attributes">
            <attribute name="attrs">...</attribute>
        </xpath>

        <!-- 第2处修改:改另一个按钮属性 -->
        <xpath expr="//button[@name='registered_payment_action']" position="attributes">
            <attribute name="attrs">...</attribute>
        </xpath>

        <!-- 第3处修改:在字段后面插入新字段 -->
        <xpath expr="//field[@name='actual_payee_bank']" position="after">
            <field name="is_corporate_import" readonly="1"/>
        </xpath>
    </field>
</record>

3. 字段定位 — xpath 的简化写法

3.1 基本概念

当你要定位的节点是 <field> 时,可以省略 xpath,直接用 <field name="xxx"> 来定位。

3.2 语法

<field name="要定位的字段名" position="操作方式">
    <!-- 插入的内容 -->
</field>

3.3 对比 xpath

<!-- xpath 写法 -->
<xpath expr="//field[@name='actual_payee_bank']" position="after">
    <field name="is_corporate_import" readonly="1"/>
</xpath>

<!-- 字段定位写法(效果完全相同,但更简洁) -->
<field name="actual_payee_bank" position="after">
    <field name="is_corporate_import" readonly="1"/>
</field>

3.4 限制

  • 只能定位 <field> 节点,不能定位 button、group、page、notebook 等非 field 元素
  • 对于非 field 元素,必须用 xpath

3.5 各种 position 的字段定位写法

<!-- 在某字段后面插入 -->
<field name="actual_payee_bank" position="after">
    <field name="is_corporate_import"/>
</field>

<!-- 在某字段前面插入 -->
<field name="actual_payee_bank" position="before">
    <field name="new_field_before"/>
</field>

<!-- 替换某字段 -->
<field name="old_field" position="replace">
    <field name="new_field"/>
</field>

<!-- 修改某字段的属性 -->
<field name="my_field" position="attributes">
    <attribute name="invisible">1</attribute>
    <attribute name="readonly">1</attribute>
</field>

4. delete — 删除已有记录

4.1 基本概念

<delete> 用于在模块安装/更新时删除数据库中已有的记录。

4.2 语法

<delete id="模块名.外部ID" model="模型名"/>

或者用 search 条件删除:

<delete model="模型名" search="[(搜索条件)]"/>

4.3 实际项目中的例子

<!-- emabc_bpm_interface 模块中 -->
<delete id="emabc_base.to_approve_action" model="ir.actions.act_window"/>

<!-- 然后重新创建一个新的同名 action -->
<record id="to_approve_action" model="ir.actions.act_window">
    <field name="name">To Approve</field>
    <field name="res_model">emabc.base.wkf.task</field>
    <field name="view_type">form</field>
    <field name="view_mode">tree</field>
    <field name="context">{"search_default_not_approved":1, 'show_batch_without_transfer':True}</field>
    <field name="domain">...</field>
</record>

解读:

  1. 先用 <delete> 删掉 emabc_base 模块中原来的 to_approve_action
  2. 再用 <record> 重新创建一个全新的 to_approve_action(注意此时 id 不带模块前缀,因为是在当前模块新建)

4.4 delete vs record 覆盖

<delete> + 新建 <record> 覆盖
原记录 彻底删除,重建 保留,只修改指定字段
未写的字段 需要全部重新写 保持原值
风险 漏写字段会丢失数据 只影响写的字段
适用场景 需要大幅改造,几乎重写 只需修改少量字段

5. 快捷标签 — menuitem / act_window / report / template

5.1 基本概念

快捷标签是 <record> 的简化写法,Odoo 内部会自动将它们转换为 record。用哪种写法效果完全一样,快捷标签只是代码更短。

5.2 menuitem

<!-- 快捷写法 -->
<menuitem name="差旅账单导入"
          id="hly_import_expense_wizard_menu"
          sequence="50"
          action="hly_import_expense_wizard_action"
          parent="emabc_expense.expense_reimbursement_menu"
          groups="emabc_base.expense_group_loan_reimbursement"/>

<!-- 等价的 record 写法 -->
<record id="hly_import_expense_wizard_menu" model="ir.ui.menu">
    <field name="name">差旅账单导入</field>
    <field name="sequence">50</field>
    <field name="action" ref="hly_import_expense_wizard_action"/>
    <field name="parent_id" ref="emabc_expense.expense_reimbursement_menu"/>
    <field name="groups_id" eval="[(6,0,[ref('emabc_base.expense_group_loan_reimbursement')])]"/>
</record>

menuitem 常用属性:

属性 说明
name 菜单显示名称
id 外部 ID
parent 父菜单的 xml_id
action 点击菜单时执行的 action 的 xml_id
sequence 排序序号(数字越小越靠前)
groups 权限组的 xml_id(多个用逗号分隔)

5.3 act_window

<!-- 快捷写法 -->
<act_window id="my_action"
            name="My Action"
            res_model="my.model"
            view_mode="tree,form"/>

<!-- 等价的 record 写法 -->
<record id="my_action" model="ir.actions.act_window">
    <field name="name">My Action</field>
    <field name="res_model">my.model</field>
    <field name="view_mode">tree,form</field>
</record>

5.4 report

<!-- 快捷写法 -->
<report id="my_report"
        name="My Report"
        model="my.model"
        report_type="qweb-pdf"
        file="my_module.report_template"/>

<!-- 等价的 record 写法 -->
<record id="my_report" model="ir.actions.report.xml">
    <field name="name">My Report</field>
    <field name="model">my.model</field>
    <field name="report_type">qweb-pdf</field>
    <field name="report_name">my_module.report_template</field>
</record>

5.5 template(QWeb 视图)

<!-- 快捷写法 -->
<template id="my_template" name="My Template">
    <t t-call="website.layout">
        <div>Content here</div>
    </t>
</template>

<!-- 等价的 record 写法 -->
<record id="my_template" model="ir.ui.view">
    <field name="name">My Template</field>
    <field name="type">qweb</field>
    <field name="arch" type="xml">
        <t t-call="website.layout">
            <div>Content here</div>
        </t>
    </field>
</record>

6. function — 调用 Python 方法

6.1 基本概念

<function> 用于在模块安装/更新时自动调用 Python 方法,通常用于初始化数据。

6.2 语法

<function model="模型名" name="方法名" eval="参数表达式"/>

6.3 示例

<!-- 调用 res.partner 模型的 name_search 方法,传入参数 ['abc'] -->
<function model="res.partner" name="name_search" eval="['abc']"/>

<!-- 调用当前模型的方法,不传参数 -->
<function model="my.model" name="my_init_method"/>

<!-- 传入多个参数 -->
<function model="my.model" name="my_method" eval="[ref('module.xml_id'), 'some_string']"/>

6.4 常见用途

  • 模块安装时初始化数据
  • 批量更新已有记录
  • 执行数据迁移逻辑

7. 各种方式的对比总结

7.1 选择决策树

你需要做什么?
│
├── 创建新记录(菜单、action、视图等)
│   ├── 是菜单 → 用 <menuitem>
│   ├── 是 action → 用 <act_window> 或 <record>
│   ├── 是报表 → 用 <report>
│   ├── 是 QWeb 模板 → 用 <template>
│   └── 其他 → 用 <record>
│
├── 修改已有记录的字段值
│   ├── 是视图的 arch 结构 → 用 xpath 或字段定位
│   └── 是其他字段(context、domain 等)→ 用 <record> 覆盖
│
├── 删除已有记录 → 用 <delete>
│
└── 安装时执行方法 → 用 <function>

7.2 视图修改方式对比

方式 能定位的元素 代码量 使用前提
xpath 任意元素(button、group、page、field 等) 较多 需要 inherit_id
字段定位 <field> 元素 较少 需要 inherit_id
record 覆盖整个 arch 不需要定位 重写整个视图 不需要 inherit_id,但风险大

7.3 记录修改方式对比

方式 作用 风险
record 覆盖 修改指定字段,未写的保持原值 低,但 context 等整体字段需完整重写
delete + 新建 彻底删除重建 高,漏写字段会丢失数据
xpath/字段定位 在原视图上做局部增删改 低,不影响未修改部分

7.4 xml_id 的写法与行为

id 写法 含义 行为
id="my_id" 当前模块的外部 ID 在当前模块创建新记录
id="other_module.existing_id" 其他模块的外部 ID 找到该记录并覆盖更新
ref="other_module.existing_id" 在 field 中引用其他模块的记录 获取该记录的数据库 ID


文章来源:https://www.cnblogs.com/zxr1002/p/19879389
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:jacktools123@163.com进行投诉反馈,一经查实,立即删除!

标签:

相关文章

本站推荐

标签云