odoo 給列表視圖添加按鈕實現數據文件導入

来源:https://www.cnblogs.com/shouke/archive/2023/02/20/17135868.html
-Advertisement-
Play Games

實踐環境 Odoo 14.0-20221212 (Community Edition) 代碼實現 模塊文件組織結構 說明：為了更好的表達本文主題，一些和主題無關的文件、代碼已略去 odoo14\custom\estate │ __init__.py │ __manifest__.py │ ├─mod ...


實踐環境

Odoo 14.0-20221212 (Community Edition)

代碼實現

模塊文件組織結構

說明：為了更好的表達本文主題，一些和主題無關的文件、代碼已略去

odoo14\custom\estate
│  __init__.py
│  __manifest__.py
│
├─models
│  estate_customer.py
│  __init__.py
│
├─security
│      ir.model.access.csv
│
├─static
│  ├─img
│  │      icon.png
│  │
│  └─src
│      ├─js
│      │      estate_customer_tree_upload.js
│      │
│      └─xml
│              estate_customer_tree_view_buttons.xml
│
└─views
      estate_customer_views.xml
      estate_menus.xml
      webclient_templates.xml

測試模型定義

odoo14\custom\estate\models\estate_customer.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import base64
import openpyxl

from odoo.exceptions import UserError
from odoo import models, fields, _ # _ = GettextAlias()

from tempfile import TemporaryFile

class EstateCustomer(models.Model):
    _name = 'estate.customer'
    _description = 'estate customer'

    name = fields.Char(required=True)
    age = fields.Integer()
    description = fields.Text()

    def create_customer_from_attachment(self, attachment_ids=None):
        """
        :param attachment_ids: 上傳的數據文件ID列表
        """

        attachments = self.env['ir.attachment'].browse(attachment_ids)
        if not attachments:
            raise UserError(_("未找到上傳的文件"))

        for attachment in attachments:
            file_name_suffix = attachment.name.split('.')[-1]
            # 針對文本文件，暫時不實現數據存儲，僅演示如何處理文本文件
            if file_name_suffix in ['txt', 'html']: # 文本文件
                lines = base64.decodebytes(attachment.datas).decode('utf-8').split('\n')
                for line in lines:
                    print(line)
            elif file_name_suffix in ['xlsx', 'xls']: # excel文件
                file_obj = TemporaryFile('w+b')
                file_obj.write(base64.decodebytes(attachment.datas))
                book = openpyxl.load_workbook(file_obj, read_only=False)
                sheets = book.worksheets
                for sheet in sheets:
                    rows = sheet.iter_rows(min_row=2, max_col=3) # 從第二行開始讀取，每行讀取3列
                    for row in rows:
                        name_cell, age_cell, description_cell = row
                        self.create({'name': name_cell.value, 'age': age_cell.value, 'description': description_cell.value})
            else:
                raise UserError(_("不支持的文件類型，暫時僅支持.txt,.html,.xlsx,.xls文件"))

            return {
                'action_type': 'reload', # 導入成功後，希望前端執行的動作類型， reload-刷新tree列表, do_action-執行action
            }

說明：

  • 函數返回值，具體需要返回啥，實際取決於下文js實現(上傳成功後需要執行的操作)，這裡結合實際可能的需求，額外提供另外幾種返回值供參考：

形式1：實現替換當前頁面的效果

return {
    'action_type': 'do_action',
    'action': {
        'name': _('導入數據'),        
        'res_model': 'estate.customer',
        'views': [[False, "tree"]],
        'view_mode': 'tree',
        'type': 'ir.actions.act_window',
        'context': self._context,
        'target': 'main'
    }
}

形式2：彈出對話框效果

return {
    'action_type': 'do_action',
    'action': {
        'name': _('導入成功'),        
        'res_model': 'estate.customer.wizard',
        'views': [[False, "form"]],
        'view_mode': 'form',
        'type': 'ir.actions.act_window',
        'context': self._context,
        'target': 'new'
    }
}

說明：打開estate.customer.wizard預設form視圖

形式3：實現類似瀏覽器刷新當前頁面效果

return {
    'action_type': 'do_action',
    'action': {
        'type': 'ir.actions.client',
        'tag': 'reload' # 或者替換成 'tag': 'reload_context',
    }
}

odoo14\custom\estate\models\__init__.py

#!/usr/bin/env python
# -*- coding:utf-8 -*-

from . import estate_customer

測試數據文件

mydata.xlsx

姓名 年齡 備註
張三 30 喜好運動
李四 28 喜歡美食
王五 23

測試模型視圖定義

odoo14\custom\estate\views\estate_customer_views.xml

