1. 引言：Odoo 18 前端中 RPC 调用的过渡

远程过程调用 (RPC) 是现代 Web 应用程序中不可或缺的一部分，它允许前端应用程序与后端服务器进行通信以执行操作或检索数据。在 Odoo 框架中，RPC 在前端（主要使用 JavaScript 构建）与后端（使用 Python 编写）之间建立通信桥梁方面发挥着至关重要的作用。本文旨在阐明 Odoo 18 前端中 RPC 调用处理方式的转变，重点是从使用 useService('rpc') 到采用 @web/core/network/rpc 中的 rpc。用户的反馈表明了这种潜在的过时性以及对更新研究方案以反映此变化的必要性。本文将详细解释这种转变，阐述新方法的使用方式，并将其置于 Odoo 18 前端架构的上下文中。

2. 背景：Odoo 前端中的 RPC

2.1. RPC 在 Odoo Web 客户端开发中的作用

RPC 使 Odoo 前端能够与后端进行交互，而无需重新加载整个页面，从而提供更流畅和响应更快的用户体验。这种机制对于执行各种任务至关重要，例如从服务器获取动态数据、触发后端执行的特定业务逻辑以及更新数据库中的记录 。例如，当用户在界面上执行某个操作（如单击按钮或提交表单）时，前端 JavaScript 代码通常会发起一个 RPC 调用到后端特定的 Odoo 控制器或模型方法。然后，后端处理该请求并返回响应，前端可以根据该响应更新用户界面。  

2.2. 先前使用 useService('rpc') 的方法概述

在 Odoo 的早期版本中，特别是那些利用 OWL 框架的版本（在 Odoo 18 之前），访问 rpc 服务通常通过 useService 钩子来实现 。useService 是 Odoo 前端框架提供的一种机制，允许组件声明它们对特定服务的依赖。这些服务是提供各种功能的持久性代码片段。通过在组件的 setup() 方法中调用 useService('rpc')，开发者可以获得对 rpc 服务实例的引用，该实例提供了一个用于向 Odoo 服务器发送请求的异步函数 。  

以下是一个简单的代码片段，演示了 useService('rpc') 的用法：

JavaScript

import { useService } from "@web/core/utils/hooks";
import { Component } from "@odoo/owl";

class MyComponent extends Component {
    setup() {
        this.rpc = useService("rpc");
        // ... 其他设置代码
    }

    async fetchData() {
        const result = await this.rpc("/my/route", { some: "value" });
        console.log(result);
    }
}

这种方法是访问 Odoo 前端框架内各种核心服务的标准方式，体现了框架内部的依赖注入机制 。组件可以声明它们对 rpc 等特定服务的需求，从而促进了模块化和可测试性。这种模式允许组件获取对系统不同部分（例如，网络、通知、ORM）功能的引用，而无需将它们紧密耦合到特定的实现。这也有利于更容易地模拟和隔离测试组件。  

2.3. Odoo 前端演变的背景

Odoo 的前端框架一直在不断发展，OWL 框架的引入和成熟是其中的关键里程碑 。OWL 是一个声明式的组件系统，其设计灵感来源于 Vue 和 React。Odoo 18 中 RPC 处理方式的改变可以看作是这种持续演变和框架完善的一部分。Odoo 团队不断评估和优化框架的各个方面，以提高性能、可维护性和开发者体验。  

3. Odoo 18：引入 @web/core/network/rpc

3.1. RPC 处理方式改变的根本原因

Odoo 开发团队决定引入直接导入 rpc 函数的方式，而不是仅仅依赖 useService，这可能是出于几个原因。一个可能的原因是为了提高组件依赖的清晰度和显式性 。通过直接导入 rpc 函数，组件明确声明了它对该特定功能的依赖，这使得代码更容易理解和维护。  

另一个潜在的原因可能是为了提高性能或减少开销。直接导入必要的函数可能比通过服务注册表查找服务实例更有效率。此外，这种改变可能与框架内更偏向函数式编程风格的趋势有关。直接导入函数是 JavaScript 中一种常见的模式，可以使代码更加简洁和模块化。最后，这种改变也可能与 JavaScript 框架设计中不断发展的最佳实践相一致。

这种转向直接导入可能表明了 OWL 内部暴露和使用核心功能的方式发生了一种微妙的架构变化。这可能暗示着对于每个实用函数，都在逐渐放弃纯粹基于服务的方法。虽然服务对于管理状态和复杂功能至关重要，但像 rpc 这样的实用函数可能被认为是更独立的，因此适合直接导入。这可以简化开发者的心智模型，并可能优化模块加载过程。

3.2. @web/core/network/rpc 模块的详细解释

