Visual Studio项目项模板无法为.NET 5项目添加程序集引用问题咨询

问题原因 #

你遇到的报错是因为.NET 5+ 使用的SDK风格项目与 .NET Framework 传统非SDK风格项目，对Visual Studio项目项模板的<References>节点处理逻辑完全不同：

• 传统.NET Framework项目的模板引擎会识别<Reference>节点下的程序集名、HintPath等配置，自动完成引用添加
• .NET Core/.NET 5+的SDK风格项目不支持模板原生<Reference>节点的本地程序集引用逻辑，只会识别<PackageReference>格式的NuGet包引用，所以哪怕你加了硬编码的HintPath也不会被处理。

解决方案 #

方案一：将DLL封装为NuGet包（优先推荐） #

这是适配两种项目格式成本最低的方案：

1. 将你的EntityModel.dll打包为NuGet包，包内做好多目标框架适配（同时支持.NET Framework和.NET 5+）
2. 替换模板中原有的<References>节点为<PackageReference>配置：

<TemplateContent>
  <!-- 替换原有References节点 -->
  <PackageReferences>
    <PackageReference Id="你的NuGet包ID" Version="你的包版本号" />
  </PackageReferences>
  <ProjectItem SubType="" TargetFileName="$fileinputname$.lcm" ReplaceParameters="false" CustomTool="MyModelGenerator">Model.lcm</ProjectItem>
</TemplateContent>

该配置可以同时兼容.NET Framework和.NET 5+项目，不需要额外处理。

方案二：自定义模板向导动态添加引用 #

如果你不想打包为NuGet包，需要保留本地DLL引用的逻辑，可以通过实现Visual Studio模板的IWizard接口，在模板运行时调用VS的项目API手动添加DLL引用，效果和你手动添加完全一致：

1. 新建一个.NET Framework类库项目，引用Microsoft.VisualStudio.TemplateWizardInterface程序集
2. 实现IWizard接口，在ProjectItemFinishedGenerating方法中加入添加引用的逻辑，伪代码参考：

public void ProjectItemFinishedGenerating(ProjectItem projectItem)
{
    var project = projectItem.ContainingProject;
    // 替换为你的EntityModel.dll实际路径，可以从模板参数或者VSIX安装路径获取
    string dllPath = @"你的DLL实际完整路径";
    var vsProject = project.Object as VSLangProj.VSProject;
    vsProject.References.Add(dllPath);
}

3. 将该向导类库编译后嵌入到你的模板VSIX中，修改模板的.vstemplate文件，添加向导关联配置：

<WizardExtension>
  <Assembly>你的向导程序集强名称, Version=x.x.x.x, Culture=neutral, PublicKeyToken=你的公钥令牌</Assembly>
  <FullClassName>你的向导类完整命名空间+类名</FullClassName>
</WizardExtension>

4. 删除原有<References>节点下的EntityModel引用配置，保留System.Data的引用即可（System.Data属于框架自带程序集，两种项目格式都能识别）。

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