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