
本教程详细介绍了如何在odoo自定义模块中,通过点击按钮实现静态文件的下载功能。核心方法是利用odoo的`ir.actions.act_url`动作,在后端python方法中构建一个指向静态文件路径的url,并将其作为动作返回。文章涵盖了文件存放位置、后端代码实现、前端按钮定义及注意事项,确保用户能顺利在odoo应用中提供文件下载服务。
在Odoo的业务应用中,经常会遇到需要为用户提供下载特定文档(如操作手册、报告模板、导入示例文件等)的需求。这些文档通常是静态文件,例如PDF、Excel或图片。本教程将指导您如何在Odoo 14及更高版本的自定义模块中,通过一个简单的按钮点击操作,实现这些静态文件的下载。
1. 静态文件的存放位置
Odoo模块的结构是高度模块化的,静态资源(如CSS、JavaScript、图片、字体以及本例中的下载文件)应存放在模块的static目录下。为了保持良好的组织性,建议将可下载的静态文件放在static/src/目录下,或者根据需要创建更细致的子目录,例如static/src/documents/。
示例路径结构:
your_module_name/
├── __init__.py
├── __manifest__.py
├── models/
│ └── models.py
├── views/
│ └── views.xml
└── static/
└── src/
└── target_file.pdf # 您的静态文件,例如一个PDF手册
└── another_file.xlsx # 另一个Excel文件请确保将您的PDF、Excel或其他静态文件放置在上述路径中的static/src/目录下。
2. 后端方法实现
实现文件下载的核心在于Odoo的后端Python方法。当用户点击前端视图中的按钮时,该按钮会调用一个Odoo模型上的Python方法。此方法需要返回一个特定的字典,指示Odoo执行一个URL重定向动作。
在您的自定义模型(例如your_module_name/models/models.py)中,定义一个方法,该方法将返回一个ir.actions.act_url类型的动作:
from odoo import models, fields, api
class YourCustomModel(models.Model):
_name = 'your.custom.model'
_description = 'Your Custom Model Description'
name = fields.Char(string="Name")
# ... 其他字段
def download_static_file(self):
"""
点击按钮时触发,用于下载静态文件。
返回一个ir.actions.act_url动作,将用户重定向到文件下载URL。
"""
# 构建静态文件的URL路径。
# 格式为: /your_module_name/static/src/your_file_name.extension
file_url = '/your_module_name/static/src/target_file.pdf'
return {
'type': 'ir.actions.act_url', # 动作类型:执行一个URL
'url': file_url, # 要打开或下载的URL
'target': 'self', # 'self'表示在当前窗口打开/下载,'new'表示在新标签页打开
}
代码解释:
- type: 'ir.actions.act_url':这是Odoo用于执行URL相关操作的标准动作类型。
- url: file_url:这是最关键的部分。它指定了要下载的文件的完整Web路径。请注意,路径必须以/开头,并遵循/
/static/src/ 的格式。Odoo会自动处理这些静态资源的路由。 - target: 'self':
- 当设置为'self'时,文件会在当前浏览器窗口中尝试下载或打开。
- 当设置为'new'时,文件会在一个新的浏览器标签页中打开或下载。对于PDF等浏览器原生支持预览的文件,通常会在新标签页中直接打开预览。
3. 前端视图中按钮定义
在您的自定义视图(例如your_module_name/views/views.xml)中,您需要定义一个按钮来调用上述后端方法。
your.custom.model.form your.custom.model
XML解释:
- name="download_static_file":这指定了按钮将调用的Python方法名。
- type="object":这表示按钮将调用模型上的一个方法(而不是一个Odoo动作)。
- string="下载操作手册":按钮上显示的文本。
- class="oe_highlight":一个Odoo的CSS类,用于使按钮突出显示。
4. 注意事项
- 文件路径准确性: 确保url参数中的文件路径与您在模块中实际存放文件的路径完全一致,包括模块名、static/src/子目录和文件名。任何拼写错误都将导致文件无法找到。
- 文件类型支持: 这种方法适用于大多数常见的静态文件类型,例如.pdf、.xlsx、.docx、.jpg、.png等。浏览器会根据文件类型决定是直接下载还是在新标签页中打开预览。
- Odoo服务重启与模块更新: 在添加或修改静态文件以及Python代码后,您可能需要重启Odoo服务并更新您的模块,以确保所有更改都被Odoo加载。对于静态文件,有时还需要清除浏览器缓存(Ctrl+F5或Cmd+Shift+R)才能看到最新版本。
- 权限控制: 这种方法默认不对文件下载进行权限控制。如果您的文件包含敏感信息,您可能需要在Python方法中添加额外的逻辑来检查当前用户的权限,或者考虑使用更安全的存储和下载机制。
5. 总结
通过上述步骤,您可以在Odoo自定义模块中轻松实现静态文件的下载功能。核心在于利用Odoo提供的ir.actions.act_url动作,结合正确的静态文件路径,即可为用户提供便捷的文件访问方式。这种方法简单高效,适用于绝大多数静态文档的下载需求。










