C# 中的“智慧列舉”：如何在列舉中增加行為

反骨仔發表於2023-05-17
C#

目錄

  • 列舉的基本用法回顧
  • 列舉常見的設計模式運用
    • 介紹
  • 智慧列舉
    • 程式碼示例
    • 業務應用
  • 小結

列舉的基本用法回顧

以下是一個常見的 C# 列舉（enum）的示例：

enum Weekday
{
    Monday,
    Tuesday,
    Wednesday,
    Thursday,
    Friday,
    Saturday,
    Sunday
}

class Program
{
    static void Main(string[] args)
    {
        Weekday today = Weekday.Tuesday;

        Console.WriteLine("今天是" + today.ToString() + "。");
        Console.WriteLine("明天是" + (Weekday)(((int)today + 1) % 7) + "。");
        Console.WriteLine("昨天是" + (Weekday)(((int)today + 6) % 7) + "。");
    }
}

在這個示例中，我們定義了一個名為 Weekday 的列舉，其中包括每個星期的日子。然後在 Main 方法中，我們將 today 變數設定為 Tuesday，並使用 ToString() 方法將其轉換為字串。

接下來，我們計算並輸出明天和昨天的日子。我們使用強制型別轉換將列舉值轉換為整數，然後在取模 7 意義下加或減 1 或 6，以便正確地計算出前一天或後一天的日子。

輸出結果應該是這樣的：

今天是 Tuesday。
明天是 Wednesday。
昨天是 Monday。

列舉常見的設計模式運用

enum 可以應用在許多種設計模式下：

  • 狀態模式
  • 策略模式
  • 工廠模式
  • 觀察者模式

介紹

  1. 狀態模式

狀態模式用於根據物件的內部狀態來改變其行為。enum 可以很好地表示物件的狀態，因此它是實現狀態模式的常見選擇。在 C# 中，您可以使用 switch 語句來根據不同的 enum 值執行不同的操作。

  1. 策略模式

策略模式允許您根據執行時條件選擇不同的演演算法或行為。enum 可以很好地表示這些條件，因此它是實現策略模式的常見選擇。在 C# 中，您可以使用 switch 語句或 if-else 語句來根據不同的 enum 值選擇不同的演演算法或行為。

  1. 工廠模式

工廠模式允許您使用一個共同的介面來建立不同的物件。enum 可以很好地表示這些物件的型別，因此它是實現工廠模式的常見選擇。在 C# 中，您可以使用 switch 語句或 if-else 語句來根據不同的 enum 值建立不同的物件。

  1. 觀察者模式

觀察者模式用於建立物件之間的鬆散耦合關係。enum 可以很好地表示觀察者物件的狀態，因此它是實現觀察者模式的常見選擇。在 C# 中，您可以使用 enum 來表示觀察者物件的狀態，並使用委託或事件來通知觀察者物件。

智慧列舉

什麼是智慧列舉？智慧列舉不是官方的一個稱謂，而是作者定義的一個名詞。

這種帶行為的一種列舉，簡單的可以定義為：智慧列舉 = 列舉 + 豐富的行為。

它由原來的 enum 型別（值型別）改變成了 class 型別（引用型別），允許您將行為和方法繫結到每個列舉型別上。這意味著您可以在列舉型別上呼叫方法和屬性，就像在類例項上呼叫它們一樣。

智慧列舉跟設計模式的意義一樣，可以幫助您避免重複的程式碼，並提高程式碼的可讀性和可維護性。它們還可以使您的程式碼更加型別安全，因為編譯器可以驗證您是否使用了正確的列舉值。

程式碼示例

首先，我們先定義一個抽象的型別，方便後續重用：

public abstract class Enumeration<TEnum> : IEquatable<Enumeration<TEnum>> where TEnum : Enumeration<TEnum>
{
    private static readonly Dictionary<int, TEnum?> Enumerations = GetEnumerations();

    /// <summary>
    /// 列舉型別
    /// </summary>
    private static readonly Type EnumType = typeof(TEnum);

    protected Enumeration(int value, string name)
    {
        Value = value;
        Name = name;
    }

    /// <summary>
    /// 名稱
    /// </summary>
    public string Name { get; protected init; }

    /// <summary>
    /// 值
    /// </summary>
    public int Value { get; protected init; }

    public static TEnum? FromName(string name) => Enumerations.Values.SingleOrDefault(x => x.Name == name);

    public static TEnum? FromValue(int value) => Enumerations.TryGetValue(value, out var enumeration) ? enumeration : default;

    public bool Equals(Enumeration<TEnum>? other) => other is not null && GetType() == other.GetType() && Value == other.Value;

    public override bool Equals(object? obj) => obj is Enumeration<TEnum> other && Equals(other);

    public override int GetHashCode() => HashCode.Combine(Value, Name);

    private static Dictionary<int, TEnum?> GetEnumerations() => EnumType
        .GetFields(BindingFlags.Public | BindingFlags.Static | BindingFlags.FlattenHierarchy)
        .Where(x => EnumType.IsAssignableFrom(x.FieldType))
        .Select(x => (TEnum?)x.GetValue(default)).ToDictionary(x => x?.Value ?? 0);
}

先簡單解讀一下。

