提升开发效率的RPC系统！

Cap'n Web：一个高效的JavaScript原生RPC系统

随着现代Web应用的不断发展，开发者愈发需要一种简洁高效的远程过程调用（RPC）系统。Cap'n Web 正是为此而生，它是由Cap'n Proto的作者设计，旨在无缝地融入Web应用生态。这种RPC系统具有极低的样板代码、出色的可读性和强大的对象能力特性，使得在JavaScript和TypeScript环境下的通信变得简单而灵活。

关键特性

1. 对象能力协议

Cap'n Web实现了对象能力RPC模型，即支持双向调用。客户端和服务器均可以调用对方的函数，极大增强了交互能力。尤其是可以通过引用传递函数和对象，实现在不同程序上下文中的回调处理。

2. 人类可读的序列化

与Cap'n Proto不同，Cap'n Web的序列化方式采用了JSON，使得数据在传输过程中不仅高效，而且便于调试和人类阅读。这种序列化方式大大降低了开发者的使用难度。

3. 零样板代码

Cap'n Web几乎不需要任何样板代码，使得开发者可以专注于业务逻辑。相比于传统RPC系统，Cap'n Web的灵活性显著提高，尤其在使用TypeScript时能无缝集成，让类型安全和开发体验水乳交融。

4. 多种传输方式的兼容

它支持HTTP、WebSocket及postMessage()等多种传输方式，开发者能够方便地根据不同的场景选择传输方式。

5. 轻量级和依赖性管理

Cap'n Web的压缩体积不到10kB，且无任何外部依赖，可以快速集成到项目中，为现代Web应用的性能提供了保障。

安装

使用npm安装Cap'n Web非常简单，只需运行以下命令：

bash 复制代码

npm i capnweb

用法示例

客户端代码示例

在客户端，你可以通过WebSocket与服务器进行交互，如下所示：

javascript 复制代码

import { newWebSocketRpcSession } from "capnweb";

// 一行代码便可建立连接。
let api = newWebSocketRpcSession("wss://example.com/api");

// 调用服务器上的方法！
let result = await api.hello("World");

console.log(result);

服务器代码示例

服务器的实现代码如下，定义了一个RPC Target类：

javascript 复制代码

import { RpcTarget, newWorkersRpcResponse } from "capnweb";

// 这是服务器实现类
class MyApiServer extends RpcTarget {
  hello(name) {
    return `Hello, ${name}!`;
  }
}

// 标准的Cloudflare Workers HTTP处理程序
export default {
  fetch(request, env, ctx) {
    let url = new URL(request.url);

    // API路由
    if (url.pathname === "/api") {
      return newWorkersRpcResponse(request, new MyApiServer());
    }

    return new Response("Not found", {status: 404});
  }
}

更复杂的示例

以下示例演示了在TypeScript中如何使用Cap'n Web进行多个RPC调用，其中一个调用会依赖前一个调用的结果：

typescript 复制代码

interface PublicApi {
  authenticate(apiToken: string): AuthedApi;
  getUserProfile(userId: string): Promise<UserProfile>;
}

interface AuthedApi {
  getUserId(): number;
  getFriendIds(): number[];
}

type UserProfile = {
  name: string;
  photoUrl: string;
}

import { newHttpBatchRpcSession } from "capnweb";

let api = newHttpBatchRpcSession("https://example.com/api");
let authedApi: RpcPromise = api.authenticate(apiToken);
let userIdPromise: RpcPromise = authedApi.getUserId();

let profilePromise = api.getUserProfile(userIdPromise);

// 等待所有结果返回
let [profile] = await Promise.all([profilePromise]);

console.log(`Hello, ${profile.name}!`);

长连接的 WebSocket 示例

要设置持久的WebSocket连接，示例代码如下：

javascript 复制代码

import { newWebSocketRpcSession } from "capnweb";

using api = newWebSocketRpcSession("https://example.com/api");

using authedApi: RpcPromise = api.authenticate(apiToken);
let userId: number = await authedApi.getUserId();

RPC基础知识

Cap'n Web支持多种类型的参数传递，包括：

字符串、数字、布尔值等基本值。
普通对象和数组。
对功能的传递能力，诸如函数和类实例等。

`RpcTarget`

定义RPC API时，需要创建一个继承自RpcTarget的类，这样可以实现引用传递。通过这种方式，实例在调用时并不被序列化，而是会在RPC消息中包含对原始目标对象的"存根"引用，这样可以在调用时直接反向连接到原始对象。

函数与Stub

当一个函数通过RPC传递时，它也会被视为RpcTarget。这样，客户端可以通过存根直接调用远端函数。

安全性考虑

认证机制：推荐在RPC中实现一种内嵌的认证方式，以避免传递敏感信息的风险。
速率限制：对于资源密集型操作，实施速率限制可以减少恶意请求造成的负担。

资源管理与处置

在使用RPC时，显式的资源管理是非常重要的。你可以选择在不再需要时显式地处置存根，以释放服务端资源。

如何处置

通过调用 stub[Symbol.dispose]() 方法，可以手动释放RPC连接。捕获并管理stub资源，有助于优化内存使用。

提升开发效率的RPC系统！

Cap'n Web：一个高效的JavaScript原生RPC系统

关键特性

1. 对象能力协议

2. 人类可读的序列化

3. 零样板代码

4. 多种传输方式的兼容

5. 轻量级和依赖性管理

安装

用法示例

客户端代码示例

服务器代码示例

更复杂的示例

长连接的 WebSocket 示例

RPC基础知识

RpcTarget

函数与Stub

安全性考虑

资源管理与处置

如何处置

同类项目对比

`RpcTarget`