MSBuild自定义任务致VS构建完成却提示失败问题咨询

这个问题的核心是Visual Studio（以下简称VS）和命令行dotnet build的项目加载机制存在差异，你在构建过程中直接修改磁盘上的.csproj文件触发了VS的项目状态校验异常，具体逻辑如下：

• 命令行执行dotnet build时，MSBuild会在构建启动时一次性把.csproj内容加载到内存，整个构建进程结束后就会释放所有文件句柄，构建过程中修改磁盘上的.csproj不会有其他进程做状态校验，所以流程完全正常。
• VS在IDE打开期间会一直持有.csproj的文件句柄，同时在内存中维护一份项目模型快照用来做智能提示、构建状态管理。如果你在编译阶段（比如挂载到Build、Compile节点前）直接通过文件读写修改磁盘上的.csproj，会出现两个问题：
  • VS检测到磁盘文件和内存中加载的项目快照不一致，会直接把本次构建标记为失败，哪怕后续编译步骤全部执行完成、产物正常生成，这个失败标记也不会自动清除。
  • 你直接用普通文件IO修改.csproj的操作没有走VS/MSBuild提供的项目编辑接口，VS不会同步你写入的变更到内存模型，只会判定文件被外部异常篡改，这个篡改检测的异常不会输出到常规构建日志里，所以你看不到具体错误信息。
• 额外隐患：VS在打开项目、正式构建前会多次执行设计时构建（用来初始化智能提示、项目结构树），如果你的自定义Target没有做过滤，会在设计时构建阶段反复触发.csproj修改，进而引发文件变更检测的死循环，也会导致构建被标记为失败。

根据你是否需要把配置持久化写入.csproj文件，二选一即可：

• 方案一（推荐，无兼容问题）：如果你只是需要在构建流程中用到指定配置值，不需要把配置永久写到磁盘的.csproj里，直接删掉Executor中读写.csproj文件的逻辑，在自定义Target中通过MSBuild原生的<PropertyGroup>语法动态注入需要的属性即可。这种方式完全不碰磁盘文件，不会触发VS的文件校验，注入的属性仅在本次构建流程中生效，没有任何副作用。
• 方案二（需要持久化写入.csproj配置时使用）：
  • 调整自定义Target的挂载时机，设置BeforeTargets="Restore"，把修改.csproj的逻辑放到还原阶段执行，这个阶段VS还没加载完整的构建用项目模型，修改文件后VS会自动同步变更，不会触发状态不一致。
  • 给Target增加过滤条件Condition="'$(DesignTimeBuild)' != 'true'"，跳过VS的设计时构建，避免打开项目就自动触发文件修改逻辑。
  • 替换Task中直接用Console.Write/Console.WriteLine输出日志的写法，改用MSBuild Task自带的日志API，比如用Log.LogMessage(MessageImportance.High, "Package running...")输出信息，避免控制台输出流被VS误判为错误。
  • 读写.csproj文件时及时释放文件句柄，不要在同一次Target执行中反复读写文件，避免和VS的文件锁产生冲突。
• 注意：绝对不要把修改.csproj的逻辑挂载到Build、Compile这类编译阶段的节点前，这个阶段VS已经完成了项目内存快照的加载，任何磁盘上的.csproj修改都会触发构建失败标记。

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