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

時間 2020-10-22

標籤 git 程序員 github app 測試優化 this 3d code blog 欄目 Git 简体版

原文原文鏈接

一：背景

1. 講故事

前段時間和同事負責一個項目的兩個業務模塊，可能你們缺乏溝通，致使本該定義一個 Enum 的地方結果我倆各自定義了一個，致使後面這兩個 Enum 進行對接就煩了，爲了方便理解，也不想讓你們看這崴腳的英文拼寫，我就拿銀行舉例吧。git

A同事定義的枚舉

public enum BankEnum
    {
        ICBC = 1,
        CMSB = 2,
        CMBC = 3
    }

B同事定義的枚舉

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

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

二：尋找解決辦法

1. 手工匹配

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

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 的對應關係呢？？？app

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 的轉換，代碼以下：this

/// <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);
        }
    }

代碼邏輯仍是比較簡單的，接下來寫兩個例子測試下：3d

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 的時候，寫出來的代碼是又臭又長，好比下面這樣：code

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

又是 typeof 又是類型強轉換，並且強轉不過來的話還會拋異常，基於各類緣由 framework 又新增了一個 TryParse，以下圖所示：blog

看起來確實好多了，但仍是以爲有點不爽，爲了再順眼一些，我決定在 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>();，是否是就順眼多了哈。