Brighter 框架技术文档

1. 安装指南

NuGet 包安装

Brighter 框架可以通过 NuGet 包管理器进行安装。在 Visual Studio 中，您可以使用以下方法之一：

• 使用 NuGet 包管理器控制台：

  Install-Package Paramore.Brighter
  

• 在项目文件中添加以下 XML 节点：

  <PackageReference Include="Paramore.Brighter" Version="最新版本" />
  

• 使用 Paket 命令行工具：

  paket add Paramore.Brighter --version 最新版本
  

• 在 F# Interactive 或 Polyglot Notebook 中使用以下指令：

  #r "nuget: Paramore.Brighter, 最新版本"
  

您可以从 NuGet 官网 下载最新版本的 NuGet 包。

Docker Compose 测试

我们提供了一个 Docker Compose 文件，用于运行测试套件，而不需要本地安装预置条件，如代理或数据库。要运行它，您需要将 redis sentinel 扩展到至少 3 个节点，并使用至少两个 redis 从节点。例如：

docker-compose up -d --build --scale redis-slave=2 --scale redis-sentinel=3

这样可以让您尽可能轻松地开始使用 Brighter 进行开发。

请注意，如果您本地安装了这些服务，您需要停止它们或编辑本地版本的 docker compose 文件。

2. 项目的使用说明

Brighter 是一个用于构建消息应用的框架，支持 .NET 和 C#。它可以用内存总线或在微服务架构中通过多种中间件传输进行进程间通信。

使用场景

• 实现清洁架构（端口和适配器）时，如何实现交互器或端口层（有时称为中介者）是一个问题。

  • 一种常见的解决方案是使用命令模式实现交互器（端口）或从该模式派生的模式。
  • Brighter 使用命令调度器模式提供了一个交互器（端口）的实现。
  • 您可以编写一个命令，然后由您编写的处理器进行调度。
  • 或者，您可以编写一个事件，然后由零个或多个您编写的处理器进行调度。
  • Brighter 还支持命令处理器模式，允许您在发送者和处理器之间添加中间件。
  • 处理器通过属性标记以包含其管道中的中间件。
  • 提供了用于日志记录和 Polly（重试和断路器）的即插即用中间件。

• 在使用消息传递集成两个微服务时，如何抽象开发者发送和接收消息的代码，以便编写领域代码是一个问题。

  • 一种常见的解决方案是消息泵，它获取消息、翻译消息并将其调度到用户代码。
  • Brighter 提供了一个服务激活器，实现了消息泵。
  • 消息泵通过 Brighter 的命令调度器/处理器将消息调度到用户代码。
  • 这隐藏了消息泵的复杂性；开发者只需编写一个订阅消息的处理器。
  • 这隐藏了消息传递的复杂性，开发者只需编写命令/事件和处理器。
  • 开发者可以在处理消息时充分利用 Brighter 的中间件管道。
  • Brighter 可以配置为使用多种传输，包括 RabbitMQ 和 SNS+SQS。

3. 项目API使用文档

详细的 API 文档可以在项目的 GitBook 页面上找到：Paramore Brighter 文档。

4. 项目安装方式

请参考上述“安装指南”部分，了解如何通过 NuGet 包管理器或 Docker Compose 安装 Brighter 框架。