Newbe.Claptrap 框架依託於一些關鍵性的基礎組件和一些可選的輔助組件。本篇我們來介紹一下如何準備一個開發環境。
必要組件
這些組件是使用本框架進行開發是必須要安裝的組件。
Docker Desktop
Docker Desktop 是以下所有組件運行的基礎。開發可以通過以下鏈接下載對應操作系統的版本並進行安裝:
https://www.docker.com/products/docker-desktop
安裝完畢後,可以在控制檯中使用以下命令驗證安裝效果:
PS C:\Repos\newbe\Newbe.Claptrap.Docs\src> docker --version
Docker version 20.10.2, build 2291f61
中國大陸用戶,需要爲 Docker Desktop 配置好加速鏡像。這將有助於後續環境的安裝。
dotnet SDK
本框架依賴於 net 5 SDK 和 runtime。開發者可以通過以下鏈接下載最新的 SDK 並按照提示進行安裝:
https://dotnet.microsoft.com/download/dotnet/5.0
安裝完畢後,可以在控制檯中使用以下命令驗證安裝效果:
PS C:\Repos\newbe\Newbe.Claptrap.Docs\src> dotnet --version
5.0.103
Tye
Tye 是有微軟開發提供的一款簡化分佈式應用開發的輔助命令行工具。
開發者可以在以下鏈接中找到最新的安裝命令行腳本:
https://www.nuget.org/packages/Microsoft.Tye
安裝完畢後,可以在控制檯中使用以下命令驗證安裝效果:
PS C:\Repos\newbe\Newbe.Claptrap.Docs\src> tye --version
0.6.0-alpha.21070.5+a42e4463943e3136dbd1de38474d8d62b802797c
Dapr
Dapr 是 Newbe.Claptrap 運行的基石。可以通過以下官方文檔瞭解開發環境的安裝方式:
https://docs.dapr.io/getting-started/
中文用戶也可以通過以下鏈接查看中文介紹:
https://dapr-cn.gitee.io/getting-started/
安裝完畢後,可以在控制檯中使用以下命令驗證安裝效果:
PS C:\Repos\newbe\Newbe.Claptrap.Docs\src> dapr --version
CLI version: 1.0.0
Runtime version: 1.0.0
數據庫
Newbe.Claptrap 目前支持 SQLite
/Mysql
/PostgreSQL
/Mongodb
多種數據庫。
開發者可以選擇已經部署好的應用實例,也可以通過以下鏈接獲取本項目開發時使用的docker-compose.yml
文件以部署數據庫:
https://github.com/newbe36524/Newbe.Claptrap/tree/master/src/Docker/Database
可選組件
這些組件是使用本框架進行開發時可選的組件。只有當需要使用到特定特性時才需要使用到。不過,我們仍然建議開發者安裝這些組件。這樣有助於開發者更有效的瞭解系統的運行情況。
Grafana
Grafana 可以將系統的監控數據以圖表的形式展示出來,是一個非常優秀的開源方案。
開發者可以使用以下鏈接中提供的docker-compose.yml
來創建一個用於本項目的 Grafana 實例:
https://github.com/newbe36524/Newbe.Claptrap/tree/master/src/Docker/Monitor
Jaeger
Jaeger 是一款分佈式鏈路監控工具,可以幫助開發者進一步瞭解服務間的關係和性能細節。
開發者可以通過以下鏈接提供的docker-compose.yml
來構建一個用於本項目的 Jaeger 實例:
https://github.com/newbe36524/Newbe.Claptrap/tree/master/src/Newbe.Claptrap.Template/HelloClaptrap
也可以從本項目的項目模板中找到這個docker-compose.yml
文件。關於項目模板的詳細介紹,將在下節進行說明。
Seq
Seq 是一款高效的分佈式日誌管理工具,可以幫助開發者對多個應用程序的日誌進行收集和可視化。
開發者可以通過以下鏈接提供的docker-compose.yml
來構建一個用於本項目的 Seq 實例:
https://github.com/newbe36524/Newbe.Claptrap/tree/master/src/Newbe.Claptrap.Template/HelloClaptrap
也可以從本項目的項目模板中找到這個docker-compose.yml
文件。關於項目模板的詳細介紹,將在下節進行說明。
小結
本篇,我們初步瞭解瞭如何爲 Newbe.Claptrap 項目初始化一個基礎可用的開發環境。
下一篇,我們將使用該環境以及項目模板,創建第一個 Newbe.Claptrap 項目。
本文分享自微信公衆號 - newbe技術專欄(newbe36524)。
如有侵權,請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”,歡迎正在閱讀的你也加入,一起分享。