在 Odoo 18 中，@web/core/network/rpc 模块现在是执行前端 RPC 调用的主要方式 。该模块封装了向 Odoo 后端发出异步请求的底层逻辑 。它处理诸如请求格式化、身份验证和响应处理等各个方面，从而简化了开发者与后端交互的过程。通过导入和使用此模块中的 rpc 函数，开发者可以轻松地从其 OWL 组件向服务器发送请求并处理响应。  

4. 使用新方法实现 RPC 调用

4.1. 导入 rpc 函数

要使用新的 RPC 方法，需要在 JavaScript 文件中添加以下导入语句：

JavaScript

import { rpc } from "@web/core/network/rpc";

这行代码使得 rpc 函数在模块的作用域内可用 。如 中的代码片段所示，此导入通常与 OWL 组件的导入一起使用：  

JavaScript

import { Component } from "@odoo/owl";
import { rpc } from "@web/core/network/rpc";

4.2. 发起 RPC 调用的语法和参数

调用 rpc 函数的基本语法如下：

JavaScript

const result = await rpc(route, params, settings);

此函数接受三个参数：

• route：要调用的 Odoo 控制器的 URL（例如，/web/dataset/call_kw 或自定义控制器路由）。  
• params：一个可选的对象，包含要发送到服务器的数据。此数据应该是 JSON 可序列化的 。  
• settings：一个可选的对象，用于配置 RPC 调用（例如，silent: true 以阻止默认的错误通知）。  

中的示例展示了如何使用 rpc 函数调用路由 '/product_info' 并传递参数 { product_id: product_id }。类似地， 也演示了带有路由 ('/product_info') 和参数 ({ product_id: product_id }) 的用法。  

4.3. 提供演示实际用法的代码示例

以下是一个简单的 OWL 组件示例，该组件使用新的 rpc 方法来获取数据：

JavaScript

import { Component, useState } from "@odoo/owl";
import { rpc } from "@web/core/network/rpc";

class DataFetcher extends Component {
    setup() {
        this.state = useState({ data: null, error: null });
        this.fetchInitialData();
    }

    async fetchInitialData() {
        try {
            this.state.data = await rpc("/my/api/endpoint");
            console.log("Data fetched:", this.state.data);
        } catch (error) {
            this.state.error = error;
            console.error("Error fetching data:", error);
        }
    }

    async sendDataToServer() {
        try {
            const response = await rpc("/my/api/submit", { payload: { key: "value" } });
            console.log("Server response:", response);
        } catch (error) {
            console.error("Error sending data:", error);
        }
    }

    static template = `
        <div>
            <button t-on-click="fetchInitialData">Fetch Data</button>
            <button t-on-click="sendDataToServer">Send Data</button>
            <div t-if="state.data">
                <p>Data: <t t-esc="state.data"/></p>
            </div>
            <div t-if="state.error">
                <p style="color: red;">Error: <t t-esc="state.error"/></p>
            </div>
        </div>
    `;
}

此示例演示了如何使用 async/await 关键字来处理 rpc 调用返回的 Promise。 中的 loadData() 函数也提供了一个清晰的 await rpc(...) 用法示例。 展示了使用 .then() 和 .catch() Promise 来处理 rpc 调用的结果。这些示例强调了 RPC 调用的异步特性以及处理成功响应和潜在错误的重要性。Promise (.then() 和 .catch() 或 async/await) 的使用是管理 JavaScript 中这些异步操作的基础。  

5. 比较和主要区别

5.1. 对比 useService('rpc') 和 @web/core/network/rpc

虽然 useService('rpc') 和 @web/core/network/rpc 都实现了相同的目标（发起 RPC 调用），但主要区别在于如何在组件中获取 rpc 函数。 明确指出：“在 Odoo 18 源代码中，我找不到任何 useService("rpc") 的用法...相反，我在 Odoo 18 中找到了这个：import { rpc } from "@web/core/network/rpc";” 重申了 useService("rpc") 在 Odoo 18 中可能已被弃用。此外， 显示一位开发者在 Odoo 18 中遇到错误 (TypeError: env.services.rpc is not a function)，这进一步表明了这种变化。  

useService('rpc') 涉及从 Odoo 服务注册表中访问 rpc 服务实例。另一方面，@web/core/network/rpc 涉及直接导入 rpc 函数。下表总结了这两种方法之间的主要区别：

功能	useService('rpc') (先前版本)	@web/core/network/rpc (Odoo 18)
访问方法	组件 setup() 方法中的钩子：this.rpc = useService("rpc");	直接导入：import { rpc } from "@web/core/network/rpc";
导入语句	import { useService } from "@web/core/utils/hooks";	import { rpc } from "@web/core/network/rpc";
组件中的用法	this.rpc(route, params, settings)	rpc(route, params, settings)
潜在优势	中心化的服务访问	改进的清晰度，潜在的 tree-shaking