<?xml version="1.0"?>
<odoo>
    <record id="link_estate_customer_action" model="ir.actions.act_window">
        <field name="name">顧客信息</field>
        <field name="res_model">estate.customer</field>
        <field name="view_mode">tree,form</field>
    </record>

    <record id="estate_customer_view_tree" model="ir.ui.view">
        <field name="name">estate.customer.tree</field>
        <field name="model">estate.customer</field>
        <field name="arch" type="xml">
            <tree js_class="estate_customer_tree" limit="15">
                <field name="name" string="Title"/>
                <field name="age" string="Age"/>
                <field name="description" string="Remark"/>
            </tree>
        </field>
    </record>

    <record id="estate_customer_view_form" model="ir.ui.view">
        <field name="name">estate.customer.form</field>
        <field name="model">estate.customer</field>
        <field name="arch" type="xml">
            <form>
                <sheet>
                    <group>
                        <field name="name" />
                        <field name="age"/>
                        <field name="description"/>
                    </group>
                </sheet>
            </form>
        </field>
    </record>
</odoo>

說明：<tree js_class="estate_customer_tree" limit="15">，其中estate_customer_tree為下文javascript中定義的組件，實現添加自定義按鈕；limit 設置列表視圖每頁最大顯示記錄數

菜單定義

odoo14\custom\estate\views\estate_menus.xml

<?xml version="1.0"?>
<odoo>
    <menuitem id="test_menu_root" name="Real Estate" web_icon="estate,static/img/icon.png">        
        <menuitem id="data_import_testing" name="數據導入測試" action="link_estate_customer_action"/>
    </menuitem>
</odoo>

estate_customer_tree 組件定義

js實現

為列表視圖添加自定義上傳數據文件按鈕

odoo14\custom\estate\static\src\js\estate_customer_tree_upload.js

odoo.define('estate.upload.customer.mixin', function (require) {
"use strict";

    var core = require('web.core');
    var _t = core._t;

    var qweb = core.qweb;

    var UploadAttachmentMixin = {
        start: function () {
            // 定義一個唯一的fileUploadID(形如 my_file_upload_upload737)和一個回調方法
            this.fileUploadID = _.uniqueId('my_file_upload');
            $(window).on(this.fileUploadID, this._onFileUploaded.bind(this));
            return this._super.apply(this, arguments);
        },

        _onAddAttachment: function (ev) {
            // 一旦選擇了附件，自動提交表單(關閉上傳對話框)
            var $input = $(ev.currentTarget).find('input.o_input_file');
            if ($input.val() !== '') {
                 // o_estate_customer_upload定義在對應的QWeb模版中
                var $binaryForm = this.$('.o_estate_customer_upload form.o_form_binary_form');
                $binaryForm.submit();
            }
        },

        _onFileUploaded: function () {
            // 創建附件後的回調，根據附件ID執行相關處程式
            var self = this;
            var attachments = Array.prototype.slice.call(arguments, 1);
            // 獲取附件ID
            var attachent_ids = attachments.reduce(function(filtered, record) {
                if (record.id) {
                    filtered.push(record.id);
                }
                return filtered;
            }, []);
            // 請求模型方法
            return this._rpc({
                model: 'estate.customer',  //模型名稱
                method: 'create_customer_from_attachment', // 模型方法
                args: ["", attachent_ids],
                context: this.initialState.context,
            }).then(function(result) { // result為一個字典
                if (result.action_type == 'reload') {
                    self.trigger_up('reload'); // 實現在不刷新頁面的情況下，刷新列表視圖// 此處換成 self.reload(); 發現效果也是一樣的
                } else if (result.action_type == 'do_action') {
                    self.do_action(result.action); // 執行action動作
                } else { // 啥也不做
                }
                // 重置 file input, 如果需要，可以再次選擇相同的文件，如果不添加以下這行代碼，不刷新當前頁面的情況下，無法重覆導入相同的文件
                self.$('.o_estate_customer_upload .o_input_file').val('');
             }).catch(function () {                
                self.$('.o_estate_customer_upload .o_input_file').val('');
            });
        },

        _onUpload: function (event) {
            var self = this;
            // 如果隱藏的上傳表單不存在則創建
            var $formContainer = this.$('.o_content').find('.o_estate_customer_upload');
            if (!$formContainer.length) {
                // estate.CustomerHiddenUploadForm定義在對應的QWeb模版中
                $formContainer = $(qweb.render('estate.CustomerHiddenUploadForm', {widget: this}));
                $formContainer.appendTo(this.$('.o_content'));
            }
            // 觸發input選取文件
            this.$('.o_estate_customer_upload .o_input_file').click();
        },
    }
    return UploadAttachmentMixin;
});


