如何通过MSBuild合并C#模块与C代码实现.NET Framework版本回滚

背景 #

我有一个.NET Framework 3.5项目，需要启用框架回滚功能，使其能在安装了.NET Framework 3.5或4.x运行时的Windows 7及以上系统运行。原本通过App.config实现该功能，但不想随应用分发配置文件。参考方案是：将C#代码编译为netmodule，再与实现TLS回调的C代码合并，回调会在托管代码加载前设置COMPLUS_OnlyUseLatestCLR=1环境变量。

遇到的问题：

1. 将项目OutputType改为Module编译C#为netmodule时，出现大量与NRT（可为空引用类型）相关的CS0518错误。项目目标为.NET Framework 3.5，但使用最新C#版本和.NET 7 SDK构建，已通过PolySharp对NRT进行polyfill，设置<Nullable>disable</Nullable>也无法解决（代码中存在NRT注解），希望在不放弃NRT的前提下解决该问题。
2. 解决上述问题后，如何通过MSBuild最佳编译C代码？是否可复用MSBuild的C/C++工作负载目标？

解决方案 #

一、解决NRT注解导致的CS0518错误（保留NRT） #

CS0518错误本质是编译器无法找到System.NullableAttribute的定义，虽然PolySharp提供了该属性的polyfill，但编译netmodule时需要确保编译器能正确识别这些定义。可按以下步骤配置：

• 保留NRT启用配置：项目文件中维持<Nullable>enable</Nullable>，确保代码中的NRT语法和注解能正常编译。
• 确保PolySharp配置正确：确认项目文件中包含以下PolySharp属性，保证Nullable相关属性被生成并包含在编译中：

  <PropertyGroup>
    <PolySharpIncludeNullableAttributes>true</PolySharpIncludeNullableAttributes>
    <PolySharpGenerateAssemblyAttributes>true</PolySharpGenerateAssemblyAttributes>
    <IncludePolySharpSource>true</IncludePolySharpSource>
  </PropertyGroup>
  

• 针对Module输出类型补充编译配置：在项目文件中添加条件属性，确保编译netmodule时显式包含PolySharp生成的Nullable属性代码：

  <PropertyGroup Condition="'$(OutputType)' == 'Module'">
    <LangVersion>latest</LangVersion>
    <Compile Include="$(PolySharpGeneratedFilesPath)\NullableAttributes.cs" />
  </PropertyGroup>
  

  若仍报错，可尝试添加显式的程序集引用：

  <ItemGroup Condition="'$(OutputType)' == 'Module'">
    <Reference Include="PolySharp" />
  </ItemGroup>
  

二、通过MSBuild编译C代码并复用C/C++工作负载 #

可以在同一个MSBuild项目中导入Visual Studio的C/C构建目标，实现C代码与C#代码的统一编译，无需单独维护C项目。具体配置如下：

1. 导入C++构建目标：在C#项目文件的末尾添加以下内容，导入C++的默认属性和构建目标：

   <!-- 导入C++基础配置 -->
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
   <PropertyGroup Label="Globals">
     <CppProjectName>$(MSBuildProjectName)</CppProjectName>
     <PlatformToolset>v143</PlatformToolset> <!-- 根据你的VS版本调整，如v142对应VS2022 -->
     <ConfigurationType>Application</ConfigurationType>
     <Platform>$(Platform)</Platform> <!-- 与C#项目共用平台配置（x86/x64） -->
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
   

2. 添加C代码文件：将实现TLS回调的C代码文件加入编译项：

   <ItemGroup>
     <ClCompile Include="TlsCallback.c" />
   </ItemGroup>
   

3. 配置C编译选项：针对Windows 7兼容性和编译需求，添加预处理器定义和运行时库配置：

   <!-- Debug x86配置 -->
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
     <ClCompile>
       <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_WIN32_WINNT=0x0601;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
       <WarningLevel>Level3</WarningLevel>
     </ClCompile>
   </ItemDefinitionGroup>
   
   <!-- Release x86配置 -->
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x86'">
     <ClCompile>
       <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;_WIN32_WINNT=0x0601;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
       <WarningLevel>Level3</WarningLevel>
       <Optimization>MaxSpeed</Optimization>
     </ClCompile>
   </ItemDefinitionGroup>
   
   <!-- Debug x64配置 -->
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x64'">
     <ClCompile>
       <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_WIN32_WINNT=0x0601;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
       <WarningLevel>Level3</WarningLevel>
     </ClCompile>
   </ItemDefinitionGroup>
   
   <!-- Release x64配置 -->
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x64'">
     <ClCompile>
       <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;_WIN32_WINNT=0x0601;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
       <WarningLevel>Level3</WarningLevel>
       <Optimization>MaxSpeed</Optimization>
     </ClCompile>
   </ItemDefinitionGroup>
   

4. 完成C++目标导入：在项目文件末尾添加C++目标的导入：

   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   

5. 合并netmodule与C代码输出：编译完成后，使用C++的link.exe将C代码生成的obj文件与C#的netmodule链接为最终可执行文件。可在项目文件中添加自定义MSBuild任务实现自动合并：

   <Target Name="MergeModuleAndCppOutput" AfterTargets="Build">
     <Exec Command="&quot;$(VCTargetsPath)\..\bin\link.exe&quot; /OUT:$(OutputPath)$(AssemblyName).exe $(OutputPath)$(AssemblyName).netmodule $(OutputPath)$(AssemblyName).obj /SUBSYSTEM:CONSOLE /ENTRY:_tmainCRTStartup" />
   </Target>
   

   注意：需根据C代码的入口点和子系统类型调整/ENTRY和/SUBSYSTEM参数。

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