C#中物件狀態模式教學範例

2022-06-01 18:00:28

真實的故事

當老胡還是小胡的時候，跟隨團隊一起開發一款遊戲。這款遊戲是一款末日生存類遊戲，玩家可以

收集資源，兩種，一種金子，一種鐵。
升級自身
擊殺敵人
用資源合成裝備

專案開發的很順利，我那時得到一個任務，是為遊戲做一個新手教學，在這個教學裡面，通過一系列步驟，引導新手玩家熟悉這個遊戲。遊戲設計給出的教學包含以下步驟

收集金子
收集鐵
擊殺敵人
升級

同時要求在不用的階段顯示不同的提示以正確引導玩家。考慮合成裝備算是高階玩家才會接觸到的功能，所以暫時不打算放在新手教學裡面。

當老大把任務交給我的時候，我感覺簡單爆了，不就寫一個新手教學麼，要求又那麼明確，應該要不了多少時間。於是，一個上午過後，我交出瞭如下程式碼。

定義列舉表示教學進度

首先用一個列舉，表示教學進行的不同程度

enum TutorialState
{
    GetGold,
    GetIron,
    KillEnemy,
    LevelUp
}

定義角色類

無需多言，封裝收集到的資源數、擊殺敵人數量、角色等級和一些升級介面等

class Player
{
    private int ironNum;
    private int goldNum;
    private int enemyKilled;
    private int level;
    public int IronNum => ironNum;
    public int GoldNum => goldNum;
    public int EnemyKilled => enemyKilled;
    public int Level => level;
    public void CollectIron(int num)
    {
        ironNum += num;
    }
    public void CollectGold(int num)
    {
        goldNum += num;
    }
    public void KillEnemy()
    {
        enemyKilled++;
    }
    public void LevelUp()
    {
        level++;
    }
}

定義教學類

定義一個教學類，包括

顯示幫助文字以協助玩家通過當前教學步驟
判斷玩家是否已經完成當前教學步驟，若是，切換到下一個步驟直到完成教學

class GameTutorial
{
    private TutorialState currentState;
    private Player player;
    public GameTutorial(Player player)
    {
        this.player = player;
    }
    public void ShowHelpDescription()
    {
        switch (currentState)
        {
            case TutorialState.GetGold:
                Console.WriteLine("Please follow instruction to get gold");
                break;
            case TutorialState.GetIron:
                Console.WriteLine("Please follow instruction to get Iron");
                break;
            case TutorialState.KillEnemy:
                Console.WriteLine("Please follow instruction to kill enemy");
                break;
            case TutorialState.LevelUp:
                Console.WriteLine("Please follow instruction to Up your level");
                break;
            default:
                throw new Exception("Not Support");
        }
    }
    public void ValidateState()
    {
        switch (currentState)
        {
            case TutorialState.GetGold:
                {
                    if (player.GoldNum > 0)
                    {
                        Console.WriteLine("Congratulations, you finished Gold Collect Phase");
                        currentState = TutorialState.GetIron;
                    }
                    else
                    {
                        Console.WriteLine("You need to collect gold");
                    }
                    break;
                }
            case TutorialState.GetIron:
                {
                    if (player.IronNum > 0)
                    {
                        Console.WriteLine("Congratulations, you finished Iron Collect Phase");
                        currentState = TutorialState.KillEnemy;
                    }
                    else
                    {
                        Console.WriteLine("You need to collect Iron");
                    }
                    break;
                }
            case TutorialState.KillEnemy:
                {
                    if (player.EnemyKilled > 0)
                    {
                        Console.WriteLine("Congratulations, you finished Enemy Kill Phase");
                        currentState = TutorialState.LevelUp;
                    }
                    else
                    {
                        Console.WriteLine("You need to kill enemy");
                    }
                    break;
                }
            case TutorialState.LevelUp:
                {
                    if (player.Level > 0)
                    {
                        Console.WriteLine("Congratulations, you finished the whole tutorial");
                        currentState = TutorialState.LevelUp;
                    }
                    else
                    {
                        Console.WriteLine("You need to level up");
                    }
                    break;
                }
            default:
                throw new Exception("Not Support");
        }
    }
}

