技術債！ 怎樣簡潔高效的實現多個 Enum 自由轉換

一線碼農發表於2020-10-21

一：背景

1. 講故事

前段時間和同事負責一個專案的兩個業務模組，可能大家缺少溝通，導致本該定義一個 Enum 的地方結果我倆各自定義了一個，導致後面這兩個 Enum 進行對接就煩了，為了方便理解，也不想讓大家看這崴腳的英文拼寫，我就拿 銀行 舉例吧。

  • A同事 定義的列舉

    public enum BankEnum
    {
        ICBC = 1,
        CMSB = 2,
        CMBC = 3
    }
  • B同事 定義的列舉

    public enum ChinaBankEnum
    {
        中國民生銀行 = 1,
        中國工商銀行 = 2,
        中國招商銀行 = 3,
    }

這就很尬尷了，怎麼將 ChinaBankEnum 轉成 BankEnum 呢？ 為了尋求多快好省，本篇就聊聊這個問題。

二：尋找解決辦法

1. 手工匹配

本質上就是找兩個 Enum 的 mapping 關係，人肉匹配那是最簡單粗暴的，程式碼如下：


        static BankEnum ConvertToEnum(ChinaBankEnum chinaBank)
        {
            switch (chinaBank)
            {
                case ChinaBankEnum.中國工商銀行: return BankEnum.ICBC;
                case ChinaBankEnum.中國民生銀行: return BankEnum.CMSB;
                case ChinaBankEnum.中國招商銀行: return BankEnum.CMBC;
            }

            return default(BankEnum);
        }

看的出來，這種寫法缺少靈活性，作為程式設計師肯定不能滿足於此，既然是找 mapping 關係，我相信很多朋友最早聽說 mapping 一詞是來源於 EntityFramework ，人家在處理 table 到 model 的 mapping 採用的是 Attribute，是不是這樣，靈感就在於此，我是不是也可以使用 Attribute 來標記兩個 Enum 的對應關係呢？？？

2. 使用 Attribute

有了這個思路，就可以自定義一個 Attribute，當然比較懶的話，也可以用 Framework 自帶的 DescriptionAttribute,程式碼如下：


    [AttributeUsage(AttributeTargets.All)]
    public class DescriptionAttribute : Attribute
    {
        public DescriptionAttribute(){}

        public DescriptionAttribute(string description){}
    }

接下來就可以把 Description 套在 BankEnum 上，如下程式碼所示：


    public enum BankEnum
    {
        [Description(nameof(ChinaBankEnum.中國工商銀行))]
        ICBC = 1,

        [Description(nameof(ChinaBankEnum.中國民生銀行))]
        CMSB = 2,

        [Description(nameof(ChinaBankEnum.中國招商銀行))]
        CMBC = 3
    }

然後我可以通過反射拿到 Attribute 的值再去 ChinaBankEnum 中去找對應的 key 即可，對不對，為了方便理解，我封裝一個 Enum 的擴充套件方法，通過反射實現 Enum 對 Enum 的轉換，程式碼如下：


    /// <summary>
    /// 列舉的擴充套件方法
    /// </summary>
    public static class EnumExtension
    {
        public static Target ConvertTo<Target>(this Enum enumValue) where Target : Enum
        {
            var key = Enum.GetName(enumValue.GetType(), enumValue);

            var fields = typeof(Target).GetFields();

            foreach (var field in fields)
            {
                var attribute = field.GetCustomAttribute<DescriptionAttribute>();

                if (attribute == null) continue;

                if (key == attribute.Description)
                {
                    var obj = (Target)field.GetValue(typeof(Target));
                    return obj;
                }
            }

            return default(Target);
        }
    }

程式碼邏輯還是比較簡單的，接下來寫兩個例子測試下：


        static void Main(string[] args)
        {
            ChinaBankEnum chinaBankEnum = ChinaBankEnum.中國工商銀行;
            ChinaBankEnum chinaBankEnum2 = ChinaBankEnum.中國招商銀行;

            var bankEnum = chinaBankEnum.ConvertTo<BankEnum>();
            var bankEnum2 = chinaBankEnum2.ConvertTo<BankEnum>();

            Console.WriteLine($"{chinaBankEnum} -> {bankEnum}\r\n{chinaBankEnum2} -> {bankEnum2}");
        }

3. 對 Parse 轉換的一些優化

不知道大家在寫程式碼的時候有沒有發現將 string 或者 int 轉成 Enum 的時候，寫出來的程式碼是又臭又長，比如下面這樣：


 var bankEnum = (ChinaBankEnum)Enum.Parse(typeof(ChinaBankEnum), "中國工商銀行");

又是 typeof 又是型別強轉換，而且強轉不過來的話還會拋異常，基於各種原因 framework 又新增了一個 TryParse，如下圖所示：

看起來確實好多了，但還是覺得有點不爽，為了再順眼一些，我決定在 EnumExtension 中再封裝一個 TryParse 方法，如下程式碼所示：


    public static class EnumExtension
    {
        public static T TryParse<T>(this string value) where T : struct
        {
            var isSucc = Enum.TryParse<T>(value, out var result);

            if (!isSucc) return default(T);

            return result;
        }
    }

呼叫的時候就可以這麼來: var bankEnum = "中國工商銀行".TryParse<ChinaBankEnum>();，是不是就順眼多了哈。

三： 總結

哈，本篇就來自於專案開發中遇到的一個坑，相信很多朋友都會遇到類似的情況，遺憾的是預設的 Enum 提供的功能太弱，大家可以根據自己的業務在 Enum 上擴充更多實用的方法，如獲取所有的key，所有的value 等等，讓自己的程式碼更加整潔，乾淨，強大！

更多高質量乾貨：參見我的 GitHub: dotnetfly

圖片名稱

相關文章