使用C# (.NET Core) 實現模板方法模式 (Template Method Pattern)

solenovex發表於2018-04-17

C#模式

本文的概念內容來自深入淺出設計模式一書.

專案需求

有一家咖啡店, 供應咖啡和茶, 它們的工序如下:

咖啡:

茶:

可以看到咖啡和茶的製作工序是差不多的, 都是有4步, 其中有兩步它們兩個是一樣的, 另外兩步雖然具體內容不一樣, 但是都做做的同一類工作.

現在問題也有了, 當前的設計兩個類裡面有很多重複的程式碼, 那麼應該怎樣設計以減少冗餘呢?

初次嘗試

把共有的方法放到父類裡面, 把不同的方法放到子類裡面.

父類裡面有一個抽象的prepareRecipe()方法[翻譯為準備烹飪方法/製作方法], 然後在不同的子類裡面有不同的實現. 也就是說每個子類都有自己製作飲料的方法.

再仔細想想應該怎樣設計

可以發現兩個飲料的製作方法遵循了同樣的演算法:

把水燒開
用開水衝咖啡或茶
把衝開的飲料放到杯裡
新增適當的調料

現在我們來抽像prepareRecipe()方法:

1.先看看兩個飲料的差異:

兩種飲料都有四道工序, 兩個是完全一樣的, 另外兩個在具體的實現上是略有不同的, 但是還是同樣性質的工序.

這兩道不同的工序的本質就是衝飲料和新增調料, 所以prepareRecipe()可以這樣寫:

2. 把上面的方法放到超類裡:

這個父類是抽象的, prepareRecipe()將會用來製作咖啡或者茶, 而且我不想讓子類去重寫這個方法, 因為製作工序(演算法)是一定的.

只不過裡面的第2部和第4部是需要子類自己來實現的. 所以brew()和addCondiments()是兩個抽象的方法, 而另外兩個方法則直接在父類裡面實現了.

3. 最後茶和咖啡就是這個樣子的:

我們做了什麼?

我們意識到兩種飲料的工序大體是一致的, 儘管某些工序需要不同的實現方法. 所以我們把這些飲料的製作方法歸納到了一個基類CaffeineBeverage裡面.

CaffeineBeverage控制著整個工序, 第1, 3部由它自己完成, 第2, 4步則是由具體的飲料子類來完成.

初識模板方法模式

上面的需求種, prepareRecipe() 就是模板方法. 因為, 它首先是一個方法, 然後它還充當了演算法模板的角色, 這個需求裡, 演算法就是製作飲料的整個工序.

所以說: 模板方法定義了一個演算法的步驟, 並允許子類提供其中若干個步驟的具體實現.

捋一遍整個流程

1. 我需要做一個茶:

2. 然後呼叫茶的模板方法:

3. 在模板方法裡面執行下列工序:

boildWater();

brew();

pourInCup();

addCondiments();

模板方法有什麼好處?

不使用模板方法時:

咖啡和茶各自控制自己的演算法.
飲料間的程式碼重複.
改變演算法需要修改多個地方
新增新飲料需要做很多工作.
演算法分佈在了不同的類裡面

使用模板方法後:

CaffeineBeverage這個父類控制並保護演算法
父類最大化的程式碼的複用
演算法只在一個地方, 改變演算法也只需改變這個地方
新的飲料只需實現部分工序即可
父類掌握著演算法, 但是依靠子類去做具體的實現.

模板方法定義

模板方法在一個方法裡定義了一套演算法的骨架, 演算法的某些步驟可以讓子類來實現. 模板方法讓子類重新定義演算法的某些步驟而無需改變演算法的結構.

類圖:

這個抽象類:

針對這個抽象類, 我們可以有一些擴充套件:

看這個hook方法, 它是一個具體的方法, 但是啥也沒做, 這種就叫做鉤子方法. 子類可以重寫該方法, 也可以不重寫.

