project omega

project omega

您将需要的最后一个企业 Web 架构模式。直到下一篇。

长话短说

目标是通过以下方式优化开发人员体验：

• 像整体一样进行本地开发
• 部署为单独的微服务
• 使用docker在本地模拟生产环境

演示

project omega概念验证 - 微服务整体混合

project omega演示 - Kubernetes 微服务和独立容器部署

为什么

我想证明我们不必牺牲开发人员的效率来获得可扩展性。有关微服务和单体应用的优缺点的更多讨论请参见：微服务和单体应用。

我的印象是，许多行业专家会让我们相信以下是我们的主要 3 个选择：

• 巨石
• 微服务
• “混合”（不是真正的混合，既是整体，也是一些微服务）

我想表明我们不必选择这些选项中的任何一个。只要有一点创造力，我们就可以拥有一个真正的“混合体”，它既是一个整体，又是一组微服务。根据我目前的策略，我认为我们无法消除单体应用和微服务的所有缺点，但我们可以消除两者的许多痛点。

它不是什么

• 我并不是想创建一个框架（至少还没有......）。我只是将我拥有的所有乐高积木组装成不同的配置作为实验。
• 这并不意味着是一个社区项目。我打算经常进行重大的重大更改，恕不另行通知。如果您对这个概念感兴趣并且想做出贡献，请先与我联系。

项目目标

• 创建一种模式，既适用于小型单个开发人员的业余爱好项目，也适用于数十甚至数百个开发人员处理大型复杂的企业 Web 应用程序。
• 能够像整体一样进行本地开发：
  • 一个存储库。出于同样的原因，公司选择单一回购方法。
  • 最多运行 3 个进程（客户端 UI、服务器、docker 数据库依赖项、消息队列等）。我们不希望安装文档页面启动并运行。
• 能够部署为微服务。
• 能够模拟在 Docker 容器中运行微服务的生产环境。
• 设置时间极快。除 Node 和 .NET 之外的所有依赖项都应包含为 docker 依赖项（数据库、消息队列等）。新用户应该能够安装 .NET、Node、克隆存储库，然后执行安装和运行命令。
• 在开发环境中，客户端和服务器都可以实现极快的热重载。
• 能够在 Windows、Linux 和 Mac 上开发和运行应用程序。
• 能够快速启动新服务。

技术堆栈

技术堆栈与我试图证明的高级概念基本上无关，但对于这个项目我将使用：

• .NET 5 服务
• React 前端（带有打字稿的基本 create-react-app）
• 码头工人

高层概念

拥有大型应用程序的公司越来越多地被推向微服务，以便它们可以水平扩展（以及其他原因）。因此，为了实现这一目标，我们正在考虑以下内容：

这是另一个版本，显示了可能实现水平缩放的一种方法：

一旦我们沿着这条路走下去，我们最终就会遇到当地发展的真正问题。这实际上取决于产品是什么样的、有多少开发人员、以及谁在做什么、多久工作一次。话虽这么说，很大一部分选择微服务的公司最终都会陷入这样的境地：开发人员必须就如何进行日常开发做出一些艰难的选择。 project omega的目标是表明，我们可以通过在本地运行时将所有服务合并到一个应用程序中来消除本地运行服务的开销：

这是文件夹结构：

这是部署为微服务的样子：

每个实例都有所有代码的副本，但仅运行特定微服务的初始化、服务端点路由和工作进程。

这就是为什么在本地将应用程序作为整体运行如此简单，因为我们只需查找名为SERVICE_KEY的环境变量，或者如果它不存在，则初始化所有服务。

其他服务特定初始化的示例：

• 依赖注入设置
• 数据库连接字符串
• 数据库迁移
• 消息队列初始化
• 设置分布式缓存连接
• 其他云资源连接设置
• 第三方API初始化

当调用 Startup 时，它会扫描程序集以查找继承ProjectOmegaService的类型，创建一个实例并运行该服务的初始化逻辑。当本地运行时，它将运行所有这些。

设置说明

安装先决条件：

• .NET 5
• 节点
• 纱
• 码头工人

