C#中對象狀態模式教程示例

Posted on by

真實的故事

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

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

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

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

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

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

定義枚舉表示教程進度

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

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#對象狀態模式 的資料請關註WalkonNet其它相關文章！

推薦閱讀：