BeetleX-Samples 项目教程

1. 项目介绍

BeetleX-Samples 是一个基于 BeetleX 服务框架的示例项目集合，涵盖了 HTTP、WebSocket、Web API 和 XRPC 等多种服务类型。BeetleX 是一个高性能的 .NET 网络库，适用于构建微服务和分布式系统。通过这些示例，开发者可以快速了解和掌握 BeetleX 框架的使用方法，并将其应用于实际项目中。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保你已经安装了以下工具和环境：

• .NET SDK（建议版本：5.0 或以上）
• Git

2.2 克隆项目

首先，克隆 BeetleX-Samples 项目到本地：

git clone https://github.com/IKende/BeetleX-Samples.git
cd BeetleX-Samples

2.3 运行示例

进入你感兴趣的示例目录，例如 Web 目录下的 Hello 示例：

cd Web/Hello
dotnet run

这将启动一个简单的 Web 服务，你可以在浏览器中访问 http://localhost:5000 来查看运行结果。

3. 应用案例和最佳实践

3.1 构建一个简单的 Web API

在 Web/ApiDoc 目录下，你可以找到一个使用 BeetleX 构建的简单 Web API 示例。该示例展示了如何定义路由、处理请求和返回响应。

using BeetleX.FastHttpApi;

[Controller]
public class ApiController
{
    [Get(Route = "/api/hello")]
    public object Hello()
    {
        return new { message = "Hello, BeetleX!" };
    }
}

3.2 使用 WebSocket 实现实时通信

在 WebSocket/Chat 目录下，你可以找到一个使用 WebSocket 实现的简单聊天室示例。该示例展示了如何处理 WebSocket 连接、发送和接收消息。

using BeetleX.FastHttpApi;
using BeetleX.FastHttpApi.WebSockets;

[Controller]
public class ChatController
{
    [WebSocket(Route = "/ws/chat")]
    public void Chat(WebSocket socket, string message)
    {
        socket.Send(message);
    }
}

4. 典型生态项目

4.1 BeetleX 框架

BeetleX 是一个高性能的 .NET 网络库，支持 TCP、HTTP、WebSocket 等多种协议。它提供了简单易用的 API，适用于构建微服务和分布式系统。

4.2 BeetleX.FastHttpApi

BeetleX.FastHttpApi 是 BeetleX 框架的一部分，专门用于构建高性能的 Web API。它支持路由、中间件、WebSocket 等功能，适合用于构建 RESTful API 和实时通信应用。

4.3 BeetleX.XRPC

BeetleX.XRPC 是 BeetleX 框架的扩展，支持基于 TCP 的远程过程调用（RPC）。它提供了高效的序列化和反序列化机制，适合用于构建分布式系统中的服务间通信。

通过这些示例和生态项目，你可以快速上手 BeetleX 框架，并将其应用于各种实际项目中。