基於DotNetty實現自動釋出 - 實現一鍵打包釋出

Broadm發表於2023-12-11
Netty

前言

上一篇,我只實現了一鍵檢測程式碼變化,本篇才是真正的實現了一鍵打包釋出

效果圖

image
image
image

客戶端打包待發布檔案

    /// <summary>
    /// 把多個檔案新增到壓縮包 (保留資料夾層級關係)
    /// </summary>
    public static async Task<ZipFileResult> CreateZipAsync(IEnumerable<ZipFileInfo> zipFileInfo)
    {
        return await Task.Run(() =>
        {
            var zipDir = EnsureZipDirCreated();
            var zipFileName = $"{DateTime.Now:yyyyMMdd_HHmmss_}{Guid.NewGuid()}.zip";
            var zipPath = Path.Combine(zipDir, zipFileName);
            using var archive = ZipFile.Open(zipPath, ZipArchiveMode.Update);
            foreach (var item in zipFileInfo)
            {
                archive.CreateEntryFromFile(item.FileAbsolutePath, item.FileRelativePath, CompressionLevel.SmallestSize);
            }
            return new ZipFileResult() { FullFileName = zipPath, FileName = zipFileName };
        });
    }

客戶端封裝 NettyMessage

            //讀取zip位元組陣列,填充到 NettyMessage 的 Body
            var body = await File.ReadAllBytesAsync(zipResult.FullFileName);

            //NettyHeader
            var header = new DeployRequestHeader()
            {
                Files = PublishFiles,
                SolutionName = SolutionName,
                ProjectName = webProject!.ProjectName,
                ZipFileName = zipResult.FileName,
            };

            var nettyMessage = new NettyMessage { Header = header, Body = body };

            //建立 NettyClient
            Logger.Info("開始傳送");
            using var nettyClient = new NettyClient(webProject.ServerIp, webProject.ServerPort);
            await nettyClient.SendAsync(nettyMessage);
            Logger.Info("完成傳送");

            Growl.SuccessGlobal($"釋出成功");

            //儲存釋出記錄
            await solutionRepo.SaveFirstPublishAsync(SolutionId, SolutionName, lastGitCommit!.Sha);
            Growl.SuccessGlobal($"操作成功");

            quickDeployDialog?.Close();

NettyHeader 設計

具體實現是 DeployRequestHeader, 繼承自 NettyHeader, 儲存待發布檔案集合,專案名稱,解決方案名稱, zip 檔名稱等

/// <summary>
/// 釋出請求頭部
/// </summary>
public class DeployRequestHeader : NettyHeader
{
    public DeployRequestHeader() : base("Deploy/Run") { }
    public List<DeployFileInfo> Files { get; set; } = [];
    public string ProjectName { get; set; } = string.Empty;
    public string SolutionName { get; set; } = string.Empty;
    public string ZipFileName { get; set; } = string.Empty;
}

服務端處理

  • 解壓 zip
  • 備份目標檔案(存在才備份)
  • 替換目標檔案(不存在則新建)
/// <summary>
/// 執行服務端釋出
/// </summary>
/// <param name="model"></param>
public void Run(DeployRequestHeader model)
{
    Logger.Warn($"收到客戶端的訊息: {model.ToJsonString(true)}");

    var configs = NettyServer.AppHost.Services.GetRequiredService<IOptions<List<ProjectConfig>>>();
    var projectConfig = configs.Value.FirstOrDefault(a => a.ProjectName == model.ProjectName);
    if (projectConfig == null)
    {
        Logger.Error("請現在伺服器專案的appsettings.json中配置專案資訊");
        return;
    }

    var zipBytes = Request.Body;
    if (zipBytes == null || zipBytes.Length == 0)
    {
        Logger.Error("ZipBytes為空");
        return;
    }

    var zipFileName = model.ZipFileName;
    if (string.IsNullOrEmpty(zipFileName))
    {
        Logger.Error("ZipFileName為空");
        return;
    }

    //解壓
    var zipDir = ZipHelper.UnZip(zipBytes, zipFileName);

    Logger.Info($"解壓成功: {zipDir}");

    //備份並覆蓋舊檔案
    DoPublish(model.Files, zipDir, zipFileName, projectConfig);

    Logger.Info($"釋出成功: {zipDir}");
}

/// <summary>
/// 備份並覆蓋舊檔案
/// </summary>
private static void DoPublish(List<DeployFileInfo> files, string zipDir, string zipFileName, ProjectConfig projectConfig)
{
    try
    {
        //先建立備份資料夾
        var backupDir = EnsureBackupDirCreated(zipFileName);

        //遍歷每個待發布的檔案,依次先備份再替換
        foreach (DeployFileInfo file in files)
        {
            //檔案相對路徑(相對於待發布的專案根目錄,也是相對於解壓後的根目錄)
            var relativeFilePath = file.PublishFileRelativePath;

            //原始檔路徑(解壓後的檔案路徑)
            var sourceFileName = Path.Combine(zipDir, relativeFilePath);

            //待發布的檔案路徑 (伺服器真實檔案路徑)
            var destFileName = Path.Combine(projectConfig.ProjectDir, relativeFilePath);

            //伺服器已存在此檔案,先執行備份
            if (File.Exists(destFileName))
            {
                //備份檔案路徑
                var backupFileName = Path.Combine(backupDir, relativeFilePath);
                //確保建立備份資料夾
                var backupFileDir = Path.GetDirectoryName(backupFileName);
                if (!Directory.Exists(backupFileDir))
                {
                    Directory.CreateDirectory(backupFileDir!);
                }
                File.Copy(destFileName, backupFileName);
            }
            else
            {
                //伺服器不存在此檔案,先建立資料夾層級(比如你新加了一個頁面demo.aspx,需要釋出到伺服器對應的位置)
                var destFileDir = Path.GetDirectoryName(destFileName);
                if (!Directory.Exists(destFileDir))
                {
                    Directory.CreateDirectory(destFileDir!);
                }
            }

            //替換伺服器檔案
            File.Copy(sourceFileName, destFileName, true);
        }
    }
    catch (Exception ex)
    {
        Logger.Error(ex.ToString());
    }
}

總結

至此,我已經完成了自動釋出專案的主體功能,實現自動檢測程式碼變化,自動一鍵打包釋出, 不足的地方有: 第一次釋出需要手動處理, 專案也需要手動編譯,並配置輸出目錄,但是我相信,這些都不是問題,只要有思路,都是可以解決的,我主要分享下我的實現步驟

注意

1. 本專案目前只支援 .net framework 的單體 Web 專案
2. 客戶端和服務端均是 Windows 伺服器
3. 線上專案是 IIS 部署的
4. 程式碼可能存在 BUG,大家發現可以自行解決,或者聯絡我,我後面不準備繼續維護這個專案,畢竟主要是學習分享用的~~~

程式碼倉庫

專案暫且就叫 OpenDeploy 吧

歡迎大家拍磚,Star

下一步

服務端目前是控制檯實現, 可以部署為 Windows 服務, 這個也很簡單, 我就不發了, 大家自行實現吧, 完結~

相關文章