這是一個通用的 C# 抽象類，用於實現列舉的高階功能。它使用泛型型別 TEnum 來表示列舉型別，並繼承自 IEquatable<Enumeration<TEnum>> 介面，以支援比較操作。

這個抽象類包含了一些常用的列舉操作方法，例如 FromName 和 FromValue，它們可以透過名稱或值來獲取列舉值。它還重寫了 Equals 和 GetHashCode 方法，以便可以比較兩個列舉值是否相等。

該類中的核心方法是 GetEnumerations，它使用反射獲取當前列舉型別中的所有欄位，並將它們轉換為列舉值。在這個過程中，它還會檢查欄位的型別是否與列舉型別相同，並將值儲存在一個字典中，以便以後可以快速地訪問它們。

透過繼承這個抽象類，您可以輕鬆地實現自己的列舉型別，並獲得許多有用的功能，例如透過名稱和值獲取列舉值，並支援比較操作。

業務應用

我們通常會將列舉型別這樣定義，而在觸發業務邏輯時會使用 switch 來執行不同的行為，這樣就很容易會將邏輯分散在不同的地方。

/// <summary>
/// 信用卡型別
/// </summary>
public enum CreditCardType
{
    None = 0,
    Standard = 1,
    Silver = 2,
    Gold = 3,
}

那麼升級後的智慧列舉應該是怎樣的呢？它到底智慧在哪裡？

/// <summary>
/// 信用卡
/// </summary>
public abstract class CreditCard : Enumeration<CreditCard>
{
    public static readonly CreditCard Gold = new GoldCreditCard();
    public static readonly CreditCard Silver = new SilverCreditCard();
    public static readonly CreditCard Standard = new StandardCreditCard();
    public static readonly CreditCard None = new NoneCreditCard();
    
    private CreditCard(int value, string name) : base(value, name)
    {
    }

    /// <summary>
    /// 折扣
    /// </summary>
    public abstract double Discount { get; }

    /// <summary>
    /// 金卡
    /// </summary>
    private sealed class GoldCreditCard : CreditCard
    {
        public GoldCreditCard() : base(3, nameof(Gold))
        {
        }

        public override double Discount => 0.2;
    }

    private sealed class SilverCreditCard : CreditCard
    {
        public SilverCreditCard() : base(2, nameof(Silver))
        {
        }

        public override double Discount => 0.1;
    }

    /// <summary>
    /// 標準
    /// </summary>
    private sealed class StandardCreditCard : CreditCard
    {
        public StandardCreditCard() : base(1, nameof(Standard))
        {
        }

        public override double Discount => 0.05;
    }

    /// <summary>
    /// 無
    /// </summary>
    private sealed class NoneCreditCard : CreditCard
    {
        public NoneCreditCard() : base(0, nameof(None))
        {
        }

        public override double Discount => 0;
    }
}

這裡簡單解讀一下。

這是一個信用卡列舉型別的實現，它繼承了之前提到的通用列舉類 Enumeration。其中，GoldCreditCard、SilverCreditCard、StandardCreditCard 和 NoneCreditCard 是四個具體的信用卡子類。

每個子類都重寫了父類 CreditCard 中的 Discount 屬性，以表示不同信用卡的折扣率。GoldCreditCard 有最高的折扣率，NoneCreditCard 沒有任何折扣。

在 CreditCard 類中，Gold、Silver、Standard 和 None 是四個靜態例項，表示四種不同的信用卡型別。每個例項都是透過相應的子類建立的，並傳入相應的值和名稱。值用於標識列舉型別的唯一性，而名稱則是該型別的字串表示。

透過這種方式，我們可以輕鬆地定義和使用不同型別的信用卡。例如，可以透過 CreditCard.Gold 來引用 Gold 信用卡的例項，並獲取它的折扣率。在需要使用信用卡型別的地方，也可以直接使用 CreditCard 型別來表示。

我們平時也可以這樣使用，透過 FromName 和 FromValue：

public class SmartEnumsTests
{
    private readonly ITestOutputHelper _testOutputHelper;

    public SmartEnumsTests(ITestOutputHelper testOutputHelper)
    {
        _testOutputHelper = testOutputHelper;
    }

    /// <summary>
    /// 基本用法
    /// </summary>
    [Fact]
    public void Use()
    {
        var standardCard = CreditCard.FromName("Standard");
        var standardCard2 = CreditCard.FromValue(1);

        Assert.Equal(standardCard, standardCard2);
        _testOutputHelper.WriteLine(standardCard!.ToJson());
    }
}

看完上述的示例程式碼，智慧列舉最明顯的好處應該非常直觀：就是程式碼行數增加了億點點，而不是一點點！

小結

好了，不扯太遠了，今天我們就簡單總結一下內容吧。

智慧列舉 = 列舉 + 豐富的行為。

上述示例內容介紹了一個使用 C# 列舉型別實現信用卡型別的示例。為了更好地實現該功能，我們建立了一個通用列舉類 Enumeration，並在此基礎上實現了 CreditCard 類和其四個具體子類，分別表示不同型別的信用卡。

每個子類都包含一個抽象的 Discount 屬性，表示該型別信用卡的折扣率。而 CreditCard 類中的靜態例項則表示四種不同的信用卡型別。透過這種方式，我們可以輕鬆地定義和使用不同型別的信用卡，並在需要使用信用卡型別的地方直接使用 CreditCard 型別來表示。

相關文章