測試程式碼

static void Main(string[] args)
{
    Player player = new Player();
    GameTutorial tutorial = new GameTutorial(player);
    tutorial.ShowHelpDescription();
    tutorial.ValidateState();
    //收集黃金
    player.CollectGold(1);
    tutorial.ValidateState();
    tutorial.ShowHelpDescription();
    //收集木頭
    player.CollectIron(1);
    tutorial.ValidateState();
    tutorial.ShowHelpDescription();
    //殺敵
    player.KillEnemy();
    tutorial.ValidateState();
    tutorial.ShowHelpDescription();
    //升級
    player.LevelUp();
    tutorial.ValidateState();
}

執行結果

看起來一切都好。。編寫的程式碼既能夠根據當前步驟顯示不同的提示，還可以成功的根據玩家的進度切換到下一個步驟。

於是，我自信滿滿的申請了code review，按照我的想法，這段程式碼通過code review應該是板上釘釘的事情，誰知，老大看到程式碼，差點沒背過氣去。。。稍微平復了一下心情之後，他給了我幾個靈魂拷問。

GameTutorial需要知道各個步驟的滿足條件和提示，它是不是知道的太多了？這符合迪米特法則嗎？
如果我們遊戲之後新增一個教學步驟，指導玩家升級武器，是不是GameTutorial需要修改？能有辦法規避這種新增的改動嗎？
如果我們要修改現在的教學步驟之間的順序關係，GameTutorial是不是又不能避免要被動刀？能有辦法儘量減少這種修改的工作量嗎？
Switch case 在現有的情況下已經如此長，如果我們再加入新的步驟，這個方法會變成又臭又長的裹腳布嗎？

本來以為如此簡單的一個功能，沒想到還是有那麼多彎彎道道，只怪自己還是太年輕啊！最後他悠悠的告訴我，去看看狀態模式吧，想想這段程式碼可以怎麼重構。

狀態模式出場

定義

物件擁有內在狀態，當內在狀態改變時允許其改變行為，這個物件看起來像改變了其類

有點意思，看來我們可以把教學的不同步驟抽象成不同的狀態，然後在各個狀態內部實現切換狀態和顯示幫助檔案的邏輯，這樣做的好處是

符合迪米特法則，把各個步驟所對應的邏輯推遲到子類，教學類就不需要了解每個步驟的邏輯細節，同時隔離了教學類和狀態類，確保狀態類的修改不會影響教學類
符合開閉原則，如果新新增步驟，我們僅僅需要新增步驟子類並修改相鄰的步驟切換邏輯，教學類無需任何改動

接著我們看看UML，

一目瞭然，在我們的例子裡面，state就是教學子步驟，context就是教學類，內部包含教學子步驟並轉發請求給教學子步驟，我們跟著來重構一下程式碼吧。

程式碼重構

建立狀態基礎類別

第一步我們需要刪除之前的列舉，取而代之的是一個抽象類當作狀態基礎類別，即，各個教學步驟類的基礎類別。注意，每個子狀態要自己負責狀態切換，所以我們需要教學類暴露介面以滿足這個功能。

abstract class TutorialState
{
    public abstract void ShowHelpDescription();
    public abstract void Validate(GameTutorial tutorial);
}

重構教學類

重構教學類體現在以下方面

新增內部狀態表面當前處於哪個步驟，在建構函式中給予初始值
暴露介面以讓子狀態能修改當前狀態以完成狀態切換
因為需要子狀態能存取玩家當前資料以判斷是否能切換狀態，需要新加介面以避免方法鏈
修改ShowHelpDescription和ValidateState的邏輯，直接轉發方法呼叫至當前狀態

