基于DotNetty实现自动发布 - 实现一键打包发布

故事青年

前言

上一篇,我只实现了一键检测代码变化,本篇才是真正的实现了一键打包发布
效果图

客户端打包待发布文件

1.     /// <summary>
2.     /// 把多个文件添加到压缩包 (保留文件夹层级关系)
3.     /// </summary>
4.     public static async Task<ZipFileResult> CreateZipAsync(IEnumerable<ZipFileInfo> zipFileInfo)
5.     {
6.         return await Task.Run(() =>
7.         {
8.             var zipDir = EnsureZipDirCreated();
9.             var zipFileName = $"{DateTime.Now:yyyyMMdd_HHmmss_}{Guid.NewGuid()}.zip";
10.             var zipPath = Path.Combine(zipDir, zipFileName);
11.             using var archive = ZipFile.Open(zipPath, ZipArchiveMode.Update);
12.             foreach (var item in zipFileInfo)
13.             {
14.                 archive.CreateEntryFromFile(item.FileAbsolutePath, item.FileRelativePath, CompressionLevel.SmallestSize);
15.             }
16.             return new ZipFileResult() { FullFileName = zipPath, FileName = zipFileName };
17.         });
18.     }

复制代码

客户端封装 NettyMessage

1.             //读取zip字节数组,填充到 NettyMessage 的 Body
2.             var body = await File.ReadAllBytesAsync(zipResult.FullFileName);
4.             //NettyHeader
5.             var header = new DeployRequestHeader()
6.             {
7.                 Files = PublishFiles,
8.                 SolutionName = SolutionName,
9.                 ProjectName = webProject!.ProjectName,
10.                 ZipFileName = zipResult.FileName,
11.             };
13.             var nettyMessage = new NettyMessage { Header = header, Body = body };
15.             //创建 NettyClient
16.             Logger.Info("开始发送");
17.             using var nettyClient = new NettyClient(webProject.ServerIp, webProject.ServerPort);
18.             await nettyClient.SendAsync(nettyMessage);
19.             Logger.Info("完成发送");
21.             Growl.SuccessGlobal($"发布成功");
23.             //保存发布记录
24.             await solutionRepo.SaveFirstPublishAsync(SolutionId, SolutionName, lastGitCommit!.Sha);
25.             Growl.SuccessGlobal($"操作成功");
27.             quickDeployDialog?.Close();

复制代码

NettyHeader 设计

具体实现是 DeployRequestHeader, 继承自 NettyHeader, 保存待发布文件集合,项目名称,解决方案名称, zip 文件名称等

1. /// <summary>
2. /// 发布请求头部
3. /// </summary>
4. public class DeployRequestHeader : NettyHeader
5. {
6.     public DeployRequestHeader() : base("Deploy/Run") { }
7.     public List<DeployFileInfo> Files { get; set; } = [];
8.     public string ProjectName { get; set; } = string.Empty;
9.     public string SolutionName { get; set; } = string.Empty;
10.     public string ZipFileName { get; set; } = string.Empty;
11. }

复制代码

服务端处理

• 解压 zip
  
• 备份目标文件(存在才备份)
  
• 替换目标文件(不存在则新建)
  

1. /// <summary>
2. /// 执行服务端发布
3. /// </summary>
4. /// <param name="model"></param>
5. public void Run(DeployRequestHeader model)
6. {
7.     Logger.Warn($"收到客户端的消息: {model.ToJsonString(true)}");
9.     var configs = NettyServer.AppHost.Services.GetRequiredService<IOptions<List<ProjectConfig>>>();
10.     var projectConfig = configs.Value.FirstOrDefault(a => a.ProjectName == model.ProjectName);
11.     if (projectConfig == null)
12.     {
13.         Logger.Error("请现在服务器项目的appsettings.json中配置项目信息");
14.         return;
15.     }
17.     var zipBytes = Request.Body;
18.     if (zipBytes == null || zipBytes.Length == 0)
19.     {
20.         Logger.Error("ZipBytes为空");
21.         return;
22.     }
24.     var zipFileName = model.ZipFileName;
25.     if (string.IsNullOrEmpty(zipFileName))
26.     {
27.         Logger.Error("ZipFileName为空");
28.         return;
29.     }
31.     //解压
32.     var zipDir = ZipHelper.UnZip(zipBytes, zipFileName);
34.     Logger.Info($"解压成功: {zipDir}");
36.     //备份并覆盖旧文件
37.     DoPublish(model.Files, zipDir, zipFileName, projectConfig);
39.     Logger.Info($"发布成功: {zipDir}");
40. }

