WPF应用使用链接XAML文件引发编译问题的解决办法咨询

问题原因 #

通过<Link>引入的外部XAML文件，由于文件名相同（均为MainWindow.xaml），MSBuild默认会将生成的.g.cs文件输出到同一个obj根目录下，导致文件互相覆盖，进而引发编译警告和InitializeComponent找不到的错误。而项目内的常规XAML文件会根据自身路径自动生成子目录存放.g.cs，因此不会出现冲突。

解决方案（无需重命名文件） #

方法1：为每个链接XAML指定生成输出子目录 #

在项目文件的<Page>元素中添加<XamlGeneratedFilesOutputDir>元数据，指定各自的子目录存放生成的.g.cs文件。修改后的配置如下：

<ItemGroup Label="Plugins">
  <Page Include="..\Plugin1\MainWindow.xaml">
    <Link>Plugin1\MainWindow.xaml</Link>
    <!-- 指定Plugin1的XAML生成文件输出到Plugin1子目录 -->
    <XamlGeneratedFilesOutputDir>obj\$(Configuration)\$(Platform)\Plugin1\</XamlGeneratedFilesOutputDir>
  </Page>
  <Compile Include="..\Plugin1\MainWindow.xaml.cs">
    <Link>Plugin1\MainWindow.xaml.cs</Link>
    <DependentUpon>MainWindow.xaml</DependentUpon>
  </Compile>

  <Page Include="..\Plugin2\MainWindow.xaml">
    <Link>Plugin2\MainWindow.xaml</Link>
    <!-- 指定Plugin2的XAML生成文件输出到Plugin2子目录 -->
    <XamlGeneratedFilesOutputDir>obj\$(Configuration)\$(Platform)\Plugin2\</XamlGeneratedFilesOutputDir>
  </Page>
  <Compile Include="..\Plugin2\MainWindow.xaml.cs">
    <Link>Plugin2\MainWindow.xaml.cs</Link>
    <DependentUpon>MainWindow.xaml</DependentUpon>
  </Compile>
</ItemGroup>

该配置会让XAML编译器将两个插件的.g.cs文件分别输出到obj\Debug\x64\Plugin1和obj\Debug\x64\Plugin2目录下，完全避免文件名冲突，编译系统会自动识别这些目录下的生成文件进行后续编译。

方法2：直接指定生成的.g.cs文件名 #

如果不想创建子目录，可以通过<XamlGeneratedCodeFile>元数据为每个XAML文件指定唯一的生成文件名：

<ItemGroup Label="Plugins">
  <Page Include="..\Plugin1\MainWindow.xaml">
    <Link>Plugin1\MainWindow.xaml</Link>
    <XamlGeneratedCodeFile>obj\$(Configuration)\$(Platform)\Plugin1_MainWindow.g.cs</XamlGeneratedCodeFile>
  </Page>
  <Compile Include="..\Plugin1\MainWindow.xaml.cs">
    <Link>Plugin1\MainWindow.xaml.cs</Link>
    <DependentUpon>MainWindow.xaml</DependentUpon>
  </Compile>

  <Page Include="..\Plugin2\MainWindow.xaml">
    <Link>Plugin2\MainWindow.xaml</Link>
    <XamlGeneratedCodeFile>obj\$(Configuration)\$(Platform)\Plugin2_MainWindow.g.cs</XamlGeneratedCodeFile>
  </Page>
  <Compile Include="..\Plugin2\MainWindow.xaml.cs">
    <Link>Plugin2\MainWindow.xaml.cs</Link>
    <DependentUpon>MainWindow.xaml</DependentUpon>
  </Compile>
</ItemGroup>

这种方式直接给生成的代码文件命名为唯一名称，同样能解决覆盖问题。

方法3：利用命名空间隔离（辅助优化） #

虽然这不能直接解决文件冲突，但建议给两个插件窗口的代码设置不同的命名空间，避免后续可能出现的类型名称冲突：

在Plugin1/MainWindow.xaml.cs中：

namespace MyApp.Plugins.Plugin1
{
    public partial class MainWindow : Window
    {
        // ...
    }
}

在Plugin2/MainWindow.xaml.cs中：

namespace MyApp.Plugins.Plugin2
{
    public partial class MainWindow : Window
    {
        // ...
    }
}

同时修改对应的XAML文件的x:Class属性：

<Window x:Class="MyApp.Plugins.Plugin1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
    <!-- ... -->
</Window>

这样即使文件名相同，类型也不会冲突，增强项目的可维护性。

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