TSRPC 示例项目教程

1. 项目介绍

TSRPC 是一个专为 TypeScript 设计的全栈 RPC 框架，支持 HTTP 和 WebSocket 协议，具有运行时类型检查和序列化功能。它非常适合网站、APP 和游戏开发，尤其适合全栈 TypeScript 开发者。

2. 项目快速启动

2.1 克隆项目

首先，克隆 TSRPC 示例项目到本地：

git clone https://github.com/k8w/tsrpc-examples.git

2.2 启动后端服务

进入示例项目的后端目录并安装依赖，然后启动服务：

cd tsrpc-examples/examples/first-api/backend
npm install
npm run dev

2.3 启动前端服务

进入示例项目的前端目录并安装依赖，然后启动服务：

cd tsrpc-examples/examples/first-api/frontend
npm install
npm run dev

3. 应用案例和最佳实践

3.1 实现一个简单的 API 接口

TSRPC 实现一个 API 接口只需要三个步骤：定义协议、服务端实现、客户端调用。以下是一个简单的示例：

3.1.1 定义协议

创建一个协议文件 api/Hello.ts：

export interface ReqHello {
    name: string;
}

export interface ResHello {
    reply: string;
}

3.1.2 服务端实现

在服务端实现该接口 server/api/Hello.ts：

import { ApiCall } from "tsrpc";

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

3.1.3 客户端调用

在客户端调用该接口 client/index.ts：

import { HttpClient } from "tsrpc";
import { ReqHello, ResHello } from "../shared/protocols/api/Hello";

const client = new HttpClient({
    server: "http://localhost:3000",
    logger: console
});

client.callApi("Hello", { name: "World" }).then(res => {
    console.log(res.isSucc ? res.res.reply : res.err);
});

3.2 最佳实践

• 类型安全：TSRPC 提供了运行时类型检查，确保数据传输的类型安全。
• 协议复用：协议文件可以同时在客户端和服务端使用，减少重复代码。
• 高性能：TSRPC 支持二进制序列化，性能优越。

4. 典型生态项目

• TSRPC 核心库：k8w/tsrpc
• TSRPC 示例项目：k8w/tsrpc-examples
• TSRPC 官方文档：TSRPC 官方文档

通过以上步骤，您可以快速上手并使用 TSRPC 进行全栈开发。