ASP.NET Core MVC如何集中为所有cshtml视图统一添加额外输出内容

不需要逐文件修改cshtml，通过自定义Razor视图基类拦截渲染流程+全局布局统一输出即可实现需求，覆盖主视图、分部视图、布局页、视图组件的所有cshtml路径。

实现步骤 #

1. 自定义Razor视图基类，收集所有渲染的视图路径 #

所有cshtml在渲染时都会执行Razor页的ExecuteAsync方法，重写该方法即可自动记录当前渲染的视图路径，存入请求上下文的共享集合中：

using Microsoft.AspNetCore.Mvc.Razor;
using System.Collections.Generic;
using System.Threading.Tasks;

public abstract class CustomRazorPage<TModel> : RazorPage<TModel>
{
    private const string RenderedViewPathKey = "__AllRenderedCshtmlPaths";
    public override async Task ExecuteAsync()
    {
        // 初始化路径集合，将当前渲染的视图路径加入集合
        var pathList = ViewContext.HttpContext.Items[RenderedViewPathKey] as List<string> ?? new List<string>();
        if (!pathList.Contains(ViewContext.View.Path))
        {
            pathList.Add(ViewContext.View.Path);
        }
        ViewContext.HttpContext.Items[RenderedViewPathKey] = pathList;

        // 执行原有视图渲染逻辑
        await base.ExecuteAsync();
    }

    /// <summary>
    /// 获取当前请求下所有已渲染的cshtml文件路径
    /// </summary>
    public IReadOnlyList<string> GetAllRenderedViewPaths()
    {
        return (ViewContext.HttpContext.Items[RenderedViewPathKey] as List<string> ?? new List<string>()).AsReadOnly();
    }
}

// 提供非泛型版本，兼容无强类型模型的视图
public abstract class CustomRazorPage : CustomRazorPage<dynamic>
{
}

2. 全局注册自定义基类，替换默认Razor页基类 #

在Program.cs（.NET 6+）的MVC服务配置中添加如下代码，所有cshtml会自动继承该基类，无需逐文件添加@inherits声明：

var builder = WebApplication.CreateBuilder(args);

// 原有MVC配置基础上追加Razor选项
builder.Services.AddControllersWithViews()
    .AddRazorOptions(opt =>
    {
        opt.PageBaseType = typeof(CustomRazorPage);
    });

3. 在全局布局中统一输出路径面板 #

仅需要在项目所有页面共用的顶层布局文件（通常是Views/Shared/_Layout.cshtml）的</body>标签前，添加一次输出代码即可，无需修改其他任何视图文件：

@inject IWebHostEnvironment HostEnv
@if (HostEnv.IsDevelopment())
{
    <div style="position: fixed;left:0;right:0;bottom:0;background:#cfc;padding:8px 12px;font-size:12px;z-index:99999;border-top:1px solid #2c2;max-height:200px;overflow-y:auto;">
        <span style="font-weight:600;">当前页面渲染的cshtml文件路径：</span>
        <ul style="margin:4px 0 0 24px;padding:0;">
            @foreach (var path in GetAllRenderedViewPaths())
            {
                <li>@path</li>
            }
        </ul>
    </div>
}

方案说明 #

• 覆盖范围：自动收集主视图、各级嵌套布局、Partial/PartialAsync渲染的分部视图、Component/InvokeComponentAsync渲染的视图组件对应的所有cshtml路径，无遗漏
• 维护成本：仅需完成上述3步配置，后续新增的任何cshtml文件无需额外修改，自动纳入收集范围
• 环境隔离：默认仅在开发环境展示调试信息，生产环境自动隐藏，不影响线上运行
• 选型说明：不选择中间件/Action过滤器实现的原因是，这类机制只能拿到Action返回的主视图路径，无法捕获渲染流程中动态加载的分部视图、视图组件、嵌套布局路径，必须在Razor渲染生命周期拦截才能拿到全量路径。

内容的提问来源于stack exchange，提问作者wk-done