Connect-ES：TypeScript 实现的高性能Protobuf RPC框架

Connect-ES：TypeScript 实现的高性能Protobuf RPC框架

connect-esThe TypeScript implementation of Connect: Protobuf RPC that works.项目地址:https://gitcode.com/gh_mirrors/co/connect-es

项目介绍

Connect-ES是TypeScript版本的Connect框架实现，它提供了一种基于Protobuf的高效RPC解决方案，旨在简化跨平台服务之间的通信。此框架允许开发者首先定义服务模式（schema），然后通过代码生成技术自动生成服务器和客户端代码，确保类型安全且兼容HTTP协议栈。Connect-ES支持现代Web浏览器、Node.js环境，并且借助Fastify、Next.js和Express等插件，轻松集成到现有Web开发框架中。它利用了Protobuf-ES，保证了与Google的Protocol Buffers标准的完全兼容性。

项目快速启动

要快速启动一个基于Connect-ES的项目，遵循以下步骤：

步骤1：安装依赖

首先，你需要安装Connect的核心库以及对应的代码生成器。在你的项目目录下运行以下命令：

npm install --save @connectrpc/connect @connectrpc/protoc-gen-connect-es
protoc-gen-connect-es --version # 确保正确安装

步骤2：定义服务模式

创建一个.proto文件来定义你的服务，如eliza.proto:

syntax = "proto3";
service ElizaService {
    rpc Say(SayRequest) returns (SayResponse);
}
message SayRequest {
    string sentence = 1;
}
message SayResponse {
    string sentence = 1;
}

步骤3：生成代码

使用Protobuf编译器和Connect代码生成器生成TypeScript代码：

protoc -I . --plugin=protoc-gen-connect-es=./node_modules/.bin/protoc-gen-connect-es --connect_es_out=services:. ./eliza.proto

步骤4：编写服务端逻辑

接着，在生成的服务接口上实现业务逻辑：

import * as ElizaService from './services/eliza_service_client';

export async function handleElizaSay(request: ElizaService.SayRequest): Promise<ElizaService.SayResponse> {
    return { sentence: "When you feel " + request.sentence + ", what do you do?" };
}

步骤5：运行服务

使用Express简单搭建服务：

import * as express from 'express';
import { ElizaService } from './services/eliza_service_server';

const app = express();
app.use('/eliza', ElizaService.makeHandler(handleElizaSay));
app.listen(3000, () => console.log('Server listening on port 3000'));

应用案例和最佳实践

在构建实际应用时，Connect-ES推荐的做法包括利用其与Web框架的高度整合能力，例如在Next.js中构建RESTful替代方案或实时API端点。此外，确保服务定义清晰，利用TypeScript的强类型特性减少错误，以及在客户端使用fetch或对应的库来调用RPC方法，确保前后端交互的类型安全。

典型生态项目

Connect-ES生态系统提供了多个工具和扩展，以适应不同的开发需求和环境，其中一些关键项目包括：

• @connectrpc/connect-fastify: 集成Fastify，便于构建高性能服务。
• @connectrpc/connect-next: 结合Next.js，使得服务能在SSR或CSR场景下无缝工作。
• @connectrpc/connect-express: 对于经典的Express框架，提供简易集成方案。
• connect-query-es: 与TanStack Query配合，增加Protobuf功能的强大查询库。
• connect-swift, connect-go: 分别为Swift和Go语言提供的Connect实现，加强多语言间的RPC互操作性。

这些工具和示例项目展示出Connect-ES如何在不同场景下支持不同类型的应用开发，从web前端到后端微服务，乃至跨语言的RPC调用。通过这些丰富的组件，开发者可以构建出既高效又易于维护的服务架构。

connect-esThe TypeScript implementation of Connect: Protobuf RPC that works.项目地址:https://gitcode.com/gh_mirrors/co/connect-es