如何在MSBuild属性表中隐藏CopyFile项并禁止IDE修改?
我创建了一个可正常工作的属性表:
<?xml version="1.0" encoding="utf-8"?> <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <ItemGroup> <CopyFileToFolders Include="$(MSBuildThisFileDirectory)somefile.bin"> <DeploymentContent>true</DeploymentContent> <FileType>Document</FileType> <DestinationFolders>$(OutDir)</DestinationFolders> </CopyFileToFolders> </ItemGroup> </Project>
将该属性表添加到项目后,Visual Studio IDE会在解决方案资源管理器中显示新项“somefile.bin”,其属性可被编辑,且修改会直接改动属性表文件本身。是否有办法实现相同的文件复制行为,同时让IDE不显示该项或禁止修改?
问题背景
我在一个多项目团队解决方案中工作,我的项目提供一个属性表供同事的项目使用,文件放置在“Include”目录下。通常引用属性表像头文件包含一样透明,但此次并非如此。我希望避免同事误以为编辑显示的项只会影响自己的项目文件,从而无意修改共享属性表。
已尝试的无效方法
- 使用
<ReadOnlyProject>true</ReadOnlyProject>将属性表设为“只读”,但该设置会应用于整个项目,而非仅属性表文件。 - 使用Target实现复制:
<Target Name="MyTarget" BeforeTargets="Build" Outputs="$(OutDir)somefile.bin"> <Message Importance="high" Text="MyTarget: copy/update files '$(MSBuildThisFileDirectory)somefile.bin' to '$(OutDir)'"/> <Copy SourceFiles="$(MSBuildThisFileDirectory)somefile.bin" DestinationFolder="$(OutDir)"/> </Target>
但该方法不执行文件版本检查,修改源文件或删除输出文件后,“MyTarget”不一定触发,项目可能仍处于“最新”状态,输出文件未更新。
3. 将文件设为“只读”作为临时方案:
- Git不支持只读文件,检出后会移除只读属性;
- 编辑项属性时,IDE会弹出“是否仍要写入”的提示,仍存在误操作风险,取消时还会报错。
- 使用Target + DisableFastUpToDateCheck:
<PropertyGroup> <DisableFastUpToDateCheck>True</DisableFastUpToDateCheck> </PropertyGroup> <Target Name="MyTarget" BeforeTargets="Build" Outputs="$(OutDir)somefile.bin"> <Message Importance="high" Text="MyTarget: copy/update files '$(MSBuildThisFileDirectory)somefile.bin' to '$(OutDir)'"/> <Copy SourceFiles="$(MSBuildThisFileDirectory)somefile.bin" DestinationFolder="$(OutDir)"/> </Target>
但该方案不适用于我:
- 禁用“最新状态”检查会影响同事的项目;
- 解决方案有50多个项目,无该优化后快速构建会变慢且输出冗长;
- 即使文件未改动,仍会执行复制并打印消息。
而CopyFileToFolders项仅在“somefile.bin”改动时触发构建,否则项目保持“最新”状态。
当前临时方案
- 将属性表放在提供它的项目的本地目录/筛选器中;
- 在提供项目中创建生成后事件,将本地属性表复制到解决方案共享的Include目录;
- 其他项目引用Include目录中的文件。
这样,若其他开发者修改项属性,改动的文件会在下次重建时被重置。且生成后复制不会影响依赖项目的“最新”检查,因为即使复制,目标文件时间戳未改变。
我希望存在使用属性表语法的更优雅解决方案,但可能不存在?
方案1:给CopyFileToFolders项添加Visible元数据隐藏IDE显示
在属性表的CopyFileToFolders项中添加<Visible>false</Visible>元数据,这样Visual Studio的解决方案资源管理器就不会显示该文件项,自然也不会被误编辑,同时保留原有的文件复制行为和增量构建特性:
<?xml version="1.0" encoding="utf-8"?> <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <ItemGroup> <CopyFileToFolders Include="$(MSBuildThisFileDirectory)somefile.bin"> <DeploymentContent>true</DeploymentContent> <FileType>Document</FileType> <DestinationFolders>$(OutDir)</DestinationFolders> <Visible>false</Visible> <!-- 隐藏IDE中的显示 --> </CopyFileToFolders> </ItemGroup> </Project>
这个方法完全符合需求:既保留了CopyFileToFolders的增量构建逻辑,又让IDE不显示该文件项,避免误修改共享属性表。
方案2:用Target配合Inputs和Outputs实现正确的增量复制
如果不想依赖CopyFileToFolders,可以通过给Target指定Inputs和Outputs来实现精准的增量检查,无需禁用DisableFastUpToDateCheck:
<?xml version="1.0" encoding="utf-8"?> <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <Target Name="CopySomeFile" BeforeTargets="Build" Inputs="$(MSBuildThisFileDirectory)somefile.bin" Outputs="$(OutDir)somefile.bin"> <Copy SourceFiles="$(MSBuildThisFileDirectory)somefile.bin" DestinationFolder="$(OutDir)" SkipUnchangedFiles="true"/> <!-- 跳过未改动的文件 --> </Target> </Project>
Inputs指定源文件,Outputs指定目标文件,MSBuild会自动对比两者的时间戳和哈希值,只有当源文件更新或目标文件缺失时才会执行复制;SkipUnchangedFiles="true"确保未改动的文件不会被重复复制,避免冗余操作;- 这个方案不会在IDE中显示任何文件项,完全透明,同时保持高效的增量构建。
内容的提问来源于stack exchange,提问作者Charly

