TSRPC 技术文档

TSRPC 技术文档

【免费下载链接】tsrpc A TypeScript RPC framework, with runtime type checking and serialization, support both HTTP and WebSocket. It is very suitable for website / APP / games, and absolutely comfortable to full-stack TypeScript developers. 项目地址: https://gitcode.com/gh_mirrors/ts/tsrpc

欢迎来到 TSRPC 的全面指南。TSRPC 是一个基于 TypeScript 的远程过程调用（RPC）框架，它集成了运行时类型检查和二进制序列化功能，为现代全栈开发提供强大支持。

安装指南

要开始使用 TSRPC，首先确保您的开发环境已经安装了 Node.js。之后，可以通过以下命令快速创建一个新的 TSRPC 全栈项目：

npx create-tsrpc-app@latest

这将引导您完成新项目的初始化设置。

项目使用说明

协议定义（共享）

在 TSRPC 中，协议是客户端和服务端通信的基础。以下是定义协议的示例：

// protocol.ts
export interface ReqHello {
  name: string;
}

export interface ResHello {
  reply: string;
}

服务端 API 实现

接下来，在服务器端实现对应的 API 调用逻辑：

// server.ts
import { ApiCall } from "tsrpc";
import { ReqHello, ResHello } from './protocol';

export async function ApiHello(call: ApiCall<ReqHello, ResHello>) {
  call.succ({
    reply: 'Hello, ' + call.req.name
  });
}

客户端 API 调用

从客户端调用上述 API 非常直观：

// client.ts
import { Client } from 'tsrpc';
const client = new Client(/* 配置信息 */);

(async () => {
  let ret = await client.callApi('Hello', {
    name: 'World'
  });
  console.log(ret); // 输出: { reply: 'Hello, World' }
})();

项目API使用文档

详细的API参考可以查阅官方文档中的API Reference部分，它提供了所有可用API的详细说明和用法。

序列化算法

TSRPC 利用 TSBuffer 进行高效的数据序列化和反序列化，而 TSBuffer 基于 TypeScript 源代码直接定义协议，无需额外的 IDL（接口描述语言）。这意味着您可以充分利用 TypeScript 强大的类型系统，如联合类型、交集类型、映射类型等特性进行协议设计。

总结

通过本篇文档，您应该对如何使用 TSRPC 创建高性能的全栈应用有了基本的理解。TSRPC 结合其独到的序列化机制和简洁的API设计，让类型安全贯穿客户端与服务端，大大提高了开发效率和系统的可靠性。深入探索 TSRPC 示例项目 和 API 参考文档，将进一步提升您的实践技能。祝您开发愉快！

【免费下载链接】tsrpc A TypeScript RPC framework, with runtime type checking and serialization, support both HTTP and WebSocket. It is very suitable for website / APP / games, and absolutely comfortable to full-stack TypeScript developers. 项目地址: https://gitcode.com/gh_mirrors/ts/tsrpc