BeetleX-Samples 项目使用教程

1. 项目介绍

BeetleX-Samples 是一个基于 BeetleX 微服务框架的示例项目集合，涵盖了 TCP、Web API、WebSocket 和 XRPC 等多种服务类型的示例代码。BeetleX 是一个高性能的 .NET 网络库，支持多种协议和框架，适用于构建微服务和分布式系统。

2. 项目快速启动

2.1 环境准备

• .NET SDK 5.0 或更高版本
• Git

2.2 克隆项目

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

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

2.3 运行示例

选择一个示例项目，例如 Web/Hello，进入项目目录并运行：

cd Web/Hello
dotnet run

这将启动一个简单的 Web API 服务，默认监听端口为 8080。

2.4 访问示例

打开浏览器，访问 http://localhost:8080，你将看到示例服务的输出。

3. 应用案例和最佳实践

3.1 构建高性能 Web API

BeetleX 提供了高性能的 HTTP 服务器，适用于构建高并发的 Web API 服务。以下是一个简单的 Web API 示例：

using BeetleX.WebFamily;

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);
        var app = builder.Build();

        app.MapGet("/", () => "Hello, BeetleX!");

        app.Run();
    }
}

3.2 实现 WebSocket 通信

BeetleX 支持 WebSocket 协议，可以用于构建实时通信应用。以下是一个简单的 WebSocket 示例：

using BeetleX.WebFamily;
using BeetleX.WebFamily.WebSocket;

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);
        var app = builder.Build();

        app.UseWebSocket("/ws", async (context, next) =>
        {
            var socket = await context.WebSockets.AcceptWebSocketAsync();
            await socket.SendAsync("Hello, WebSocket!");
        });

        app.Run();
    }
}

4. 典型生态项目

4.1 BeetleX 微服务框架

BeetleX 微服务框架是一个基于 BeetleX 的高性能微服务解决方案，支持服务注册与发现、负载均衡、熔断降级等功能。

4.2 BeetleX.WebFamily

BeetleX.WebFamily 是一个基于 BeetleX 的 Web 开发框架，提供了丰富的中间件和工具，适用于快速构建 Web 应用。

4.3 BeetleX.XRPC

BeetleX.XRPC 是一个基于 BeetleX 的 RPC 框架，支持多种序列化协议和传输协议，适用于构建高性能的分布式系统。

通过以上模块的介绍和示例，你可以快速上手 BeetleX-Samples 项目，并了解其在实际应用中的最佳实践和生态项目。