class GameTutorial
{
    private TutorialState currentState;
    private Player player;
    public int PlayerIronNum => player.IronNum;
    public int PlayerLevel => player.Level;
    public int PlayerGoldNum => player.GoldNum;
    public int PlayerEnemyKilled => player.EnemyKilled;
    public void SetState(TutorialState state)
    {
        currentState = state;
    }
    public GameTutorial(Player player)
    {
        this.player = player;
        currentState = TutorialStateContext.GetGold;
    }
    public void ShowHelpDescription()
    {
        currentState.ShowHelpDescription();
    }
    public void ValidateState()
    {
        currentState.Validate(this);
    }
}

建立各個子狀態

接著我們建立各個子狀態代表不同的教學步驟

class TutorialSateGetGold : TutorialState
{
    public override void ShowHelpDescription()
    {
        Console.WriteLine("Please follow instruction to get gold");
    }
    public override void Validate(GameTutorial tutorial)
    {
        if (tutorial.PlayerGoldNum > 0)
        {
            Console.WriteLine("Congratulations, you finished Gold Collect Phase");
            tutorial.SetState(TutorialStateContext.GetIron);
        }
        else
        {
            Console.WriteLine("You need to collect gold");
        }
    }
}
class TutorialStateGetIron : TutorialState
{
    public override void ShowHelpDescription()
    {
        Console.WriteLine("Please follow instruction to get Iron");
    }
    public override void Validate(GameTutorial tutorial)
    {
        if (tutorial.PlayerIronNum > 0)
        {
            Console.WriteLine("Congratulations, you finished Iron Collect Phase");
            tutorial.SetState(TutorialStateContext.KillEnemy);
        }
        else
        {
            Console.WriteLine("You need to collect iron");
        }
    }
}
class TutorialStateKillEnemy : TutorialState
{
    public override void ShowHelpDescription()
    {
        Console.WriteLine("Please follow instruction to kill enemy");
    }
    public override void Validate(GameTutorial tutorial)
    {
        if (tutorial.PlayerEnemyKilled > 0)
        {
            Console.WriteLine("Congratulations, you finished enemy kill Phase");
            tutorial.SetState(TutorialStateContext.LevelUp);
        }
        else
        {
            Console.WriteLine("You need to collect kill enemy");
        }
    }
}
class TutorialStateLevelUp : TutorialState
{
    public override void ShowHelpDescription()
    {
        Console.WriteLine("Please follow instruction to level up");
    }
    public override void Validate(GameTutorial tutorial)
    {
        if (tutorial.PlayerLevel > 0)
        {
            Console.WriteLine("Congratulations, you finished the whole tutorial");
        }
    }
}

新增狀態容器

這是模式中沒有提到的知識點，一般來說，為了避免大量的子狀態物件被建立，我們會構造一個狀態容器，以靜態變數的方式初始化需要使用的子狀態。

static class TutorialStateContext
{
    public static TutorialState GetGold;
    public static TutorialState GetIron;
    public static TutorialState KillEnemy;
    public static TutorialState LevelUp;
    static TutorialStateContext()
    {
        GetGold = new TutorialSateGetGold();
        GetIron = new TutorialStateGetIron();
        KillEnemy = new TutorialStateKillEnemy();
        LevelUp = new TutorialStateLevelUp();
    }
}

測試程式碼部分保持不變，直接執行，結果和原來一樣，重構成功。

結語

這就是狀態模式和它的使用場景，比較一下重構前和重構後的程式碼，發現程式碼通過重構滿足了開閉原則和迪米特法則，相信重構後的程式碼能通過code review吧。_
不過狀態模式雖然好，也有自己的缺點，因為需要一個子類對應一個子狀態，那麼子狀態太多的時候，就會出現類爆炸的情況。還請大家多注意。
作為行為模式之一的狀態模式，在日常開發中出現的頻率還是挺高的，比如遊戲中經常用到的狀態機，就是狀態模式的一種應用場景，大家在平時工作中保持善於觀察的眼睛，就能學到更多的東西。

以上就是C#中物件狀態模式教學範例的詳細內容，更多關於C#物件狀態模式的資料請關注it145.com其它相關文章！