模板方法裡面的鉤子

所謂的鉤子, 它是一個在抽象類裡面宣告的方法, 但是方法裡面預設的實現是空的. 這也就給了子類"鉤進"演算法某個點的能力, 當然子類也可以不這麼做, 就看子類是否需要了.

看這個帶鉤子的飲料父類:

customerWantsCondiments()就是鉤子, 子類可以重寫它.

在prepareRecipe()方法裡面, 通過這個鉤子方法的結果來決定是否新增調料.

下面是使用這個鉤子的咖啡:

C#程式碼實現

不帶鉤子的父類:

using System;

namespace TemplateMethodPattern.Abstractions
{
    public abstract class CaffeineBeverage
    {
        public void PrepareRecipe()
        {
            BoilWater();
            Brew();
            PourInCup();
            AddCondiments();
        }

        protected void BoilWater()
        {
            Console.WriteLine("Boiling water");
        }

        protected abstract void Brew();

        protected void PourInCup()
        {
            Console.WriteLine("Pouring into cup");
        }

        protected abstract void AddCondiments();
    }
}

咖啡和茶:

using System;
using TemplateMethodPattern.Abstractions;

namespace TemplateMethodPattern.Beverages
{
    public class Coffee: CaffeineBeverage
    {
        protected override void Brew()
        {
            Console.WriteLine("Dripping Coffee through filter");
        }

        protected override void AddCondiments()
        {
            Console.WriteLine("Adding Sugar and Milk");
        }
    }
}

using System;
using TemplateMethodPattern.Abstractions;

namespace TemplateMethodPattern.Beverages
{
    public class Tea: CaffeineBeverage
    {
        protected override void Brew()
        {
            Console.WriteLine("Steeping the tea");
        }

        protected override void AddCondiments()
        {
            Console.WriteLine("Adding Lemon");
        }
    }
}

測試:

var tea = new Tea();
tea.PrepareRecipe();

帶鉤子的父類:

using System;

namespace TemplateMethodPattern.Abstractions
{
    public abstract class CaffeineBeverageWithHook
    {
        public void PrepareRecipe()
        {
            BoilWater();
            Brew();
            PourInCup();
            if (CustomerWantsCondiments())
            {
                AddCondiments();
            }
        }

        protected abstract void Brew();
        protected abstract void AddCondiments();

        protected void BoilWater()
        {
            Console.WriteLine("Boiling water");
        }

        protected void PourInCup()
        {
            Console.WriteLine("Pouring into cup");
        }

        public virtual bool CustomerWantsCondiments()
        {
            return true;
        }
    }
}

咖啡:

using System;
using TemplateMethodPattern.Abstractions;

namespace TemplateMethodPattern.Beverages
{
    public class CoffeeWithHook: CaffeineBeverageWithHook
    {
        protected override void Brew()
        {
            Console.WriteLine("Dripping Coffee through filter");
        }

        protected override void AddCondiments()
        {
            Console.WriteLine("Adding Sugar and Milk");
        }

        public override bool CustomerWantsCondiments()
        {
            var answer = GetUserInput();
            if (answer == "yes")
            {
                return true;
            }
            return false;
        }

        private string GetUserInput()
        {
            Console.WriteLine("Would you like milk and sugar with you coffee (y/n) ?");
            var keyInfo = Console.ReadKey();
            return keyInfo.KeyChar == 'y' ? "yes" : "no";
        }
    }
}

測試:

        static void MakeCoffeeWithHook()
        {
            var coffeeWithHook = new CoffeeWithHook();
            Console.WriteLine("Making coffee...");
            coffeeWithHook.PrepareRecipe();
        }

鉤子和抽象方法的區別?

抽象方法是演算法裡面必須要實現的一個方法或步驟, 而鉤子是可選實現的.

好萊塢設計原則

好萊塢設計原則就是: 別給我們打電話, 我們會給你打電話.

