Odoo 14自定义模块中实现静态文件下载功能教程

本教程详细指导odoo 14开发者如何在自定义模块中通过点击按钮实现静态文件的下载功能。内容涵盖静态文件的正确存放路径、python方法中`ir.actions.act_url`动作的配置，以及如何构建正确的下载url，确保用户能够顺利获取如pdf、excel等文档。

在Odoo自定义模块开发中，经常会遇到需要为用户提供静态文件下载的场景，例如下载操作手册、报告模板或特定文档。本文将详细介绍如何在Odoo 14社区版中，通过自定义模块的按钮点击事件，实现从服务器下载静态文件的功能。

1. 静态文件在Odoo模块中的存放规范

Odoo模块遵循一套标准的目录结构，其中static目录专门用于存放模块的静态资源，如CSS、JavaScript、图片和可下载的文件。为了保持模块的整洁和Odoo的资源加载机制，建议将需要下载的静态文件放置在static目录下的特定子目录中，例如src。

推荐路径结构：

your_module_name/
├── static/
│   ├── src/
│   │   └── target_file.pdf  # 您的目标下载文件
│   └── description/
│   └── img/
│   └── lib/
│   └── css/
│   └── js/
├── models/
├── views/
├── __init__.py
├── __manifest__.py
└── ...

例如，如果您的模块名为my_custom_module，并且您要下载一个名为manual_document.pdf的PDF文件，那么该文件的完整路径应为：my_custom_module/static/src/manual_document.pdf。

2. 实现下载功能的Python方法

在Odoo中，当用户点击一个按钮时，通常会触发一个Python方法。要实现文件下载，这个Python方法需要返回一个特定结构的字典，该字典会指示Odoo执行一个URL跳转或下载动作。核心是使用ir.actions.act_url动作类型。

下面是一个在自定义模型中实现下载功能的Python方法示例：

百度文心百中

百度大模型语义搜索体验中心

22

查看详情

from odoo import models, fields, api

class MyCustomModel(models.Model):
    _name = 'my.custom.model'
    _description = '我的自定义模型'

    name = fields.Char("名称")

    @api.model
    def download_static_file(self):
        """
        点击按钮时触发，用于下载静态文件。
        该方法返回一个ir.actions.act_url动作字典。
        """
        # 假设您的模块名为 'your_module_name'
        # 您的文件名为 'target_file.pdf'
        # 文件路径为 'your_module_name/static/src/target_file.pdf'

        return {
            'type': 'ir.actions.act_url',
            'url': '/your_module_name/static/src/target_file.pdf',
            'target': 'self', # 'self' 在当前窗口下载，'new' 在新窗口打开
        }

关键参数解释：

• type: 'ir.actions.act_url'
  • 这是Odoo动作类型之一，专门用于执行URL相关的操作。当Odoo遇到这种类型的动作时，它会尝试访问或下载指定的URL。
• url: '/your_module_name/static/src/target_file.pdf'
  • 这是最关键的参数，指定了要下载的静态文件的完整URL路径。
  • 重要提示： 这个URL是相对于Odoo服务器的根路径。它必须以斜杠/开头，并包含您的模块名称、static目录、以及您存放文件的子目录（例如src）和文件名。请务必确保此路径与您实际存放文件的位置完全匹配。
• target: 'self' 或 'new'
  • 'self': 推荐用于下载操作。它会尝试在当前浏览器窗口或标签页中处理下载，通常会导致文件直接下载到用户的本地设备。
  • 'new': 会在新浏览器窗口或标签页中打开指定的URL。对于某些浏览器和文件类型（如PDF），这可能会导致文件在新标签页中预览而不是直接下载。根据您的需求选择。

3. Odoo视图中的按钮配置（简述）

虽然问题中假设按钮已正确创建并关联了方法，但为了教程的完整性，这里简要提及如何在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="我的自定义模型">
            <header>
                <!-- 这里的name属性指向Python方法名 -->
                <button name="download_static_file" type="object" string="下载操作手册" class="oe_highlight"/>
            </header>
            <sheet>
                <group>
                    <field name="name"/>
                </group>
            </sheet>
        </form>
    </field>
</record>

在上述XML代码中：

• name="download_static_file"：指向您在Python模型中定义的下载方法。
• type="object"：表示点击按钮将调用一个Python方法。
• string="下载操作手册"：按钮上显示的文本。

4. 注意事项

• 文件路径的准确性： 确保Python方法中url参数的值与静态文件在模块中的实际存放路径完全一致。任何拼写错误或路径不符都将导致下载失败。
• 支持的文件类型： 这种方法适用于大多数常见的静态文件类型，例如PDF (.pdf)、Excel (.xlsx, .xls)、Word (.docx, .doc)、文本文件 (.txt)、图片 (.jpg, .png) 等。Odoo服务器会根据文件的MIME类型进行响应，浏览器通常能正确处理。
• 模块更新： 在添加或修改静态文件后，为了确保Odoo能够识别并加载这些新的或更新的资源，您可能需要更新您的模块。可以通过Odoo UI进行更新，或者在命令行中使用odoo -u your_module_name命令。
• 浏览器缓存： 如果您在同一路径下更新了静态文件但文件名未变，浏览器可能会因为缓存而继续显示旧版本。此时，用户可能需要清除浏览器缓存或使用无痕模式来获取最新文件。

5. 总结

通过上述步骤，您可以在Odoo 14自定义模块中轻松实现静态文件的下载功能。核心在于正确配置静态文件的存放路径，并在按钮触发的Python方法中返回一个type='ir.actions.act_url'的动作字典，其中url参数指向静态文件的Web路径。掌握这一技巧，将大大提升您Odoo模块的用户体验和功能丰富性。

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