如何在Razor生产环境中移除data-cy等测试属性？

方案1：自定义全局TagHelper（首推） #

这是最全局、最省心的方案，能自动拦截所有带data-cy属性的元素，根据运行环境决定保留或移除，不需要修改现有HtmlHelper调用逻辑。

1. 编写自定义TagHelper类
   在项目里新建DataCyTagHelper.cs文件，代码如下：

using Microsoft.AspNetCore.Razor.TagHelpers;
using Microsoft.Extensions.Hosting;

[HtmlTargetElement("*", Attributes = "data-cy")]
public class DataCyTagHelper : TagHelper
{
    private readonly IHostEnvironment _env;

    public DataCyTagHelper(IHostEnvironment env)
    {
        _env = env;
    }

    [HtmlAttributeName("data-cy")]
    public string? DataCyValue { get; set; }

    public override void Process(TagHelperContext context, TagHelperOutput output)
    {
        // 只有开发环境保留data-cy属性
        if (!_env.IsDevelopment())
        {
            output.Attributes.RemoveAll("data-cy");
        }
        base.Process(context, output);
    }
}

2. 注册TagHelper到全局视图
   在_ViewImports.cshtml中添加TagHelper所在命名空间的引用（假设你的TagHelper在YourProject.TagHelpers下）：

@addTagHelper *, YourProject

之后不管你是直接写原生HTML标签：

<div data-cy="user-profile-card">...</div>

还是用HtmlHelper生成元素（注意下划线会自动转成短横线）：

@Html.LabelFor(m => m.FullName, new { data_cy = "user-fullname-label" })

所有带data-cy的属性都会被自动处理——开发环境正常输出，生产环境直接移除，完全不用额外写判断逻辑。

方案2：扩展HtmlHelper统一封装（适配传统HtmlHelper场景） #

如果你的项目大量依赖HtmlHelper系列方法，可以用这个方案统一封装属性添加逻辑：

1. 编写HtmlHelper扩展类

using Microsoft.AspNetCore.Html;
using Microsoft.AspNetCore.Mvc.Rendering;
using Microsoft.Extensions.Hosting;

public static class HtmlHelperDataCyExtensions
{
    private static IHostEnvironment? _hostEnv;

    // 在启动时初始化环境变量
    public static void Initialize(IHostEnvironment env)
    {
        _hostEnv = env;
    }

    public static object AddDataCy(this IHtmlHelper helper, string dataCyValue)
    {
        // 非开发环境返回空对象，不生成属性
        if (_hostEnv == null || !_hostEnv.IsDevelopment())
        {
            return new { };
        }
        return new { data_cy = dataCyValue };
    }
}

2. 在Program.cs中初始化

var builder = WebApplication.CreateBuilder(args);
// ...其他服务配置
HtmlHelperDataCyExtensions.Initialize(builder.Environment);
// ...后续启动逻辑

3. 在Razor视图中调用

@Html.TextBoxFor(m => m.PhoneNumber, @Html.AddDataCy("user-phone-input"))
@Html.CheckBoxFor(m => m.RememberMe, @Html.AddDataCy("remember-me-checkbox"))

这样开发环境会生成带data-cy的属性，生产环境则不会添加该属性。

关键注意点 #

• 两种方案都依赖ASP.NET Core的IHostEnvironment判断环境，确保生产环境的ASPNETCORE_ENVIRONMENT配置为Production。
• 方案1的TagHelper覆盖范围更广，原生标签和HtmlHelper生成的标签都能处理，不需要修改现有代码，更符合全局简洁的要求。
• 如果是.NET Framework MVC（非Core），可以把IHostEnvironment换成HttpContext.Current.IsDebuggingEnabled或者Web.config中的自定义配置项来判断环境。

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