在第二部分(微服務基礎工具與技術)中我們講解了GitHub Action的相關知識,那么在這一節中,我們將為已有的微服務增加GitHub Action的支持。
一、什么是GitHub Action
雖然前面已經介紹過GitHub Action的相關知識,但這里還是簡單回顧一下。GitHub Action是GitHub提供的一種持續集成和持續交付(CI/CD)服務,允許開發者在代碼庫中定義自動化工作流,以便在特定事件發生時自動執行任務。通過GitHub Action,開發者可以實現代碼的自動構建、測試、部署等操作,從而提高開發效率和代碼質量。
GitHub Action的工作流是由一系列的步驟(steps)組成的,每個步驟可以執行一個或多個操作(actions)。這些操作可以是預定義的,也可以是自定義的腳本。工作流可以在代碼提交、拉取請求、定時任務等多種事件觸發下運行。
GitHub Action的主要優勢包括:
- 自動化:可以自動執行重復性任務,減少手動操作。
- 集成:與GitHub緊密集成,可以直接在代碼庫中管理工作流。
- 可擴展性:支持自定義操作,可以根據項目需求擴展功能。
- 社區支持:有大量的預定義操作可供使用,可以快速集成常用功能。
- 可視化:提供了直觀的界面來查看工作流的執行狀態和日志。
GitHub Action的工作流文件通常存儲在代碼庫的.github/workflows
目錄下,文件格式為YAML。每個工作流可以定義觸發條件、執行步驟、環境變量等。
二、創建 Dockerfile
我們依然以SP.ConfigService
配置服務為例,創建一個Dockerfile
文件。這個文件將定義如何構建配置服務的Docker鏡像。
# 使用官方.NET 8.0 SDK鏡像作為構建階段
FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
WORKDIR /src# 復制項目文件
COPY ["SP.ConfigService/SP.ConfigService.csproj", "SP.ConfigService/"]
COPY ["SP.Common/SP.Common.csproj", "SP.Common/"]# 還原NuGet包
RUN dotnet restore "SP.ConfigService/SP.ConfigService.csproj"# 復制所有源代碼
COPY . .# 構建應用程序
WORKDIR "/src/SP.ConfigService"
RUN dotnet build "SP.ConfigService.csproj" -c Release -o /app/build# 發布應用程序
FROM build AS publish
RUN dotnet publish "SP.ConfigService.csproj" -c Release -o /app/publish /p:UseAppHost=false# 使用官方.NET 8.0運行時鏡像作為最終階段
FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS final
WORKDIR /app# 安裝必要的系統包(如果需要)
RUN apt-get update && apt-get install -y \curl \&& rm -rf /var/lib/apt/lists/*# 創建非root用戶
RUN groupadd -r appuser && useradd -r -g appuser appuser# 復制發布的應用程序
COPY --from=publish /app/publish .# 設置文件權限
RUN chown -R appuser:appuser /app
USER appuser# 暴露端口
EXPOSE 80
EXPOSE 443# 設置環境變量
ENV ASPNETCORE_URLS=http://+:80
ENV ASPNETCORE_ENVIRONMENT=Production# 啟動應用程序
ENTRYPOINT ["dotnet", "SP.ConfigService.dll"]
這個Dockerfile
文件完整地描述了從源代碼到可運行鏡像的構建流程。它采用多階段構建,先用官方.NET 8.0 SDK鏡像進行編譯和發布,確保最終鏡像僅包含運行所需內容,從而減小體積并提升安全性。項目文件和依賴會被優先復制和還原,避免無關文件影響構建。隨后將所有源代碼復制到鏡像中,完成編譯和發布,生成可部署的應用程序文件。最終階段使用.NET 8.0 ASP.NET運行時鏡像,僅包含必要的運行環境,進一步優化鏡像體積。為提升安全性,Dockerfile創建了非root用戶appuser
并設置了文件權限,降低容器運行時的安全風險。鏡像還暴露了80和443端口,并配置了應用程序的運行環境變量,確保服務能在生產環境下正常運行。最后通過ENTRYPOINT
指定應用程序的啟動方式,使容器啟動后自動運行服務。通過這樣的配置,可以實現微服務的標準化部署,為后續集成到GitHub Action自動化流程打下堅實基礎。
在創建完Dockerfile
后,我們需要創建.dockerignore
文件,以避免將不必要的文件添加到Docker鏡像中。當然,這一步并不是必須的,但我建議大家都這么做,以保持鏡像的整潔和高效。以下是配置服務的.dockerignore
文件:
# 構建輸出
bin/
obj/# 用戶特定文件
*.user
*.suo
*.userosscache
*.sln.docstates# 構建結果
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
build/
bld/
[Bb]in/
[Oo]bj/# MSTest測試結果
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*# NuGet包
*.nupkg
# NuGet Symbol包
*.snupkg
# 包文件夾
**/[Pp]ackages/*
# 除了build/,它被NuGet用作緩存
!**/[Pp]ackages/build/# 其他
*.swp
*.*~
project.lock.json
.DS_Store
*.pyc
nupkg/# Visual Studio緩存/選項目錄
.vs/# ReSharper
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user# TeamCity
_TeamCity*# DotCover
*.dotCover# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*# MightyMoose
*.mm.*
AutoTest.Net/# Web workbench (sass)
.sass-cache/# Installshield輸出文件夾
[Ee]xpress/# DocProject是一個文檔生成器
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html# Click-Once目錄
publish/# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
*.pubxml
*.publishproj# Microsoft Azure Web App發布設置
PublishScripts/# NuGet包
*.nupkg
# NuGet Symbol包
*.snupkg
# 包文件夾
**/[Pp]ackages/*
# 除了build/,它被NuGet用作緩存
!**/[Pp]ackages/build/# Windows Azure Build Output
csx/
*.build.csdef# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload# Visual Studio緩存文件
# 文件以.vs結尾
.vs/# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs# 包含敏感信息的文件
*.pfx
*.key# 由于構建過程,忽略用戶特定文件
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates# 用戶特定文件(MonoDevelop/Xamarin Studio)
*.userprefs# Mono自動生成的文件
mono_crash.*# Windows圖像緩存文件
Thumbs.db
ehthumbs.db# 文件夾配置文件
[Dd]esktop.ini# 回收站
$RECYCLE.BIN/# Windows Installer文件
*.cab
*.msi
*.msix
*.msm
*.msp# Windows快捷方式
*.lnk# JetBrains Rider
.idea/
*.sln.iml# 日志文件
*.log# 臨時文件
*.tmp
*.temp# Docker相關
Dockerfile*
docker-compose*
.dockerignore# Git相關
.git/
.gitignore# 其他IDE文件
.vscode/
*.code-workspace
這個.dockerignore
文件包含了常見的忽略規則,確保在構建Docker鏡像時不會將不必要的文件添加進去,從而減小鏡像體積并提高構建效率。通過排除如編譯輸出目錄(bin/
、obj/
)、用戶和IDE相關文件(如.vs/
、.idea/
、*.user
)、日志和臨時文件,以及敏感信息文件(如*.pfx
、*.key
),可以有效避免將無關或敏感內容打包進鏡像。這不僅提升了鏡像的安全性和可維護性,也加快了構建過程,減少了存儲和網絡資源的消耗。建議在每個微服務項目中都維護一個合理的.dockerignore
文件,以便持續集成和自動化部署時獲得更好的體驗和結果。
三、創建 GitHub Action
在創建完Dockerfile
和.dockerignore
文件后,我們就可以為配置服務創建GitHub Action工作流文件了。我們將在項目的.github/workflows
目錄下創建一個名為deploy-config-service.yml
的文件,內容如下:
name: Deploy Config Serviceon:push:branches: [ Microservices ]paths:- 'SP.ConfigService/**'jobs:deploy:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v3- name: Set up Docker Buildxuses: docker/setup-buildx-action@v2- name: Login to Docker Hubuses: docker/login-action@v2with:username: ${{ secrets.DOCKER_USERNAME }}password: ${{ secrets.DOCKER_PASSWORD }}- name: Build and push Docker imageuses: docker/build-push-action@v4with:context: .file: ./SP.ConfigService/Dockerfilepush: truetags: ${{ secrets.DOCKER_USERNAME }}/sp-config-service:latest- name: Deploy to Serveruses: appleboy/ssh-action@masterwith:host: ${{ secrets.SERVER_HOST }}username: ${{ secrets.SERVER_USERNAME }}key: ${{ secrets.SERVER_SSH_KEY }}script: |docker pull ${{ secrets.DOCKER_USERNAME }}/sp-config-service:latestdocker stop sp-config-service || truedocker rm sp-config-service || truedocker run -d --name sp-config-service -p 5101:80 ${{ secrets.DOCKER_USERNAME }}/sp-config-service:latest
在這個工作流文件中,我們定義了一個名為“Deploy Config Service”的工作流。當代碼推送到Microservices
分支且涉及SP.ConfigService
目錄下的文件時,工作流將被觸發。工作流包含一個名為“deploy”的作業,運行在最新的Ubuntu環境中。作業步驟首先使用actions/checkout@v3
操作簽出代碼庫,然后設置Docker Buildx環境以支持多平臺構建。接下來,通過docker/login-action@v2
操作登錄到Docker Hub,使用存儲在GitHub Secrets中的憑據確保安全性。隨后,利用docker/build-push-action@v4
操作構建并推送配置服務的Docker鏡像到Docker Hub,指定了上下文和Dockerfile路徑,并打上最新標簽。最后,使用appleboy/ssh-action@master
操作通過SSH連接到遠程服務器,拉取最新的Docker鏡像,停止并刪除現有的配置服務容器(如果存在),然后以守護態運行新的配置服務容器,映射端口5101到容器的80端口。通過這種方式,實現了從代碼提交到自動構建、推送和部署的完整CI/CD流程,大大提升了開發和運維效率。
我們在創建的yml文件中看到了一些secrets
,主要用于讀取存儲在Github倉庫中的機密信息,這些secrets
需要我們在GitHub倉庫中進行配置。
- 打開GitHub倉庫,點擊右上角的
Settings
。 - 在左側菜單中選擇
Secrets and variables
,然后點擊Actions
。 - 點擊
New repository secret
按鈕,添加以下幾個secrets
:DOCKER_USERNAME
:你的Docker Hub用戶名。DOCKER_PASSWORD
:你的Docker Hub密碼或訪問令牌。SERVER_HOST
:你的服務器IP地址或域名。SERVER_USERNAME
:用于SSH連接的服務器用戶名。SERVER_SSH_KEY
:用于SSH連接的私鑰內容(確保格式正確)。
完成這些配置后,當你將代碼推送到Microservices
分支時,GitHub Action將自動觸發,構建并部署配置服務。
四、總結
在本節中,我們為微服務項目添加了GitHub Action支持,創建了Dockerfile和相關的工作流文件,實現了從代碼提交到自動構建、推送和部署的完整CI/CD流程。通過這種方式,我們可以更高效地管理微服務的部署,提高開發和運維效率。你可以根據需要調整工作流文件的內容,例如添加更多的測試步驟、通知步驟等,以滿足項目的具體需求。
在下一節中,我們將繼續擴展微服務的功能,增加更多的服務和功能模塊。通過不斷完善微服務架構,我們將逐步實現一個完整的微服務系統。如果你對GitHub Action或Docker有任何疑問,歡迎在評論區留言,我將盡快回復你。同時,也歡迎大家分享自己的經驗和實踐,共同學習和進步。