复制代码

1. /// <summary>
2. /// 备份并覆盖旧文件
3. /// </summary>
4. private static void DoPublish(List<DeployFileInfo> files, string zipDir, string zipFileName, ProjectConfig projectConfig)
5. {
6.     try
7.     {
8.         //先创建备份文件夹
9.         var backupDir = EnsureBackupDirCreated(zipFileName);
11.         //遍历每个待发布的文件,依次先备份再替换
12.         foreach (DeployFileInfo file in files)
13.         {
14.             //文件相对路径(相对于待发布的项目根目录,也是相对于解压后的根目录)
15.             var relativeFilePath = file.PublishFileRelativePath;
17.             //源文件路径(解压后的文件路径)
18.             var sourceFileName = Path.Combine(zipDir, relativeFilePath);
20.             //待发布的文件路径 (服务器真实文件路径)
21.             var destFileName = Path.Combine(projectConfig.ProjectDir, relativeFilePath);
23.             //服务器已存在此文件,先执行备份
24.             if (File.Exists(destFileName))
25.             {
26.                 //备份文件路径
27.                 var backupFileName = Path.Combine(backupDir, relativeFilePath);
28.                 //确保创建备份文件夹
29.                 var backupFileDir = Path.GetDirectoryName(backupFileName);
30.                 if (!Directory.Exists(backupFileDir))
31.                 {
32.                     Directory.CreateDirectory(backupFileDir!);
33.                 }
34.                 File.Copy(destFileName, backupFileName);
35.             }
36.             else
37.             {
38.                 //服务器不存在此文件,先创建文件夹层级(比如你新加了一个页面demo.aspx,需要发布到服务器对应的位置)
39.                 var destFileDir = Path.GetDirectoryName(destFileName);
40.                 if (!Directory.Exists(destFileDir))
41.                 {
42.                     Directory.CreateDirectory(destFileDir!);
43.                 }
44.             }
46.             //替换服务器文件
47.             File.Copy(sourceFileName, destFileName, true);
48.         }
49.     }
50.     catch (Exception ex)
51.     {
52.         Logger.Error(ex.ToString());
53.     }
54. }

复制代码

总结

至此,我已经完成了自动发布项目的主体功能,实现自动检测代码变化,自动一键打包发布, 不足的地方有: 第一次发布需要手动处理, 项目也需要手动编译,并配置输出目录,但是我相信,这些都不是问题,只要有思路,都是可以解决的,我主要分享下我的实现步骤
注意

1. 本项目目前只支持 .net framework 的单体 Web 项目
2. 客户端和服务端均是 Windows 服务器
3. 线上项目是 IIS 部署的
4. 代码可能存在 BUG,大家发现可以自行解决,或者联系我,我后面不准备继续维护这个项目,毕竟主要是学习分享用的~~~
代码仓库

项目暂且就叫 OpenDeploy 吧

• OpenDeploy: https://gitee.com/broadm-dotnet/OpenDeploy
  

欢迎大家拍砖,Star

下一步

服务端目前是控制台实现, 可以部署为 Windows 服务, 这个也很简单, 我就不发了, 大家自行实现吧, 完结~

来源:https://www.cnblogs.com/broadm/archive/2023/12/11/17894063.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！