5.2. 强调任何功能或架构上的差异

根据目前的信息，除了导入方法之外，RPC 调用的功能或底层架构似乎没有任何重大变化。核心功能保持不变，但开发者访问它的方式发生了改变。直接导入方法可能提供了一种稍微更轻量级或更有效的方式来使用 RPC。

5.3. 讨论新方法的潜在优势

新方法具有几个潜在的优势：

• 改进的代码可读性和显式性：依赖项在文件的顶部清晰地声明 。  
• 潜在的更好的 tree-shaking：JavaScript 打包器可能只导入 rpc 函数，而不是整个服务注册表，从而减小最终的包大小。
• 简化组件设置：在某些情况下，可能不再需要在 setup() 方法中访问 this 上下文来获取服务。

转向直接导入符合现代 JavaScript 实践，这种实践倾向于显式依赖而不是通过中央注册表管理的隐式依赖。这可以使代码更易于维护和理解。显式导入可以立即清楚地表明模块依赖哪些功能，从而提高代码可读性，并更容易跟踪依赖项和理解模块的行为。相比之下，依赖 useService 可能需要开发者知道哪些服务可用及其名称，这可能导致代码透明度降低。

6. OWL 框架内的上下文

6.1. 新的 RPC 方法如何与 Odoo 18 的基于组件的架构集成

即使采用直接导入，RPC 调用仍然是从 OWL 组件内部发起的，以与后端进行交互 。这种改变主要影响组件如何获得对 RPC 功能的访问。import 语句是 OWL 组件结构的基本部分 ，新的 RPC 方法与之无缝集成。  

6.2. 服务和网络通信在 OWL 中的作用

虽然 useService('rpc') 可能已被弃用，但服务的概念可能仍然存在，用于管理 Odoo 前端中更复杂、有状态的功能 。@web/core/network/rpc 模块可以看作是为网络通信提供了一个特定的实用函数，可能与更广泛的服务管理分开。  

将服务定义为“提供功能的持久性代码片段”，并提到 rpc 服务是“执行 Odoo 服务器请求的正确方式”。虽然此代码片段来自 Odoo 18 文档，但它可能指的是较旧的 useService 方法或对框架内 RPC 的更概念性的理解。需要根据新的导入方法来解释它。这突出了交叉引用文档与实际代码和社区发现的重要性。官方文档是主要的信息来源，但在快速发展的框架中，它可能并不总是完全最新。社区论坛和代码示例可以提供关于当前最佳实践和 API 使用的宝贵实时见解。  

7. 开发者影响和迁移指南

7.1. 对现有 Odoo 模块和自定义代码的影响

如果开发者有使用 useService('rpc') 的现有代码，他们需要更新这些代码以使用新的导入方法 。在许多情况下，这可能涉及简单的查找和替换操作。建议开发者在迁移到 Odoo 18 时审查其 Odoo 17 及更早版本的模块，以识别并更新所有 useService('rpc') 的实例。  

7.2. 迁移到新的 RPC 方法的建议

以下是将现有代码迁移到新的 RPC 方法的逐步指南：

1. 从 OWL 组件的 setup() 方法中删除行 this.rpc = useService("rpc");。
2. 在 JavaScript 文件的顶部添加导入语句 import { rpc } from "@web/core/network/rpc";。
3. 确保所有对 this.rpc() 的调用现在都直接调用导入的 rpc 函数。

7.3. 解决潜在挑战并提供解决方案

开发者在迁移过程中可能会遇到一些潜在问题，例如忘记更新所有实例或遇到细微的行为差异（尽管根据目前的信息不太可能）。建议使用代码检查工具来帮助识别和更新已弃用的模式。此外，建议对迁移的模块进行彻底的测试，以确保 RPC 调用仍然按预期工作。即使 API 中看似简单的更改有时也可能在复杂的应用程序中产生不可预见的后果。全面的测试有助于在开发周期的早期发现任何此类问题，从而避免潜在的生产问题。

8. 结论：Odoo 18 中进行 RPC 调用的变更摘要和最佳实践

总而言之，Odoo 18 建议使用从 @web/core/network/rpc 导入的 rpc 函数，而不是 useService('rpc')。 这种变化旨在提高代码的清晰度，并可能带来性能上的改进。开发者在迁移到 Odoo 18 时务必更新其现有代码以采用这种新方法。建议开发者查阅最新的官方 Odoo 18 文档和社区资源，以获取最新的信息和最佳实践。  o