如何在Controller中获取Model的DisplayAttribute值用于Excel表头？

要在Controller中获取Model属性上[Display(Name)]定义的文本作为Excel表头，核心是通过反射+表达式树安全地获取属性的显示名称，彻底替代硬编码。

1. 编写通用工具方法 #

创建一个静态工具类（比如ReflectionHelper），封装获取Display名称的逻辑，兼容值类型和引用类型属性：

using System;
using System.ComponentModel.DataAnnotations;
using System.Linq.Expressions;

public static class ReflectionHelper
{
    public static string GetDisplayName<TModel>(Expression<Func<TModel, object>> propertyExpression)
    {
        // 解析表达式，获取属性成员
        var memberExpr = propertyExpression.Body as MemberExpression;
        if (memberExpr == null)
        {
            // 处理值类型（如int/DateTime）的表达式包装
            var unaryExpr = propertyExpression.Body as UnaryExpression;
            memberExpr = unaryExpr?.Operand as MemberExpression;
        }

        if (memberExpr == null)
            return string.Empty;

        // 获取属性上的DisplayAttribute
        var displayAttr = memberExpr.Member
            .GetCustomAttributes(typeof(DisplayAttribute), inherit: false)
            .FirstOrDefault() as DisplayAttribute;

        // 优先返回Display.Name，否则返回属性本身的名称
        return displayAttr?.Name ?? memberExpr.Member.Name;
    }
}

2. 在Controller中调用工具方法 #

假设你的Model是ExpenseRecord，其中包含[Display(Name = "From Date")] public DateTime FromDate { get; set; }和[Display(Name = "PCard Dt")] public DateTime PCardDate { get; set; }，导出Excel时直接替换硬编码：

// 示例：使用NPOI创建Excel表头
var row = sheet.CreateRow(0);
// 获取From Date的显示名称
row.CreateCell(0).SetCellValue(ReflectionHelper.GetDisplayName<ExpenseRecord>(x => x.FromDate));
// 获取PCard Dt的显示名称
row.CreateCell(1).SetCellValue(ReflectionHelper.GetDisplayName<ExpenseRecord>(x => x.PCardDate));

3. 批量处理多列（可选） #

如果需要导出多个列，可以提前批量获取所有表头，避免重复调用：

var excelHeaders = new Dictionary<string, string>
{
    { nameof(ExpenseRecord.FromDate), ReflectionHelper.GetDisplayName<ExpenseRecord>(x => x.FromDate) },
    { nameof(ExpenseRecord.PCardDate), ReflectionHelper.GetDisplayName<ExpenseRecord>(x => x.PCardDate) },
    { nameof(ExpenseRecord.Amount), ReflectionHelper.GetDisplayName<ExpenseRecord>(x => x.Amount) }
};

// 构建表头行
var headerRow = sheet.CreateRow(0);
headerRow.CreateCell(0).SetCellValue(excelHeaders[nameof(ExpenseRecord.FromDate)]);
headerRow.CreateCell(1).SetCellValue(excelHeaders[nameof(ExpenseRecord.PCardDate)]);
headerRow.CreateCell(2).SetCellValue(excelHeaders[nameof(ExpenseRecord.Amount)]);

注意事项 #

• 确保项目引用了System.ComponentModel.DataAnnotations命名空间（DisplayAttribute属于该命名空间）；
• 如果属性未设置[Display(Name)]，方法会自动返回属性本身的名称作为 fallback；
• 该方法兼容常见的Excel操作库（NPOI、EPPlus、ClosedXML等），核心逻辑与Excel库无关。

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