Visual Studio 2022与MSBuild交互、自定义构建及版本持久化咨询

核心问题原因 #

你在PreBuild Target内定义的<PropertyGroup>属于目标级局部属性，仅在该Target执行期间有效，后续构建流程（如编译阶段）会重新读取项目文件的原始默认值，所以无法持久化生效。此外，新版本.NET已弃用传统AssemblyInfo.cs，版本属性直接托管在项目文件的全局<PropertyGroup>中。

正确实现方案 #

方案1：全局持久化设置（静态版本号）

直接在项目文件根级别的<PropertyGroup>中定义VersionPrefix，全局生效且不会被重建重置：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <!-- 全局生效的版本前缀，重建不会重置 -->
    <VersionPrefix>1.2.3.4</VersionPrefix>
    <!-- 可选：搭配VersionSuffix生成预发布版本，如1.2.3.4-beta1 -->
    <VersionSuffix>beta1</VersionSuffix>
  </PropertyGroup>
  <!-- 其他项目配置 -->
</Project>

方案2：动态版本号（结合构建时机/信息）

如果需要自动更新构建号（比如结合日期、Git哈希），在解决方案根目录创建Directory.Build.targets文件（所有子项目自动继承），选择合适的构建时机设置属性：

<Project>
  <!-- 在编译核心阶段前执行，确保属性被编译流程拾取 -->
  <Target Name="SetDynamicVersion" BeforeTargets="CoreCompile">
    <!-- 示例1：用日期生成构建号 -->
    <PropertyGroup>
      <VersionPrefix>1.2.3.$([System.DateTime]::Now.ToString("MMddHHmm"))</VersionPrefix>
    </PropertyGroup>

    <!-- 示例2：调用Git获取短哈希作为构建号 -->
    <Exec Command="git rev-parse --short HEAD" Outputs="GitCommitId" />
    <PropertyGroup>
      <VersionPrefix>1.2.3.$(GitCommitId)</VersionPrefix>
    </PropertyGroup>
  </Target>
</Project>

注意：选择BeforeTargets="CoreCompile"而非PreBuildEvent，因为后者时机过早，后续初始化步骤可能覆盖属性值。

方案3：利用.NET内置Git版本集成

新版本.NET支持直接从Git仓库自动生成版本信息，无需手动写脚本：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <GenerateAssemblyInfo>true</GenerateAssemblyInfo>
    <!-- 启用Git版本生成 -->
    <GenerateGitVersion>true</GenerateGitVersion>
    <!-- 基础版本前缀，自动追加Git哈希/构建号 -->
    <VersionPrefix>1.2.3</VersionPrefix>
  </PropertyGroup>
  <!-- 安装SourceLink包以支持Git信息读取 -->
  <ItemGroup>
    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
  </ItemGroup>
</Project>

关键注意事项 #

• 避免在Target内部定义需要全局生效的属性，全局属性必须放在项目根级别或Directory.Build.props中
• 动态修改属性时，务必选择编译流程之前的时机（如CoreCompile），确保后续步骤能读取到最新值
• 若出现属性被重置，检查项目文件中是否存在重复的VersionPrefix定义，优先保留全局级别的设置

内容的提问来源于stack exchange，提问作者Yannick