利用MSBuild自定义任务实现C#类库编译版本号自动迭代

news2026/4/12 18:02:06
1. 为什么需要版本号自动迭代每次手动修改版本号绝对是开发过程中最容易被忽略的环节之一。我见过太多团队因为忘记更新版本号导致生产环境出现1.0.0.0版本运行了半年的尴尬情况。更糟的是当需要回滚时发现所有编译产物的版本号完全相同根本分不清哪个是稳定版本。传统的解决方案往往依赖外部脚本比如原始文章中提到的PowerShell方案。这种方法虽然能用但存在几个明显痛点首先脚本文件需要随项目一起分发容易丢失或被误修改其次脚本执行需要额外权限在CI/CD环境中可能遇到安全策略限制最重要的是当多个项目需要共享相同逻辑时每个项目都要复制粘贴相同的脚本代码。MSBuild自定义任务正好能解决这些问题。它把版本控制逻辑封装成标准的.NET类库可以像NuGet包一样被各个项目引用。我在多个大型产品线中实践过这种方案实测下来版本管理效率提升明显特别适合需要同时维护多个关联组件的团队。2. 创建MSBuild自定义任务项目2.1 初始化项目结构首先新建一个Class Library项目这里我推荐使用.NET Standard 2.0作为目标框架这样既能兼容传统的.NET Framework项目也能支持新的.NET Core/.NET 5项目。项目文件基本结构如下Project SdkMicrosoft.NET.Sdk PropertyGroup TargetFrameworknetstandard2.0/TargetFramework IsPackabletrue/IsPackable PackageTypeMSBuildSdk/PackageType /PropertyGroup ItemGroup PackageReference IncludeMicrosoft.Build.Utilities.Core Version16.0.0 / /ItemGroup /Project关键点说明IsPackabletrue表示这个项目可以打包成NuGet包PackageTypeMSBuildSdk指定这是MSBuild扩展包必须引用Microsoft.Build.Utilities.Core它包含了开发自定义任务需要的基础类2.2 实现版本迭代逻辑创建核心任务类VersionIncrementTask.cs继承自Microsoft.Build.Utilities.Taskusing System; using System.IO; using Microsoft.Build.Utilities; public class VersionIncrementTask : Task { // 输入参数版本文件路径 [Required] public string VersionFile { get; set; } // 输出参数新版本号 [Output] public string NewVersion { get; set; } public override bool Execute() { try { var currentVersion File.ReadAllText(VersionFile).Trim(); var parts currentVersion.Split(.); // 只递增最后一位版本号 var revision int.Parse(parts[3]) 1; NewVersion ${parts[0]}.{parts[1]}.{parts[2]}.{revision}; File.WriteAllText(VersionFile, NewVersion); Log.LogMessage(MessageImportance.High, $Version incremented to: {NewVersion}); return true; } catch (Exception ex) { Log.LogErrorFromException(ex); return false; } } }这个实现比原始文章的PowerShell脚本更健壮强类型检查确保版本号格式正确完善的错误处理和日志记录明确的输入输出参数声明不需要处理XML文件修改专注版本号生成逻辑3. 打包与部署任务3.1 配置NuGet包元数据在项目文件中添加包信息PropertyGroup PackageIdYourCompany.Build.Versioning/PackageId Version1.0.0/Version AuthorsYourName/Authors DescriptionMSBuild task for auto-incrementing version numbers/Description /PropertyGroup ItemGroup Content Includebuild\* PackagePathbuild\ / Content IncludebuildMultiTargeting\* PackagePathbuildMultiTargeting\ / /ItemGroup3.2 添加MSBuild集成文件在项目根目录创建build文件夹添加两个关键文件YourCompany.Build.Versioning.targets:Project xmlnshttp://schemas.microsoft.com/developer/msbuild/2003 UsingTask TaskNameVersionIncrementTask AssemblyFile$(MSBuildThisFileDirectory)..\tasks\netstandard2.0\YourCompany.Build.Versioning.dll / Target NameIncrementVersion BeforeTargetsBeforeBuild VersionIncrementTask VersionFile$(VersionFile) Output PropertyNameNewVersion TaskParameterNewVersion / /VersionIncrementTask PropertyGroup Version$(NewVersion)/Version FileVersion$(NewVersion)/FileVersion AssemblyVersion$(NewVersion.Split(.)[0]).$(NewVersion.Split(.)[1]).0.0/AssemblyVersion /PropertyGroup /Target /ProjectYourCompany.Build.Versioning.props:Project xmlnshttp://schemas.microsoft.com/developer/msbuild/2003 PropertyGroup VersionFile Condition$(VersionFile) $(MSBuildProjectDirectory)\Version.txt/VersionFile /PropertyGroup /Project这种结构比原始文章的方案更灵活允许通过VersionFile属性自定义版本文件路径自动处理三个不同版本属性的设置逻辑支持多目标框架项目4. 在实际项目中使用4.1 安装与配置在目标项目中添加NuGet包引用后只需做最小配置Project SdkMicrosoft.NET.Sdk PropertyGroup TargetFrameworknet6.0/TargetFramework !-- 初始版本号 -- Version1.0.0.0/Version /PropertyGroup ItemGroup PackageReference IncludeYourCompany.Build.Versioning Version1.0.0 / /ItemGroup /Project然后在项目根目录创建Version.txt内容为初始版本号1.0.0.04.2 高级配置选项我们的方案支持多种自定义方式自定义版本文件路径PropertyGroup VersionFile$(MSBuildProjectDirectory)\Properties\version.txt/VersionFile /PropertyGroup控制版本号递增规则 修改任务类中的Execute方法比如实现不同的递增策略// 主版本号递增 if (DateTime.Now.Year lastUpdateYear) { var major int.Parse(parts[0]) 1; NewVersion ${major}.0.0.0; } // 次版本号递增 else if (DateTime.Now.Month lastUpdateMonth) { var minor int.Parse(parts[1]) 1; NewVersion ${parts[0]}.{minor}.0.0; }CI/CD集成 在Azure DevOps的YAML配置中可以这样禁用本地版本递增variables: - name: DisableVersionIncrement value: true steps: - task: DotNetCoreCLI2 inputs: command: build arguments: /p:DisableVersionIncrement$(DisableVersionIncrement)对应的任务类需要增加条件判断Target NameIncrementVersion BeforeTargetsBeforeBuild Condition$(DisableVersionIncrement) ! true ... /Target5. 方案优势与最佳实践5.1 与传统方案的对比特性PowerShell脚本方案MSBuild自定义任务部署复杂度高需复制脚本文件低NuGet包引用安全策略要求需要允许脚本执行无特殊要求多项目共享需重复配置一次开发多处引用调试支持困难支持源码调试版本控制脚本需单独管理随包版本更新5.2 实际应用建议版本号策略主版本号Major重大架构变更次版本号Minor功能新增构建号BuildCI流水线自动生成修订号Revision每次编译递增多项目协调 对于解决方案中的多个项目可以在解决方案根目录创建共享的Version.txt然后在各项目中配置PropertyGroup VersionFile$(MSBuildThisFileDirectory)..\Version.txt/VersionFile /PropertyGroup异常处理 建议在任务类中添加版本格式验证private bool ValidateVersion(string version) { var pattern ^\d\.\d\.\d\.\d$; return Regex.IsMatch(version, pattern); }性能优化 对于大型解决方案可以缓存版本号以避免重复文件IOprivate static string _cachedVersion; public override bool Execute() { if (_cachedVersion ! null) { NewVersion _cachedVersion; return true; } ... }在团队协作环境中使用这套方案三年多最大的体会是它消除了版本号不同步这个常见问题。特别是在微服务架构下当十几个服务需要同步更新版本时自动化方案的价值更加明显。唯一需要注意的就是在CI环境中合理控制版本递增的触发条件避免每次流水线运行都产生新版本号。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2510387.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

SpringBoot-17-MyBatis动态SQL标签之常用标签

文章目录 1 代码1.1 实体User.java1.2 接口UserMapper.java1.3 映射UserMapper.xml1.3.1 标签if1.3.2 标签if和where1.3.3 标签choose和when和otherwise1.4 UserController.java2 常用动态SQL标签2.1 标签set2.1.1 UserMapper.java2.1.2 UserMapper.xml2.1.3 UserController.ja…

wordpress后台更新后 前端没变化的解决方法

使用siteground主机的wordpress网站,会出现更新了网站内容和修改了php模板文件、js文件、css文件、图片文件后,网站没有变化的情况。 不熟悉siteground主机的新手,遇到这个问题,就很抓狂,明明是哪都没操作错误&#x…

网络编程(Modbus进阶)

思维导图 Modbus RTU(先学一点理论) 概念 Modbus RTU 是工业自动化领域 最广泛应用的串行通信协议,由 Modicon 公司(现施耐德电气)于 1979 年推出。它以 高效率、强健性、易实现的特点成为工业控制系统的通信标准。 包…

UE5 学习系列(二)用户操作界面及介绍

这篇博客是 UE5 学习系列博客的第二篇,在第一篇的基础上展开这篇内容。博客参考的 B 站视频资料和第一篇的链接如下: 【Note】:如果你已经完成安装等操作,可以只执行第一篇博客中 2. 新建一个空白游戏项目 章节操作,重…

IDEA运行Tomcat出现乱码问题解决汇总

最近正值期末周,有很多同学在写期末Java web作业时,运行tomcat出现乱码问题,经过多次解决与研究,我做了如下整理: 原因: IDEA本身编码与tomcat的编码与Windows编码不同导致,Windows 系统控制台…

利用最小二乘法找圆心和半径

#include <iostream> #include <vector> #include <cmath> #include <Eigen/Dense> // 需安装Eigen库用于矩阵运算 // 定义点结构 struct Point { double x, y; Point(double x_, double y_) : x(x_), y(y_) {} }; // 最小二乘法求圆心和半径 …

使用docker在3台服务器上搭建基于redis 6.x的一主两从三台均是哨兵模式

一、环境及版本说明 如果服务器已经安装了docker,则忽略此步骤,如果没有安装,则可以按照一下方式安装: 1. 在线安装(有互联网环境): 请看我这篇文章 传送阵>> 点我查看 2. 离线安装(内网环境):请看我这篇文章 传送阵>> 点我查看 说明&#xff1a;假设每台服务器已…

XML Group端口详解

在XML数据映射过程中&#xff0c;经常需要对数据进行分组聚合操作。例如&#xff0c;当处理包含多个物料明细的XML文件时&#xff0c;可能需要将相同物料号的明细归为一组&#xff0c;或对相同物料号的数量进行求和计算。传统实现方式通常需要编写脚本代码&#xff0c;增加了开…

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器的上位机配置操作说明

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器专为工业环境精心打造&#xff0c;完美适配AGV和无人叉车。同时&#xff0c;集成以太网与语音合成技术&#xff0c;为各类高级系统&#xff08;如MES、调度系统、库位管理、立库等&#xff09;提供高效便捷的语音交互体验。 L…

(LeetCode 每日一题) 3442. 奇偶频次间的最大差值 I (哈希、字符串)

题目&#xff1a;3442. 奇偶频次间的最大差值 I 思路 &#xff1a;哈希&#xff0c;时间复杂度0(n)。 用哈希表来记录每个字符串中字符的分布情况&#xff0c;哈希表这里用数组即可实现。 C版本&#xff1a; class Solution { public:int maxDifference(string s) {int a[26]…

【大模型RAG】拍照搜题技术架构速览:三层管道、两级检索、兜底大模型

摘要 拍照搜题系统采用“三层管道&#xff08;多模态 OCR → 语义检索 → 答案渲染&#xff09;、两级检索&#xff08;倒排 BM25 向量 HNSW&#xff09;并以大语言模型兜底”的整体框架&#xff1a; 多模态 OCR 层 将题目图片经过超分、去噪、倾斜校正后&#xff0c;分别用…

【Axure高保真原型】引导弹窗

今天和大家中分享引导弹窗的原型模板&#xff0c;载入页面后&#xff0c;会显示引导弹窗&#xff0c;适用于引导用户使用页面&#xff0c;点击完成后&#xff0c;会显示下一个引导弹窗&#xff0c;直至最后一个引导弹窗完成后进入首页。具体效果可以点击下方视频观看或打开下方…

接口测试中缓存处理策略

在接口测试中&#xff0c;缓存处理策略是一个关键环节&#xff0c;直接影响测试结果的准确性和可靠性。合理的缓存处理策略能够确保测试环境的一致性&#xff0c;避免因缓存数据导致的测试偏差。以下是接口测试中常见的缓存处理策略及其详细说明&#xff1a; 一、缓存处理的核…

龙虎榜——20250610

上证指数放量收阴线&#xff0c;个股多数下跌&#xff0c;盘中受消息影响大幅波动。 深证指数放量收阴线形成顶分型&#xff0c;指数短线有调整的需求&#xff0c;大概需要一两天。 2025年6月10日龙虎榜行业方向分析 1. 金融科技 代表标的&#xff1a;御银股份、雄帝科技 驱动…

观成科技:隐蔽隧道工具Ligolo-ng加密流量分析

1.工具介绍 Ligolo-ng是一款由go编写的高效隧道工具&#xff0c;该工具基于TUN接口实现其功能&#xff0c;利用反向TCP/TLS连接建立一条隐蔽的通信信道&#xff0c;支持使用Let’s Encrypt自动生成证书。Ligolo-ng的通信隐蔽性体现在其支持多种连接方式&#xff0c;适应复杂网…

铭豹扩展坞 USB转网口 突然无法识别解决方法

当 USB 转网口扩展坞在一台笔记本上无法识别,但在其他电脑上正常工作时,问题通常出在笔记本自身或其与扩展坞的兼容性上。以下是系统化的定位思路和排查步骤,帮助你快速找到故障原因: 背景: 一个M-pard(铭豹)扩展坞的网卡突然无法识别了,扩展出来的三个USB接口正常。…

未来机器人的大脑:如何用神经网络模拟器实现更智能的决策?

编辑&#xff1a;陈萍萍的公主一点人工一点智能 未来机器人的大脑&#xff1a;如何用神经网络模拟器实现更智能的决策&#xff1f;RWM通过双自回归机制有效解决了复合误差、部分可观测性和随机动力学等关键挑战&#xff0c;在不依赖领域特定归纳偏见的条件下实现了卓越的预测准…

Linux应用开发之网络套接字编程(实例篇)

服务端与客户端单连接 服务端代码 #include <sys/socket.h> #include <sys/types.h> #include <netinet/in.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <arpa/inet.h> #include <pthread.h> …

华为云AI开发平台ModelArts

华为云ModelArts&#xff1a;重塑AI开发流程的“智能引擎”与“创新加速器”&#xff01; 在人工智能浪潮席卷全球的2025年&#xff0c;企业拥抱AI的意愿空前高涨&#xff0c;但技术门槛高、流程复杂、资源投入巨大的现实&#xff0c;却让许多创新构想止步于实验室。数据科学家…

深度学习在微纳光子学中的应用

深度学习在微纳光子学中的主要应用方向 深度学习与微纳光子学的结合主要集中在以下几个方向&#xff1a; 逆向设计 通过神经网络快速预测微纳结构的光学响应&#xff0c;替代传统耗时的数值模拟方法。例如设计超表面、光子晶体等结构。 特征提取与优化 从复杂的光学数据中自…