Odoo自定义模块：实现按钮点击下载静态文件功能

本教程详细指导如何在odoo自定义模块中，通过点击按钮实现静态文件的下载功能。核心方法是利用odoo的`ir.actions.act_url`动作，将文件放置于模块的`static/src`路径下，并配置相应的url。文章将涵盖文件存放位置、python方法实现及关键参数配置，确保用户能轻松为模块添加文档、手册等静态文件下载功能。

在Odoo的日常开发中，我们经常需要为用户提供下载静态文件的功能，例如产品手册、操作指南或模板文件。本文将详细介绍如何在Odoo自定义模块中，通过在视图中添加一个按钮，实现点击后下载存储在服务器上的静态文件。

1. 静态文件的存放路径

Odoo遵循一套标准的模块结构来管理静态资源（如CSS、JS、图片、字体和文档等）。为了确保Odoo能够正确地识别和提供这些文件，我们需要将静态文件放置在模块的特定子目录下。

推荐的文件存放路径是： your_module_name/static/src/target_file.pdf

其中：

• your_module_name：你的自定义模块的名称。
• static/：这是Odoo模块中用于存放所有静态资源的标准目录。
• src/：这是一个常见的子目录，用于存放源文件或特定类型的静态资源，例如本例中的PDF文档。你也可以根据需要创建其他子目录，如static/doc/等。
• target_file.pdf：你要提供下载的具体文件，例如manual.pdf或template.xlsx。

例如，如果你的模块名为my_custom_module，并且你想提供一个名为user_manual.pdf的文件下载，那么该文件应放置在： my_custom_module/static/src/user_manual.pdf

2. 按钮动作的实现

当用户点击Odoo视图中的一个按钮时，通常会触发一个Python方法。要实现文件下载功能，这个Python方法需要返回一个特定的Odoo动作字典，即ir.actions.act_url。

ir.actions.act_url动作类型专门用于重定向到指定的URL，这正是我们实现文件下载所需要的。

百灵大模型

蚂蚁集团自研的多模态AI大模型系列

177

查看详情

2.1 Python方法定义

在你的自定义模型的Python文件中，定义一个方法来处理按钮点击事件。这个方法将返回一个包含下载链接的动作字典。

from odoo import models, fields, api

class MyCustomModel(models.Model):
    _name = 'my.custom.model'
    _description = 'My Custom Model Description'

    name = fields.Char(string='Name')
    # ... 其他字段

    def download_static_file(self):
        """
        通过ir.actions.act_url动作下载静态文件。
        """
        return {
            'type': 'ir.actions.act_url',
            'url': '/my_custom_module/static/src/user_manual.pdf', # 替换为你的模块名和文件路径
            'target': 'self', # 'self' 在当前窗口/标签页打开，'new' 在新窗口/标签页打开
        }

2.2 ir.actions.act_url 参数详解

• type: 'ir.actions.act_url' 这是指定动作类型的键，明确告诉Odoo这是一个URL重定向动作。
• url: '/your_module_name/static/src/target_file.pdf' 这是最关键的参数，指定了要下载文件的完整URL路径。这个URL是相对于Odoo服务器根目录的绝对路径。请务必将/your_module_name/static/src/target_file.pdf替换为你实际的模块名和文件路径。
• target: 'self' 或 'new' 这个参数控制URL的打开方式：
  • 'self' (默认值)：在当前窗口或标签页中打开URL。对于下载文件，这意味着浏览器会尝试直接下载文件，而不是导航到新页面。
  • 'new'：在新窗口或标签页中打开URL。

对于文件下载功能，通常使用'self'，这样浏览器会直接处理下载请求。

3. 视图中的按钮集成

在你的自定义视图（XML文件）中，你需要定义一个按钮来调用上述Python方法。

<record id="view_my_custom_model_form" model="ir.ui.view">
    <field name="name">my.custom.model.form</field>
    <field name="model">my.custom.model</field>
    <field name="arch" type="xml">
        <form string="My Custom Model">
            <header>
                <button name="download_static_file" 
                        string="下载用户手册" 
                        type="object" 
                        class="oe_highlight"/>
            </header>
            <sheet>
                <group>
                    <field name="name"/>
                    <!-- ... 其他字段 -->
                </group>
            </sheet>
        </form>
    </field>
</record>

• name="download_static_file"：指定按钮点击时调用的Python方法的名称。
• type="object"：表示按钮将调用模型上的一个Python方法。

4. 注意事项

• 模块名和路径的准确性：确保url参数中的模块名和文件路径与实际的模块结构完全匹配。任何拼写错误都可能导致文件无法找到（404错误）。
• 文件类型支持：Odoo通过这种方式支持下载多种静态文件类型，例如PDF (.pdf)、Excel (.xlsx)、图片 (.jpg, .png) 等常见格式都经过测试并能正常工作。浏览器会根据文件的MIME类型进行相应的处理（下载或直接打开）。
• Odoo服务更新：在添加或修改静态文件后，通常不需要重启Odoo服务，但为了确保更改生效，建议更新你的自定义模块（通过Odoo界面中的“应用” -> 你的模块 -> “升级”）。

总结

通过上述步骤，你可以在Odoo自定义模块中轻松实现按钮点击下载静态文件的功能。核心在于正确地放置静态文件到模块的static/src目录下，并在Python方法中返回一个配置了正确URL的ir.actions.act_url动作字典。这种方法简单高效，适用于为用户提供各种文档和模板下载需求。

以上就是Odoo自定义模块：实现按钮点击下载静态文件功能的详细内容，更多请关注php中文网其它相关文章！