C# 如何获取属性的displayName的3种方式

文章目录

- 1. 使用特性直接访问
- 2. 使用GetCustomAttribute()方法通过反射获取
- 3. 使用LINQ查询
- 总结和比较

在C#中，获取属性的displayName可以通过多种方式实现，包括使用特性、反射和LINQ。下面我将分别展示每种方法，并提供具体的示例代码。

1. 使用特性直接访问

在属性定义时，可以使用DisplayName特性来指定属性的显示名称。这种方式最简单直接，适用于属性在设计时就需要指定显示名称的情况。

using System;
using System.ComponentModel;

public class MyModel
{
    [DisplayName("Full Name")]
    public string Name { get; set; }
}

// 使用
MyModel model = new MyModel();
string displayName = model.Name.DisplayName; // 假设DisplayName特性已经被附加到属性上

注意：在.NET Core中，DisplayName特性可能已经被弃用，你可能需要使用DisplayAttribute。

2. 使用GetCustomAttribute()方法通过反射获取

通过反射，可以动态地获取属性上的自定义特性，包括DisplayAttribute。

using System;
using System.ComponentModel;
using System.Reflection;

public class MyModel
{
    [Display(Name = "Full Name")]
    public string Name { get; set; }
}

// 使用
MyModel model = new MyModel();
string displayName = "";

PropertyInfo propertyInfo = model.GetType().GetProperty("Name");
DisplayAttribute displayAttribute = (DisplayAttribute)propertyInfo.GetCustomAttribute(typeof(DisplayAttribute), false);

if (displayAttribute != null)
{
    displayName = displayAttribute.Name;
}

3. 使用LINQ查询

如果你有一个属性列表，并且想要查询具有特定显示名称的属性，可以使用LINQ来简化查询过程。

using System;
using System.ComponentModel;
using System.Linq;
using System.Reflection;

public class MyModel
{
    [Display(Name = "Full Name")]
    public string Name { get; set; }

    [Display(Name = "Date of Birth")]
    public DateTime DateOfBirth { get; set; }
}

// 使用
MyModel model = new MyModel();
string displayName = "";

var attributes = from property in model.GetType().GetProperties()
                 let displayAttribute = Attribute.GetCustomAttribute(property, typeof(DisplayAttribute)) as DisplayAttribute
                 where displayAttribute != null
                 select displayAttribute;

foreach (var attribute in attributes)
{
    if (attribute.Name == "Full Name")
    {
        displayName = attribute.Name;
        break;
    }
}