C# Nameof（對於開發者的運行原理）

代碼可維護性

'nameof' 運算子的突出優勢之一是對代碼可維護性的積極影響。 開發人員可以使用 'nameof'，而不是將名稱作為字串硬編碼，確保當名稱更改時，引用會自動更新。

static void Main()
{
    // Without using nameof
    Logger.Log("Error: The variable 'myVariable' is null.");
    // Using nameof for improved maintainability
    Logger.Log($"Error: The variable '{nameof(myVariable)}' is null.");
}

static void Main()
{
    // Without using nameof
    Logger.Log("Error: The variable 'myVariable' is null.");
    // Using nameof for improved maintainability
    Logger.Log($"Error: The variable '{nameof(myVariable)}' is null.");
}

編譯期安全性

'nameof' 通過消除名稱中的拼寫錯誤或不一致的風險，提高編譯期安全性。 任何變數名稱拼寫錯誤或修改都將觸發編譯期錯誤，從而減少運行時問題的機會。

static void Main()
{
    // Compile-time error if 'myVariable' is misspelled
    string myVariable;
    string variableName = nameof(myVariable);

    Console.WriteLine(variableName);
}

static void Main()
{
    // Compile-time error if 'myVariable' is misspelled
    string myVariable;
    string variableName = nameof(myVariable);

    Console.WriteLine(variableName);
}

重構支援

'nameof' 運算子無縫整合到重構工具中，提供無憂體驗，更改變數、類型或成員名稱時。 所有 'nameof' 引用會自動更新。

static void Main()
{
    // Before renaming local variable 'myVariable' to 'newVariable'
    string myVariableNameChange = nameof(myVariableNameChange);
    // After renaming local variable 'myVariable' to 'newVariable'
    string newVariableNameChange = nameof(newVariableNameChange);

    Console.WriteLine(newVariableNameChange);
}

static void Main()
{
    // Before renaming local variable 'myVariable' to 'newVariable'
    string myVariableNameChange = nameof(myVariableNameChange);
    // After renaming local variable 'myVariable' to 'newVariable'
    string newVariableNameChange = nameof(newVariableNameChange);

    Console.WriteLine(newVariableNameChange);
}

增強調試

在調試過程中，'nameof' 讓代碼更具信息性和可讀性。 日誌聲明、異常訊息和其他調試輸出變得簡潔而具有情境相關性。

static void Main()
{
    // Without using nameof
    // throw new ArgumentNullException("myVariable", "The variable cannot be null."); 
    // Using nameof for improved debugging 
    throw new ArgumentNullException(nameof(myVariable), "The variable cannot be null.");
}

static void Main()
{
    // Without using nameof
    // throw new ArgumentNullException("myVariable", "The variable cannot be null."); 
    // Using nameof for improved debugging 
    throw new ArgumentNullException(nameof(myVariable), "The variable cannot be null.");
}

如果變數未宣告，這裡的 throw new ArgumentNullException 會引發異常。

反射

當使用反射時，'nameof' 運算子簡化了獲取類型、屬性或方法名稱的過程，避免使用硬編碼字串。

Type type = typeof(MyClass);
string typeName = nameof(MyClass);

Type type = typeof(MyClass);
string typeName = nameof(MyClass);

範例類 MyClass 可以是硬編碼字串，但我們可以使用反射動態獲取類名稱。 變數 type 有類名稱，然後使用 nameof 關鍵字來獲取類實例的名稱。 它們不是相同的名稱。

日誌及異常處理

'nameof' 在日誌聲明和異常訊息中顯得無比重要，使得它們更具可讀性而少錯誤。

Logger.Log($"Error: The property '{nameof(MyClass.MyProperty)}' is out of range.");

Logger.Log($"Error: The property '{nameof(MyClass.MyProperty)}' is out of range.");

示例

在這個例子中，我們將創建一個簡單的類來表示一個人，並使用 nameof 運算子來改進日誌和錯誤訊息。

using System;

class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }

    // Method that displays the full name of the person
    public void DisplayFullName()
    {
        if (string.IsNullOrEmpty(FirstName) || string.IsNullOrEmpty(LastName))
        {
            LogError($"Invalid name: {nameof(FirstName)} or {nameof(LastName)} is missing.");
        }
        else
        {
            Console.WriteLine($"Full Name: {FirstName} {LastName}");
        }
    }

    // Custom error logging method that highlights errors
    private void LogError(string errorMessage)
    {
        Console.ForegroundColor = ConsoleColor.Red;
        Console.WriteLine($"Error: {errorMessage}");
        Console.ResetColor();
    }
}

class Program
{
    static void Main()
    {
        // Create an instance of the Person class
        Person person = new Person();

        // Attempt to display the full name without setting the properties
        person.DisplayFullName();

        // Set the properties and display the full name again
        person.FirstName = "John";
        person.LastName = "Doe";
        person.DisplayFullName();
    }
}

using System;

class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }

    // Method that displays the full name of the person
    public void DisplayFullName()
    {
        if (string.IsNullOrEmpty(FirstName) || string.IsNullOrEmpty(LastName))
        {
            LogError($"Invalid name: {nameof(FirstName)} or {nameof(LastName)} is missing.");
        }
        else
        {
            Console.WriteLine($"Full Name: {FirstName} {LastName}");
        }
    }

    // Custom error logging method that highlights errors
    private void LogError(string errorMessage)
    {
        Console.ForegroundColor = ConsoleColor.Red;
        Console.WriteLine($"Error: {errorMessage}");
        Console.ResetColor();
    }
}

class Program
{
    static void Main()
    {
        // Create an instance of the Person class
        Person person = new Person();

        // Attempt to display the full name without setting the properties
        person.DisplayFullName();

        // Set the properties and display the full name again
        person.FirstName = "John";
        person.LastName = "Doe";
        person.DisplayFullName();
    }
}

說明

1. 我們有一個 Person 類，包含 FirstName 和 LastName 屬性，還有一個方法 DisplayFullName 檢查在顯示全名之前是否設置了這兩個屬性。
2. 在方法 DisplayFullName 中，我們使用 nameof(FirstName) 和 nameof(LastName) 將屬性名稱作為字串文字引用。 這提高了代碼的可讀性，並確保如果屬性名稱改變，則屬性定義和相應的錯誤訊息會在編譯時自動更新。
3. 方法 LogError 利用 nameof 在錯誤訊息中動態包含屬性名稱。
4. 在 Main 方法中，我們創建一個 Person 類的實例，嘗試在未設置屬性時顯示全名，然後設置屬性並再次顯示全名。

當您運行該程式時，您會看到錯誤訊息動態地結合了屬性名稱，提供了更多上下文並更容易識別缺少哪個屬性。

這個例子展示了即使屬性名稱發生改變，nameof 運算子如何通過自動更新引用而改進代碼可維護性，並在開發過程中提供更具信息性的錯誤消息。

授權 (提供免費試用)

關於授權，請查看 試用授權信息。 該金鑰需要放置在 appsettings.json 中。

"IronPdf.LicenseKey": "your license key"

提供您的電子郵件以獲取試用授權。