请注意，如果您有一段时间没有执行此操作，那么获取在 Windows 上运行的最新版本的 docker 可能需要一些额外的步骤，例如安装 WSL 2 和刷新 WSL 发行版。请遵循 Docker 网站上的任何说明。

步骤：

• 克隆这个仓库
• 在存储库根目录的终端中，运行yarn run installAll
• 如果您想在 1434 以外的端口上运行 SQL Server：
  • 运行yarn run syncEnvFiles
  • 更改.env.server中的OMEGA_DEFAULT_DB_PORT和OMEGA_MSSQL_HOST_PORT
• 使用命令yarn run dockerDepsUpDetached启动依赖项
• 第一次运行时运行数据库迁移，或者当您通过数据库更新获得其他人的更改时： yarn run dbMigrate
• 使用以下选项之一在本地开发模式下运行应用程序：
  • 选项 1：在存储库根目录的终端中yarn run both （这同时用于运行选项 2 中的命令）
  • 选项 2：使用 2 个独立的终端。在一个终端中运行yarn run client ，在另一个终端中运行yarn run server
• 访问 https://localhost:3000 （点击过去的 https 警告）

在第一次使用dotnet test运行单元测试之前或在新的数据库架构上添加单元测试之后：

• 如果尚未使用yarn run dockerDepsUpDetached运行，则启动依赖项
• 运行yarn run testDbMigrate
• 然后运行dotnet test

在 docker 中模拟生产和微服务：

• 确保 docker 依赖项正在使用yarn run dockerDepsUpDetached运行
• 在存储库根目录的终端中，运行yarn run dockerRecreateFull
• 访问 https://localhost:3000 （点击过去的 https 警告）

下一步

• 记录更改
  • 使用 Serilog json 格式化程序进行实验
  • 将相关 ID 和其他上下文信息添加到日志条目
• 添加附加文档
  • docker 模拟工作原理图
  • Docker 依赖项
    • 文字描述它是什么、它是如何工作的
    • docker deps 如何融入开发流程的图表
  • 路由/代理文档
  • 数据库迁移
• 服务之间的 RPC 测试而不是 http 休息调用（可能使用类似这样的内容：https://github.com/aspnet/AspLabs/tree/main/src/GrpcHttpApi）
• 添加到服务间客户端基类以抽象错误处理和日志记录
• 认证实施
  • 前端站点注册
  • 服务到服务身份验证（OAuth？）
• 自动文档生成（swagger和html xml文档输出）
• 队列设置和工作进程服务
  • 抽象队列定义（允许使用云服务作为选项）
  • 具有查找消息的事件循环的基本工作进程类型服务
  • docker-compose.deps.yml 中的 RabbitMQ
  • 连接到工作进程服务的 RabbitMQ 基本实现
• 额外的本地 kubernetes 演示工作
  • 数据库可能需要学习如何使用 kubernetes 持久卷，除非我能弄清楚如何调整网络以公开主机数据库
  • 添加 Seq 或将 Seq 功能设置为可选，并且在 kubernetes 中运行时不要使用它
• 用于分析解决方案的元项目/脚本
  • 根据更改的文件分析受影响的服务（用于部署的粒度）
• 项目脚手架：
  • 能够使用除 Omega 之外的其他项目“密钥”为所有项目/目录名称启动项目的新副本
  • 能够让新项目启动 Docker 容器并进行有效的集成测试，以确保成功创建新项目

杂项

如果您在 Linux 上进行开发，启动服务器时可能会遇到以下错误：

System.AggregateException：发生一个或多个错误。 （已达到 inotify 实例数量的配置用户限制 (128)，或已达到打开文件描述符数量的每进程限制。）

这可能是由于 vscode 使用了太多文件监视造成的。您可以通过运行以下命令来增加inotify实例限制（不仅仅是监视限制，该限制可能已经在/etc/sysctl.conf文件中设置得非常高）：

echo fs.inotify.max_user_instances=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

其他文件

设计模式成本效益分析：DesignPatternCostBenefit.md

设计模式变体：DesignPatternVariations.md

决策：Decisions.md

软件开发理念和咆哮：https://gist.github.com/mikey-t/3d5d6f0f5316abf9e74fb553be9fdef3