.NET Core中如何通过循环批量生成绑定模型的CheckBoxFor和LabelFor

问题描述 #

我定义了如下UserFilter类：

public class UserFilter
{
    public bool IsShowCars { get; set; } = true;

    public bool IsShowBikes { get; set; } = true;

    public bool IsShowMotorcycles { get; set; } = true;

    public bool IsShowTrucks { get; set; } = false;

    public bool IsShowPlanes { get; set; } = true;

    public bool IsShowTrains { get; set; } = true;
}

希望在.cshtml视图文件中，为该类的每个属性生成CheckBoxFor和LabelFor控件并绑定到模型，能否通过Foreach循环实现，而非逐个手动编写？

解决方案 #

当然可以！你不需要逐个手动编写控件，借助反射获取UserFilter的布尔属性，再结合表达式树动态生成绑定所需的Lambda表达式，就能通过循环批量生成目标控件。下面提供两种实现方式：

方法一：视图内直接实现 #

在你的.cshtml视图中添加以下代码，直接在视图内完成循环生成逻辑：

@model UserFilter
@{
    // 获取UserFilter类中所有可读写的公开布尔属性
    var boolProperties = typeof(UserFilter).GetProperties()
        .Where(p => p.PropertyType == typeof(bool) && p.CanRead && p.CanWrite);
}

@foreach (var prop in boolProperties)
{
    // 动态构建绑定所需的Lambda表达式：model => model.XXX
    var parameter = Expression.Parameter(typeof(UserFilter), "model");
    var propertyAccess = Expression.Property(parameter, prop.Name);
    var lambda = Expression.Lambda<Func<UserFilter, bool>>(propertyAccess, parameter);

    <div class="form-check">
        @Html.CheckBoxFor(lambda)
        @* 自动去除属性名前缀，生成友好标签文本 *@
        @Html.LabelFor(lambda, prop.Name.Replace("IsShow", ""))
    </div>
}

方法二：封装为HtmlHelper扩展方法（推荐复用场景） #

如果需要在多个视图中复用这个逻辑，建议封装成HtmlHelper扩展方法，让代码更整洁：

首先在项目中创建一个静态类：

using System.Linq.Expressions;
using System.Reflection;
using Microsoft.AspNetCore.Mvc.Rendering;

public static class HtmlHelperBoolExtensions
{
    public static IHtmlContent RenderAllBoolCheckBoxes<TModel>(this IHtmlHelper<TModel> htmlHelper)
    {
        var boolProperties = typeof(TModel).GetProperties()
            .Where(p => p.PropertyType == typeof(bool) && p.CanRead && p.CanWrite);
        
        var contentBuilder = new HtmlContentBuilder();
        
        foreach (var prop in boolProperties)
        {
            // 构建绑定表达式
            var paramExpr = Expression.Parameter(typeof(TModel), "model");
            var propExpr = Expression.Property(paramExpr, prop.Name);
            var lambdaExpr = Expression.Lambda<Func<TModel, bool>>(propExpr, paramExpr);
            
            // 拼接控件Html
            contentBuilder.AppendHtml("<div class='form-check'>");
            contentBuilder.AppendHtml(htmlHelper.CheckBoxFor(lambdaExpr));
            // 优先使用DisplayAttribute的名称，没有则处理属性名
            var labelText = prop.GetCustomAttribute<System.ComponentModel.DataAnnotations.DisplayAttribute>()?.Name 
                            ?? prop.Name.Replace("IsShow", "");
            contentBuilder.AppendHtml(htmlHelper.LabelFor(lambdaExpr, labelText));
            contentBuilder.AppendHtml("</div>");
        }
        
        return contentBuilder;
    }
}

然后在视图中直接调用这个扩展方法即可：

@model UserFilter

@Html.RenderAllBoolCheckBoxes()

额外优化建议 #

• 如果需要排除特定属性，只需在Where过滤条件中添加排除规则，比如：.Where(p => ... && p.Name != "不需要的属性名")
• 可以给属性添加[Display(Name="友好名称")]特性，扩展方法中会自动读取这个名称作为标签文本，比硬编码替换前缀更灵活。

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