要使用Util應用框架開發項目,首先需要搭建合適的開發環境.
邁出第一步,對於很多.Net新人可能並不簡單.
如果你對.Net環境並不熟悉,請儘量按照本文檔進行操作.
操作系統
請安裝 Windows 10 以上版本操作系統.
你也可以使用MAC操作系統,但需要自行解決開發環境問題.
安裝 Visual Studio
本文將引導你安裝 Visual Studio 企業版,並創建一個Web Api項目驗證安裝是否成功.
如果你已經安裝Visual Studio,請跳過安裝 Visual Studio步驟,但你可能仍需升級.Net SDK.
Util應用框架使用最新的.Net SDK穩定版本,目前是 v7.x.
安裝 Visual Studio企業版
打開 Visual Studio下載頁面, 找到 下載 Visual Studio 鏈接,點擊下載.
下載後進行安裝,它是一個在線安裝包,需要聯網.
點擊 繼續 按鈕.
默認安裝 Visual Studio Community ,即Visual Studio社區版.
如果你想安裝 Visual Studio 企業版,請關閉該彈出窗口.
選擇 可用 選項卡.
安裝 Visual Studio Enterprise 2022.
勾選 ASP.NET和Web開發, 單擊 安裝 按鈕.
安裝完成,重啓電腦.
運行 Visual Studio
下面創建一個Web Api項目,以驗證 Visual Studio 是否安裝成功.
打開Visual Studio.
如果不想登錄,就選擇 暫時跳過此項.
開發設置選擇 Visual C#, 選擇你喜歡的主題色,啓動 Visual Studio.
點擊 創建新項目.
選擇 ASP.NET Core Web API 項目類型,點擊 下一步 按鈕.
使用默認項目名稱,點擊 下一步 按鈕.
框架選擇 .Net 7.0,其它使用默認值,點擊 創建 按鈕.
按 F5 鍵,或點擊圖中 https 按鈕, 運行Web Api項目.
由於配置了Https,需要信任開發證書.
在彈出的 信任 Asp.Net Core SSL證書 對話框中,勾選 不再詢問,點擊 是 按鈕.
在彈出的 安全警告 對話框中, 點擊 是 按鈕.
如果看到上圖Swagger UI,則說明安裝成功.
升級.Net SDK
如果你的 Visual Studio 是新安裝的,則.Net SDK已經是最新.
如果你的 Visual Studio 是之前安裝的,請進行更新.
打開 Visual Studio Installer, 點擊 更新 按鈕.
安裝 Resharper
Visual Studio作爲最強集成開發工具,雖然各方面功能和體驗都相當優秀,但Resharper插件可以讓Visual Studio的開發效率更上一層樓.
安裝Resharper是可選的,你如果不想安裝它也沒有影響.
很多有經驗的.Net開發人員使用 Resharper,Util應用框架的開發也嚴重依賴 Resharper.
如果有條件,可以嘗試使用它,一旦上手,後續將成爲你的必備工具.
安裝條件
並不是任何電腦都適合安裝Resharper,它對電腦的配置要求相當高.
你需要一塊固態硬盤,內存和CPU越高越好.
友情提示
當你打開Visual Studio項目的前幾分鐘,不要操作它.
在項目剛打開的前幾分鐘,Resharper會掃描和加載緩存,這段時間非常卡,你可以暫停工作,喝杯茶休息一下.
一般來講,前幾分鐘卡頓之後,後續操作Visual Studio沒有太大影響.
但如果你的電腦配置比較低,還出現無法忍受的卡頓,只有卸載Resharper,或更新電腦配置.
下載安裝 Resharper
打開 Resharper下載頁面,點擊 Download 下載安裝.
安裝 Docker Desktop
Docker是一種打包和運行應用程序的新方式.
Docker Desktop是 Docker的Windows桌面版本,它可以爲開發環境提供依賴組件,同時也可以爲項目的本地發佈測試提供支持.
Docker Desktop是可選的
使用Util應用框架開發項目,需要數據庫的支持.
本文檔採用Docker Desktop啓動開發數據庫,如果你已經安裝了數據庫,也可以不必安裝Docker Desktop.
不過現代化的開發,除了數據庫外,還可能有其它依賴組件,比如redis,rabbitmq,elasticsearch,minio,seq等,也可能需要同時支持多種數據庫類型,比如sql server,mysql,pgsql等.
你可以事先安裝好這些組件,讓整個團隊共用,也可以使用本機Docker爲開發人員提供獨佔組件而互不干擾.
另外,使用Util應用框架開發基於Dapr的微服務項目時,需要Visual Studio Docker Compose容器化項目類型,該技術依賴Docker Desktop.
更新 Windows操作系統
安裝之前,請先更新Windows操作系統,如果你的操作系統比較老,可能安裝會有問題.
安裝WSL
WSL 是 Windows Subsystem for Linux 的縮寫，用於在Windows上運行Linux環境.
與在傳統虛擬機安裝Linux相比,它使用更方便,且開銷更小.
Docker Desktop需要WSL 2.
使用命令行方式安裝WSL
以管理員模式打開Windows PowerShell.
鼠標右鍵單擊開始菜單,選擇 Windows PowerShell(管理員).
運行命令:
wsl --install
該安裝命令有很多限制,如果你運行此命令安裝失敗,可以改用下面的圖形界面方式安裝WSL.
使用圖形界面安裝WSL
打開 Windows設置.
點擊 應用 按鈕, 打開 應用和功能 設置界面.
點擊 程序和功能 按鈕, 打開 卸載或更改程序 設置界面.
點擊 啓用或關閉Windows功能 按鈕, 打開 Windows功能 設置界面.
勾選 適用於 Linux 的 Windows 子系統 和 虛擬機平臺,點擊確定按鈕.
安裝完成重啓電腦.
驗證WSL安裝是否成功
運行命令:
wsl -v
如果看到類似下圖提示,即安裝成功.
-
更新WSL
最後,更新一下WSL的版本.
運行命令:
wsl --update
安裝Docker Desktop
點擊 Docker Desktop for Windows 按鈕,開始下載.
下載完成進行安裝.
點擊 OK按鈕.
安裝完成.
運行Docker Desktop
下面運行Docker Desktop.
點擊 Accept.
不用登錄,點擊 Continue Without Signing In.
點擊 Skip,進入Docker Desktop主界面.
設置Docker國內源
Docker默認從國外倉庫拉取鏡像,導致下載非常緩慢.
需要設置國內源,從國內鏡像站下載.
點擊右上角的設置按鈕.
選擇 Docker Engine 選項卡,設置如下.
"registry-mirrors": [
"http://hub-mirror.c.163.com"
]
http://hub-mirror.c.163.com 是網易提供的Docker鏡像源,你也可以使用其它鏡像源.
點擊 Apply & restart,應用設置並重啓Docker桌面.
驗證Docker Desktop
下面運行一個nginx容器,看看Docker桌面是否工作正常.
運行命令:
docker run -d --name nginx -p 8088:80 nginx
如果運行成功,你會看見nginx容器,點擊 8088:80鏈接.
瀏覽器顯示nginx默認頁面,則說明Docker桌面安裝和配置成功完成.
參考
安裝 數據庫
Util代碼生成需要專用數據庫.
本文使用Docker安裝數據庫.
如果你已有現成的數據庫,請跳過該步驟.
Util代碼生成器支持的數據庫類型
- Sql Server
- PostgreSql
- MySql
目前代碼生成支持上面三種數據庫,你需要安裝任意一種.
如果你的項目使用其它數據庫,並且不想安裝上面的數據庫,請告知我們.
安裝 Sql Server
使用 Docker 安裝 Sql Server 服務器
創建 sqlserver-data 卷, 運行命令.
docker volume create sqlserver-data
創建 Sql Server 容器, 運行命令.
docker run -d --restart=always --name=sqlserver -e MSSQL_SA_PASSWORD=Pass@word -e ACCEPT_EULA=Y -p 1433:1433 -v sqlserver-data:/var/opt/mssql mcr.microsoft.com/mssql/server:2022-latest
容器名稱: sqlserver
用戶名: sa
密碼: Pass@word
連接端口: 1433
安裝成功後,Docker容器列表出現 sqlserver 容器.
安裝 Sql Server 客戶端
打開 Sql Server Management Studio下載頁面,找到 免費下載 SQL Server Management Studio (SSMS),點擊下載.
下載完成, 運行 Sql Server Management Studio 安裝包.
點擊 安裝 按鈕.
Sql Server Management Studio 安裝完成.
驗證 Sql Server
下面使用 Sql Server Management Studio 連接 Sql Server服務器,驗證Sql Server數據庫是否工作正常.
點擊 Windows 開始菜單,打開 Sql Server Management Studio 客戶端工具.
服務器名稱: . 代表本機,默認端口爲 1433,如果使用其它端口,服務器名稱與端口之間使用逗號分隔,比如 .,5433 ,表示連接本機5433端口.
身份驗證: 選擇 Sql Server身份驗證
用戶名: sa
密碼: Pass@word
點擊 連接 按鈕,看到下圖則說明連接成功.
安裝 PostgreSql
使用 Docker 安裝 PostgreSql 服務器
創建 pgsql-data 卷, 運行命令.
docker volume create pgsql-data
創建 PostgreSql 容器, 運行命令.
docker run -d --restart=always --name=pgsql -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=admin -p 5432:5432 -v pgsql-data:/var/lib/postgresql/data postgres:15.3-alpine3.18
容器名稱: pgsql
用戶名: admin
密碼: admin
連接端口: 5432
安裝成功後,Docker容器列表出現 pgsql 容器.
安裝 PostgreSql 客戶端
PostgreSql 客戶端有很多選擇,下面推薦兩款常用工具.
這兩款工具均支持多種數據庫類型,請自行安裝.
安裝 MySql
使用 Docker 安裝 MySql 服務器
創建 mysql-data 卷, 運行命令.
docker volume create mysql-data
創建 MySql 容器, 運行命令.
docker run -d --restart=always --name=mysql -e MYSQL_ROOT_PASSWORD=admin -p 3306:3306 -v mysql-data:/var/lib/mysql mysql:8.0.33
容器名稱: mysql
用戶名: root
密碼: admin
連接端口: 3306
安裝成功後,Docker容器列表出現 mysql 容器.
安裝 MySql 客戶端
MySql 客戶端有很多選擇,下面推薦兩款常用工具.
這兩款工具均支持多種數據庫類型,請自行安裝.
參考
安裝 Git客戶端
Git 是一個流行的分佈式源代碼版本控制工具.
本文幫助你安裝 Git 客戶端.
如果你已經安裝,請跳過該步驟.
安裝 Git
從官方下載 Git
打開 官方Git下載頁面,找到 Click here to download 鏈接,點擊下載.
官方下載地址鏈接到 Github,如果你訪問困難,請使用下面的鏡像地址.
從阿里鏡像下載 Git
打開 阿里鏡像Git下載頁面, 找到 Git-2.42.0.2-64-bit.exe 鏈接,點擊下載.
安裝 Git
下載完成開始安裝,全部使用默認選項即可.
安裝完成,運行命令驗證是否安裝成功.
git -v
安裝 TortoiseGit
TortoiseGit 是一個易用的 Git 圖形界面管理工具, 你如果不喜歡使用命令行, 可以使用它.
下載 TortoiseGit
打開 TortoiseGit下載頁面,下載Windows 64位版本.
下載 TortoiseGit 簡體中文語言包
安裝 TortoiseGit
安裝 TortoiseGit 和簡體中文語言包,全部使用默認選項即可.
安裝完成後,鼠標右鍵菜單會增加一些操作.
設置 TortoiseGit 簡體中文
鼠標右鍵彈出菜單,選擇 TortoiseGit -> Settings 子菜單.
在設置界面,選擇 General ,語言選擇 中文(簡體).
點擊 確定 按鈕,再次查看鼠標右鍵菜單,已經顯示爲中文.
參考
下載Util應用框架配套的代碼生成模板
Util應用框架配套代碼生成器是一個簡單的命令行程序,支持少量配置.
用於幫助你快速創建基礎項目結構,解決機械代碼的編寫.
本文引導你從Git倉庫拉取Util代碼生成器項目.
考慮到Util默認提供的代碼模板可能無法滿足你的項目要求,所以沒有將它發佈成Cli命令.
你在項目開發過程中,如果發現需要大量複製粘貼的機械工作,可以添加新的代碼生成模板.
準備工作
你需要創建一個目錄來存放Util代碼生成器項目,比如 Util-Projects.
使用Git命令行方式拉取Util代碼生成器項目
進入Util-Projects目錄,按住 Shift 鍵,鼠標右鍵單擊目錄空白區域,彈出菜單選擇 在此處打開PowerShell窗口.
注意: 不同操作系統顯示的菜單項不同,找到命令提示符的選項.
執行命令:
git clone https://github.com/util-core/Util.Generator.git
如果訪問github困難,也可以從gitee拉取.
git clone https://gitee.com/util-core/Util.Generator.git
使用TortoiseGit工具拉取Util代碼生成器項目
如果你更喜歡使用圖形界面,可使用 TortoiseGit 工具拉取Git項目.
進入Util-Projects目錄, 右鍵單擊彈出菜單,選擇 Git克隆.
在Git克隆界面,將Github或Gitee地址複製到URL,點擊 確定 按鈕開始下載.
拉取完成,在目錄中應該看到 Util.Generator 項目代碼.
Util應用框架Web Api開發環境搭建完成,下一篇將介紹如何使用代碼生成器創建Web Api項目.