odoo.define('estate.customer.tree', function (require) {
"use strict";
    var core = require('web.core');
    var ListController = require('web.ListController');
    var ListView = require('web.ListView');
    var UploadAttachmentMixin = require('estate.upload.customer.mixin');
    var viewRegistry = require('web.view_registry');

    var CustomListController = ListController.extend(UploadAttachmentMixin, {
        buttons_template: 'EstateCustomerListView.buttons',
        events: _.extend({}, ListController.prototype.events, {
            'click .o_button_upload_estate_customer': '_onUpload',
            'change .o_estate_customer_upload .o_form_binary_form': '_onAddAttachment',
        }),
    });

    var CustomListView = ListView.extend({
        config: _.extend({}, ListView.prototype.config, {
            Controller: CustomListController,
        }),
    });

    viewRegistry.add('estate_customer_tree', CustomListView);
});

說明：如果其它模塊的列表視圖也需要實現類似功能，想復用上述js，需要替換js中以下內容:

  • 修改estate.upload.customer.mixin為其它自定義全局唯一值

  • 替換o_estate_customer_upload為在對應按鈕視圖模板中定義的對應class屬性值

  • 替換estate.CustomerHiddenUploadForm為在對應按鈕視圖模板中定義的隱藏表單模版名稱

  • 替換EstateCustomerListView.buttons為對應按鈕視圖模板中定義的按鈕模版名稱

  • 根據需要替換 this._rpc函數中的model參數值("estate.customer")，method參數值("create_customer_from_attachment")，必要的話，修改then函數實現。

  • 替換estate_customer_tree為自定義全局唯一值

  • do_action 為 Widget() 的快捷方式(定義在odoo14\odoo\addons\web\static\src\js\core\service_mixins.js中)，用於查找當前action管理器並執行action -- do_action函數的第一個參數，格式如下：

    {
    'type': 'ir.actions.act_window',
    'name': _('導入數據'),        
    'res_model': 'estate.customer',
    'views': [[False, "tree"], [False, "form"]],
    'view_mode': 'tree',
    'context': self._context,
    'target': 'current'
}

載入js腳本xml文件定義

odoo14\custom\estate\views\webclient_templates.xml

<?xml version="1.0" encoding="utf-8"?>
<odoo>
    <template id="assets_common" inherit_id="web.assets_common" name="Backend Assets (used in backend interface)">
         <xpath expr="//script[last()]" position="after">
             <script type="text/javascript" src="/estate/static/src/js/estate_customer_tree_upload.js"></script>
        </xpath>
    </template>
</odoo>

按鈕視圖模板定義

odoo14\custom\estate\static\src\xml\estate_customer_tree_view_buttons.xml

<?xml version="1.0" encoding="UTF-8"?>

<templates>
    <t t-name="estate.CustomerHiddenUploadForm">
        <div class="d-none o_estate_customer_upload">
            <t t-call="HiddenInputFile">
                <t t-set="multi_upload" t-value="true"/>
                <t t-set="fileupload_id" t-value="widget.fileUploadID"/>
                <t t-set="fileupload_action" t-translation="off">/web/binary/upload_attachment</t>
                <input type="hidden" name="model" value=""/>
                <input type="hidden" name="id" value="0"/>
            </t>
        </div>
    </t>

    <t t-name="EstateCustomerListView.buttons" t-extend="ListView.buttons">
        <t t-jquery="button.o_list_button_add" t-operation="after">
            <!--btn表示按鈕類
              按鈕顏色：btn-primary--主要按鈕，btn-secondary次要按鈕
              按鈕大小：btn-sm小按鈕，btn-lg大按鈕
              預設按鈕：btn-default-->
            <button type="button" class="btn btn-primary o_button_upload_estate_customer">Upload</button>
        </t>
    </t>
</templates>

說明：

t-name：定義模版名稱

t-extend：定義需要繼承的模板。

t-jquery：接收一個CSS 選擇器，用於查找上下文中，同CSS選擇器匹配的元素節點(為了方便描述，暫且稱之為上下文節點)

t-operation：設置需要對上下文節點執行的操作（為了方便描述，暫且將t-operation屬性所在元素稱為模板元素），可選值如下：

  • append

    將模板元素內容(body)追加到上下文節點的最後一個子元素後面。

  • prepend

    將模板元素內容插入到上下文節點的第一個子元素之前。

  • before

    將模板元素內容插入到上下文節點之前。

  • after

    將模板元素內容插入到上下文節點之後。

  • inner

    將模板元素內容替換上下文節點元素內容(所有子節點)

  • replace

    將模板元素內容替換上下文節點

  • attributes

    模版元素內容應該是任意數量的屬性元素，每個元素都有一個名稱屬性和一些文本內容，上下文節點的命名屬性將被設置為屬性元素的值（如果已經存在則替換，如果不存在則添加）

註意：參考官方文檔，t-extend這種繼承方式為舊的繼承方式，已廢棄，筆者實踐了最新繼承方式，如下

