C# 技巧：用列舉及 nameof 取代字串常數提高可維護性

今天介紹一則讓你的 C# 程式好維護且不容易改壞的小技巧。

寫程式時難免會有需要字串常數的場合，若不要想太多，"常數A"、"常數B"是最直覺的寫法。

這樣寫沒什麼問題，程式通常也會跑得好好的。但遇到常數要修改，就是對細心度、視力與耐性的考驗了。

配改善這個問題，宣告一堆 const string ConstA = "常數A"、const string ConstB = "..." 是種解法，但 C# 還有更犀利的武器。

來段程式做示範。假設我們的專案資料物件有個屬性 Stage 代表專案所處階段，其值有提案、執行、驗收、結案等幾種狀態。 不花腦筋的寫法是 project.Stage == "驗收"。另外，CloseAndArchive() 方法則有段檢核邏輯， 遇到 project.AcceptData 屬性為 null 時，要拋出 ArgumentException 錯誤並提示錯誤屬性名稱為 "AcceptData"。

沿用傳統的開發習慣，程式可能會像這樣：

public class ProjectData
{
    public string Id { get; set; }
    /* 其他專案資訊欄位(省略) */
    /// <summary>
    /// 專案階段：提案、執行、驗收、結案... 等
    /// </summary>
    public string Stage { get; set; }
    /// <summary>
    /// 驗收日期
    /// </summary>
    public DateTime? AcceptDate { get; set; }

}

public class ProjectService
{
    //結案歸檔
    public static void CloseAndArchive(ProjectData project)
    {
        if (project.Stage != "驗收")
        {
            throw new ApplicationException("專案未達[驗收]階段");
        }
        else if (project.AcceptDate == null)
        {
            throw new ArgumentException("Can't be null", "AcceptDate");
        }
        project.Stage = "結案";
        //將專案狀態更新至資料庫(省略)
    }
}

寫完程式，忽然接到規格變更通知，「驗收」要改為「驗收完成」，AcceptDate 屬性要更名為 UserAcceptDate，OK，算算共有四處要改。

改四個地方感覺還好，但這只是簡單範例，換成較複雜的中大型專案，包含這些字串常數的程式碼可能散落在數十個類別，甚至位於不同專案， 動用「搜尋/取代」整個 .sln 配合肉眼確認一一置換是唯一解，且一旦漏改就等著在執行階段爆炸，驚喜無窮。

面對這個問題，C# 有更好的解法。

以階段名稱為例，我們可為專案階段宣告一個列舉，Stages 當成 Stage 型別，要做設定或比對時可寫成prjoect.Stage = Stages.驗收 需要轉為字串使用時，則可用Stages.驗收.ToString()，這樣再也不怕打錯字埋雷，錯字在開發跟編譯階段就會現形。

另外，需要屬性名稱或變數名稱作字串使用的場合，別直接寫死 "變數名稱" 。C# 6.0 有個新利器 nameof， 寫成 nameof(變數名稱) 或 nameof(屬性名稱) 可將名稱字串轉成強型別寫法，除了不怕打錯字，更改名稱時亦會自動換掉。

於是，前述程式可改寫如下：

public enum Stages
{
    提案,
    審核,
    執行,
    驗收,
    結案
}

public class ProjectData
{
    public string Id { get; set; }
    /* 其他專案資訊欄位(省略) */
    /// <summary>
    /// 專案階段：提案、執行、驗收、結案... 等
    /// </summary>
    public Stages Stage { get; set; }
    /// <summary>
    /// 驗收日期
    /// </summary>
    public DateTime? AcceptDate { get; set; }

}

public class ProjectService
{
    //結案歸檔
    public static void CloseAndArchive(ProjectData project)
    {
        if (project.Stage != Stages.驗收)
        {
            throw new ApplicationException($"專案未達[{nameof(Stages.驗收)}]階段");
        }
        else if (project.AcceptDate == null)
        {
            throw new ArgumentException("Can't be null", nameof(project.AcceptDate));
        }
        project.Stage = Stages.結案;
        //將專案狀態更新至資料庫(省略)
    }
}

補充：列舉轉常數字串的 Stages.驗收.ToString() 可改用nameof(Stages.驗收)，除了寫法稍簡潔外，nameof() 可以用於 const、方法參數預設值等需要「靜態期常數」(Compiled-Time Constant)的場合，適用範圍更廣。示範：

改用列舉及 nameof 後，一樣要改 Stage 名稱及 UserAcceptDate，我們只需要用 Visual Studio 的 Rename 功能將 Stages 列舉的「驗收」更名為「驗收完成」， 將 Project 類別的 AcceptDate 改成 UserAcceptDate，Visual Studio 會自動改完所有要修改的地方，萬無一失。

常打錯字或改程式漏東忘西的人，看到這裡應該熱淚盈眶了吧？善用 C# 小技巧，生活更美好~

Tips of using C# enum and nameof() insead of string constants to make your code robust and easy to maintain.