在 C# 中，nameof 是一个上下文关键字（contextual keyword），用于在编译时获取 变量、类型或成员的名称，并以字符串形式返回。它的主要作用是避免硬编码字符串，提高代码的可维护性和健壮性，尤其是在需要引用标识符名称的场景中（如异常处理、日志记录、数据绑定等）。

---

基本用法

nameof 可以用于以下场景：

1. 获取变量名

   string myVariable = "Hello";
   string variableName = nameof(myVariable); // 返回 "myVariable"

2. 获取属性名

   public class MyClass 
   {
       public string MyProperty { get; set; }
   }
   
   MyClass obj = new MyClass();
   string propertyName = nameof(obj.MyProperty); // 返回 "MyProperty"

3. 获取类型名

   string typeName = nameof(MyClass); // 返回 "MyClass"

4. 获取方法名

   public void MyMethod() 
   {
       string methodName = nameof(MyMethod); // 返回 "MyMethod"
   }

5. 获取命名空间或泛型类型的部分名称

   Console.WriteLine(nameof(System.Collections.Generic)); // 输出 "Generic"
   Console.WriteLine(nameof(List<int>)); // 输出 "List"
   Console.WriteLine(nameof(List<int>.Count)); // 输出 "Count"

---

典型应用场景

1. 异常处理

在参数校验时，使用 nameof 可以明确指出问题所在的参数或属性：

public string UserName 
{
    get => _userName;
    set 
    {
        if (string.IsNullOrEmpty(value))
        {
            throw new ArgumentException("Name cannot be null or empty.", nameof(UserName));
        }
        _userName = value;
    }
}

• 如果 UserName 被设置为空，抛出的异常会明确显示 "UserName" 作为参数名。

2. 日志记录

在日志中记录代码元素的名称，避免硬编码字符串：

Console.WriteLine($"Initializing {nameof(Color)} enum"); // 输出 "Initializing Color"

3. 数据绑定与模型验证

在 MVC 或数据绑定框架中，结合 nameof 生成验证消息：

public class UserModel 
{
    [Required(ErrorMessage = $"The {nameof(UserName)} field is required.")]
    public string UserName { get; set; }
}

• 如果 UserName 被重命名，nameof 会自动更新，避免字符串错误。

4. 单元测试

在测试中明确标识测试的目标方法或属性：

[TestMethod]
public void TestUserNameProperty() 
{
    var service = new UserService();
    Assert.ThrowsException<ArgumentException>(() => service.UserName = "", 
        $"Setting {nameof(UserService.UserName)} to empty should throw.");
}

---

与 ToString() 的区别

特性	nameof	ToString()
执行时机	编译时（生成字符串常量）	运行时（调用方法）
返回内容	标识符的名称（如变量、属性名）	对象的字符串表示（如值或自定义格式）
示例	nameof(myVariable) → "myVariable"	myVariable.ToString() → "Hello"

枚举的对比

enum Color { Red, Green, Blue }
Color myColor = Color.Green;

string a = nameof(myColor);      // 返回 "myColor"（变量名）
string b = nameof(Color.Blue);   // 返回 "Blue"（枚举成员名）
string c = myColor.ToString();   // 返回 "Green"（枚举值的名称）

---

注意事项

1. 编译时操作
   nameof 在编译时求值，因此不会引入运行时开销。

2. 不支持局部变量
   不能用于局部变量（如方法内部定义的变量）：

   void MyMethod() 
   {
       int x = 10;
       string name = nameof(x); // ❌ 错误：x 是局部变量
   }

3. 忽略 @ 符号
   如果标识符以 @ 开头（如 @class），@ 会被忽略：

   var @new = 5;
   Console.WriteLine(nameof(@new)); // 输出 "new"

4. 泛型类型的限制
   nameof(T) 返回的是泛型参数名（如 "T"），而非实际类型名。若需要实际类型名，需结合反射：

   public void GenericMethod<T>() 
   {
       string typeName = nameof(T); // 返回 "T"
       // 使用反射获取实际类型名：
       Type actualType = typeof(T);
       string actualTypeName = actualType.Name; // 如 "String"
   }

---

C# 11 的新特性

从 C# 11 开始，nameof 可用于 方法参数 和 属性：

[ParameterString(nameof(msg))]
public static void Method(string msg) 
{
    [ParameterString(nameof(T))]
    void LocalFunction<T>(T param) { }

    var lambda = ([ParameterString(nameof(aNumber))] int aNumber) => aNumber.ToString();
}

---

总结

nameof 是 C# 中非常实用的工具，尤其在需要引用标识符名称的场景中（如异常处理、日志记录、数据绑定）。它的核心优势包括：

• 避免硬编码字符串，减少错误。
• 编译时检查，确保代码健壮性。
• 提高可读性和可维护性，特别是在重构时自动更新名称。

通过合理使用 nameof，可以编写出更清晰、更可靠的代码。