.NET 6 Web API项目中如何让.cshtml文件触发编译错误？

你遇到的问题核心是：默认情况下RazorLight的.cshtml模板不会被纳入项目的编译检测流程，所以VS能识别错误但编译不阻断。下面是几个可行的解决办法：

方法一：启用Razor视图编译并强制错误检测 #

1. 安装Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet包
2. 打开Web API项目的.csproj文件，添加以下配置：

<PropertyGroup>
  <!-- 开启编译时的Razor视图编译 -->
  <RazorCompileOnBuild>true</RazorCompileOnBuild>
  <RazorCompileOnPublish>true</RazorCompileOnPublish>
  <!-- 将Razor模板错误视为编译错误 -->
  <MvcRazorCompileOnErrors>true</MvcRazorCompileOnErrors>
</PropertyGroup>

<ItemGroup>
  <!-- 调整.cshtml文件的生成操作，让编译器识别为Razor资源 -->
  <Content Remove="**/*.cshtml" />
  <EmbeddedResource Include="**/*.cshtml" />
</ItemGroup>

3. 在Program.cs（.NET 6已移除Startup.cs）中更新服务注册：

builder.Services.AddControllersWithViews()
    .AddRazorRuntimeCompilation();

方法二：将模板放入单独类库预编译 #

把邮件模板单独做成类库项目，利用Razor预编译在类库编译阶段就检测错误：

1. 创建一个.NET 6类库项目（比如命名为MailTemplateLibrary），将所有.cshtml模板移至该项目
2. 给类库安装RazorLight和Microsoft.AspNetCore.Mvc.Razor NuGet包
3. 修改类库的.csproj文件：

<PropertyGroup>
  <TargetFramework>net6.0</TargetFramework>
  <RazorCompileOnBuild>true</RazorCompileOnBuild>
  <MvcRazorCompileOnErrors>true</MvcRazorCompileOnErrors>
</PropertyGroup>

<ItemGroup>
  <RazorComponent Include="**/*.cshtml" />
</ItemGroup>

4. 在Web API项目中引用这个类库，通过预编译模板的方式使用RazorLight。只要模板存在错误，类库编译就会失败，直接阻断整个解决方案的编译流程。

方法三：自定义MSBuild验证任务 #

如果上述方法不适用，可以自己实现编译前的模板验证：

1. 创建一个控制台项目，利用RazorLight的API遍历所有.cshtml模板，尝试编译每个模板
2. 检测到错误时，控制台项目返回非零退出码
3. 在Web API的.csproj中添加MSBuild任务，让编译前先执行这个控制台工具：

<Target Name="ValidateRazorTemplates" BeforeTargets="Compile">
  <Exec Command="dotnet run --project ./RazorTemplateValidator/RazorTemplateValidator.csproj" />
</Target>

这样只要模板存在问题，控制台工具报错就会导致整个项目编译失败。

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