Async Call RPC: 一个轻量级的 JSON RPC 客户端和服务器

Async Call RPC: 一个轻量级的 JSON RPC 客户端和服务器

async-call-rpc A lightweight JSON RPC client & server 项目地址: https://gitcode.com/gh_mirrors/as/async-call-rpc

1. 项目介绍

Async Call RPC 是一个使用 TypeScript 编写的 JSON RPC 客户端和服务器，适用于任何 ECMAScript 环境。它支持自定义编码器以处理复杂数据类型，并且完全支持 TypeScript。项目旨在简化 RPC 服务器和客户端的定义和使用，同时不依赖任何外部库。

2. 项目快速启动

以下是快速启动 Async Call RPC 的步骤：

首先，您需要安装 Node.js。然后，通过以下命令之一安装 Async Call RPC：

npm i async-call-rpc
# 或者
yarn add async-call-rpc
# 或者
pnpm i async-call-rpc

服务器端示例

创建一个名为 server.ts 的文件，并添加以下代码：

export function add(x: number, y: number) {
    return x + y;
}

export const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));

客户端示例

创建一个名为 client.ts 的文件，并添加以下代码：

import { AsyncCall } from 'async-call-rpc';
import type * as server from './server';

const server = AsyncCall< typeof server >({}, {
    // 在这里配置您的通信通道
});

server.add(2, 40).then(console.log); // 输出 42

运行项目

确保您的项目配置了正确的 TypeScript 编译环境，然后运行以下命令来编译和执行您的代码：

tsc && node dist/client.js

3. 应用案例和最佳实践

使用自定义编码器

如果您的应用需要处理复杂数据类型，您可以实现自定义编码器。以下是一个简单的自定义编码器示例：

import { IsomorphicEncoder } from 'async-call-rpc';

class CustomEncoder implements IsomorphicEncoder {
    encode(data: any): any {
        // 实现编码逻辑
    }

    decode(data: any): any {
        // 实现解码逻辑
    }
}

批量请求

Async Call RPC 支持批量请求，允许您同时发送多个请求并处理它们的响应。

import { AsyncCall, batch } from 'async-call-rpc';
import type * as server from './server';

const [server, emit, drop] = batch(AsyncCall< typeof server >({}, {
    // 在这里配置您的通信通道
}));

const a = server.req1();
const b = server.req2();
const c = server.req3();

emit(); // 发送所有挂起的请求

// 之后可以继续发送更多请求或使用 drop 来取消挂起的请求

4. 典型生态项目

Async Call RPC 的生态系统中，有一些典型的项目可以帮助您更好地集成和使用 RPC 服务：

• async-call-rpc/utils/node/websocket.server.js: 用于 Node.js 的 WebSocket 服务器实现。
• async-call-rpc/utils/deno/websocket.server.ts: 用于 Deno 的 WebSocket 服务器实现。
• async-call-rpc/utils/web/websocket.client.js: 用于 Web 的 WebSocket 客户端实现。
• async-call-rpc/utils/web/broadcast.channel.js: 用于 Web 的 BroadcastChannel 实现，支持在浏览器内进行通信。

以上是 Async Call RPC 的简要介绍和快速启动指南。希望这能帮助您开始使用这个强大的 RPC 库。

async-call-rpc A lightweight JSON RPC client & server 项目地址: https://gitcode.com/gh_mirrors/as/async-call-rpc