快捷導(dǎo)航

C#中nameof用法和應(yīng)用場景實現(xiàn)

更新時間：2025年11月27日 09:17:23 作者：lfw2019

在 C# 中,nameof是一個上下文關(guān)鍵字,用于在編譯時獲取,并以字符串形式返回,下面就來具體介紹一下如何使用,感興趣的可以了解一下

在 C# 中，nameof 是一個上下文關(guān)鍵字（contextual keyword），用于在編譯時獲取 變量、類型或成員的名稱，并以字符串形式返回。它的主要作用是避免硬編碼字符串，提高代碼的可維護性和健壯性，尤其是在需要引用標識符名稱的場景中（如異常處理、日志記錄、數(shù)據(jù)綁定等）。

基本用法

nameof 可以用于以下場景：

獲取變量名

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

獲取屬性名

public class MyClass 
{
    public string MyProperty { get; set; }
}

MyClass obj = new MyClass();
string propertyName = nameof(obj.MyProperty); // 返回 "MyProperty"

獲取類型名

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

獲取方法名

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

獲取命名空間或泛型類型的部分名稱

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

典型應(yīng)用場景

1.異常處理

在參數(shù)校驗時，使用 nameof 可以明確指出問題所在的參數(shù)或?qū)傩裕?/p>

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

如果 UserName 被設(shè)置為空，拋出的異常會明確顯示 "UserName" 作為參數(shù)名。

2.日志記錄

在日志中記錄代碼元素的名稱，避免硬編碼字符串：

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

3.數(shù)據(jù)綁定與模型驗證

在 MVC 或數(shù)據(jù)綁定框架中，結(jié)合 nameof 生成驗證消息：

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

如果 UserName 被重命名，nameof 會自動更新，避免字符串錯誤。

4.單元測試

在測試中明確標識測試的目標方法或?qū)傩裕?/p>

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

與ToString()的區(qū)別

特性	nameof	ToString()
執(zhí)行時機	編譯時（生成字符串常量）	運行時（調(diào)用方法）
返回內(nèi)容	標識符的名稱（如變量、屬性名）	對象的字符串表示（如值或自定義格式）
示例	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"（枚舉值的名稱）

注意事項

編譯時操作
nameof 在編譯時求值，因此不會引入運行時開銷。

不支持局部變量
不能用于局部變量（如方法內(nèi)部定義的變量）：

void MyMethod() 
{
    int x = 10;
    string name = nameof(x); // ? 錯誤：x 是局部變量
}

忽略 @ 符號
如果標識符以 @ 開頭（如 @class），@ 會被忽略：

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

泛型類型的限制
nameof(T) 返回的是泛型參數(shù)名（如 "T"），而非實際類型名。若需要實際類型名，需結(jié)合反射：

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

C# 11 的新特性

從 C# 11 開始，nameof 可用于 方法參數(shù) 和屬性：

[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();
}