<?xml version="1.0" encoding="UTF-8"?>
<templates>
    <t t-name="DataImportTestingListView.buttons" t-inherit="ListView.buttons" t-inherit-mode="primary">
        <xpath expr="//button[@calss='btn btn-primary o_list_button_add']" position="after">
            <button type="button" class="btn btn-primary o_button_upload_estate_customer">Upload</button>
        </xpath>
    </t>
</templates>

發現會報錯：

ValueError: Module ListView not loaded or inexistent, or templates of addon being loaded (estate) are misordered

參考連接：https://www.odoo.com/documentation/14.0/zh_CN/developer/reference/javascript/qweb.html

模型訪問許可權配置

odoo14\custom\estate\security\ir.model.access.csv

id,name,model_id/id,group_id/id,perm_read,perm_write,perm_create,perm_unlink
access_estate_customer_all_perm,access_estate_customer_all_perm,model_estate_customer,base.group_user,1,1,1,1

模塊其它配置

odoo14\custom\estate\__init__.py

#!/usr/bin/env python
# -*- coding:utf-8 -*-

from . import models

odoo14\custom\estate\__manifest__.py

#!/usr/bin/env python
# -*- coding:utf-8 -*-
{
    'name': 'estate',
    'depends': ['base'],
    'data':[
        'security/ir.model.access.csv',
        'views/webclient_templates.xml',
        'views/estate_customer_views.xml',        
        'views/estate_menus.xml'
    ],
    'qweb':[# templates定義文件不能放data列表中，提示不符合shema，因為未使用<odoo>元素進行“包裹”
        'static/src/xml/estate_customer_tree_view_buttons.xml', 
    ]
}

最終效果

作者：授客
微信/QQ：1033553122
全國軟體測試QQ交流群：7156436
Git地址：https://gitee.com/ishouke
友情提示：限於時間倉促，文中可能存在錯誤，歡迎指正、評論！
作者五行缺錢，如果覺得文章對您有幫助，請掃描下邊的二維碼打賞作者，金額隨意，您的支持將是我繼續創作的源動力，打賞後如有任何疑問，請聯繫我!!!
           微信打賞                        支付寶打賞                  全國軟體測試交流QQ群  
              


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 數據對接：從Notion Database到低代碼平臺
    在 HTML 中引入 JavaScript 文件時，可以使用 defer 屬性，該屬性可以推遲（defer）腳本的執行，即等到整個 HTML 文檔解析完畢後才執行腳本。 使用 defer 屬性可以避免在解析 HTML 文檔的過程中阻塞頁面的渲染，提高頁面載入的速度。 同時，defer 屬性還可以確保 ...
  • Cesium entity畫各種圖（十六）
    在官方示例的沙盒裡寫東西是真方便 Cesium中有兩種對象可以添加到場景中，Entity、Primitive。Entity對用戶更友好，方便使用，但是靈活性和性能差一些。Primitive，支持自定義幾何形狀和幾何對象的材質，可以實現更複雜的效果。 1.polygon（面） var square = ...
  • 項目開發軟體架構選擇指南
    一、背景 遠程服務將電腦程式的工作範圍從單機擴展到網路，從本地延伸至遠程，是構建分散式系統的首要基礎。遠程服務調用（Remote Procedure Call，RPC）在電腦科學中已經存在了超過四十年時間。但很多人無法明確區分RPC與Rest。本文就講一講RPC和Rest的本質區別。 二、分析 ...
  • 多線程併發（一）：聊聊AQS中的獨占鎖的實現原理
    談到java中的併發，我們就避不開線程之間的同步和協作問題，談到線程同步和協作我們就不能不談談jdk中提供的AbstractQueuedSynchronizer(翻譯過來就是抽象的隊列同步器)機制； (一)、AQS中的state和Node含義： AQS中提供了一個int volatile state ...
  • 讀Java實戰（第二版）筆記16_組合式非同步編程
    導入依賴 <!--代碼生成器--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.4.1</version> </dependency> ...
  • day15-SpringMVC執行流程
    SpringMVC執行流程 1.SpringMVC執行流程分析圖 例子 （1）創建 HaloHandler package com.li.web.debug; import org.springframework.stereotype.Controller; import org.springfra ...
  • 【牛客】1 基礎語法
    VL1 四選一多路器 `timescale 1ns/1ns module mux4_1( input [1:0]d1,d2,d3,d0, input [1:0]sel, output [1:0]mux_out ); //*************code***********// assign mu ...
  • Java的Lambda表達式到底是啥？
    看完of的幫助文檔，會非常懷念fluent的幫助文檔或是matlab的幫助文檔 比如我要解決一個matlab問題，基本上看幫助文檔一分鐘就知道我要如何取用我想要的東西，of幫助文檔不光做不到，還給你炫技 真的，這東西誰看誰不懵啊 這些框圖怎麼來的呢，是doxygen自動生成的， 那doxygen是怎 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類