好萊塢原則可以防止依賴關係腐爛. 依賴關係腐爛是指高階別的元件依賴於低階別的元件, 它又依賴於高階別元件, 它又依賴於橫向元件, 又依賴於低階別元件....以此類推. 當腐爛發生的時候, 沒人會看懂你的系統是怎麼設計的.

而使用好萊塢原則, 我們可以讓低階別元件鉤進一個系統, 但是高階別元件決定何時並且以哪種方式它們才會被需要. 換句話說就是, 高階別元件對低階別元件說: "別給我們打電話, 我們給你們打電話".

好萊塢原則和模板方法模式

模板方法裡, 父類控制演算法, 並在需要的時候呼叫子類的方法.

而子類從來不會直接主動呼叫父類的方法.

其他問題

好萊塢原則和依賴反轉原則DIP的的區別?

DIP告訴我們不要使用具體的類, 儘量使用抽象類. 而好萊塢原則則是讓低階別元件可以被鉤進演算法中去, 也沒有建立低階別元件和高階別元件間的依賴關係.

三種模式比較:

模板方法模式: 子類決定如何實現演算法中特定的步驟

策略模式: 封裝變化的行為並使用委託來決定哪個行為被使用.

工廠方法模式: 子類決定例項化哪個具體的類.

使用模板方法做排序

看看java裡面陣列的排序方法:

mergeSort就可以看做事模板方法, compareTo()就是需要具體實現的方法.

但是這個並沒有使用子類, 但是根據實際情況, 還是可以靈活使用的, 你需要做的就是實現Comparable介面即可., 這個介面裡面只有一個CompareTo()方法.

具體使用C#就是這樣:

鴨子:

using System;

namespace TemplateMethodPattern.ForArraySort
{
    public class Duck : IComparable
    {
        private readonly string _name;
        private readonly int _weight;

        public Duck(string name, int weight)
        {
            _name = name;
            _weight = weight;
        }

        public override string ToString()
        {
            return $"{_name} weights {_weight}";
        }

        public int CompareTo(object obj)
        {
            if (obj is Duck otherDuck)
            {
                if (_weight < otherDuck._weight)
                {
                    return -1;
                }
                if (_weight == otherDuck._weight)
                {
                    return 0;
                }
            }
            return 1;
        }
    }
}

比較鴨子:

        static void SortDuck()
        {
            var ducks = new Duck[]
            {
                new Duck("Duffy", 8),
                new Duck("Dewey",  2),
                new Duck("Howard", 7),
                new Duck("Louie", 2),
                new Duck("Donal", 10),
                new Duck("Huey", 3)
            };
            Console.WriteLine("Before sorting:");
            DisplayDucks(ducks);

            Array.Sort(ducks);

            Console.WriteLine();
            Console.WriteLine("After sorting:");
            DisplayDucks(ducks);
        }

        private static void DisplayDucks(Duck[] ducks)
        {
            foreach (Duck t in ducks)
            {
                Console.WriteLine(t);
            }
        }

效果:

其他鉤子例子

java的JFrame:

JFrame父類裡面有一個update()方法, 它控制著演算法, 我們可以使用paint()方法來鉤進到該演算法的那部分.

父類裡面JFrame的paint()啥也沒做, 就是個鉤子, 我們可以在子類裡面重寫paint(), 上面例子的效果就是:

另一個例子Applet小程式:

這5個方法全是重寫的鉤子...

我沒看過winform或者wpf/sl的原始碼, 我估計也應該有一些鉤子吧.

總結

好萊塢原則: "別給我們打電話, 我們給你打電話"

模板方法模式: 模板方法在一個方法裡定義了一套演算法的骨架, 演算法的某些步驟可以讓子類來實現. 模板方法讓子類重新定義演算法的某些步驟而無需改變演算法的結構

該系列的原始碼: https://github.com/solenovex/Head-First-Design-Patterns-in-CSharp