无废话C#设计模式之十四：Template Method

意图

定义一个操作中的算法的骨架，而将一些步骤延迟到子类中。Template Method使得子类可以不改变一个算法的结构即可重定义该算法的某些特定步骤。

 
场景

模版方法是非常容易理解的设计模式，一来是因为它没有过多结构上的交错，二来是因为这种代码复用技术对于掌握OO知识的人来说非常容易可以想到，很可能你已经在很多地方运用了模版方法。在运用一些设计模式的时候常常也会一起运用模版方法，甚至有的设计模式本身就带有模版方法的思想。

今天，我们给出这样一个实际的例子。做过银行支付、支付宝支付的人都知道，一个支付的过程是基于两个接口的。提交接口和网关返回接口，虽然各大网关的支付接口格式不同，比如有的网关对于支付金额的参数是money，有的网关又是amount，但是从支付的提交过程来说，我们一般都会经历以下步骤：

• 获取订单信息，验证订单的合法性
• 生成用于提交到各大网关的表单
• 记录日志
• 把表单提交到相应的网关

对于各个网关，生成的提交表单以及记录日志的方式是不一样的，但是整个支付流程以及流程中的获取订单信息、提交表单的过程是一样的。由此引入模版方法模式来复用不变的部分，把可变的部分留给子类去实现。

using System;
using System.Collections.Generic;
using System.Text;

namespace TemplateMethodExample
{
    class Program
    {
        static void Main(string[] args)
        {
            PayGateway pg = new IPSGateway();
            pg.SubmitOrder(new Order());
        }
    }

    class Order
    {
    }

    class SubmitForm
    {
    }

    abstract class PayGateway
    {
        protected abstract void WriteLog(SubmitForm sf);
        protected abstract SubmitForm GenerateOrderForm(Order order);

        public void SubmitOrder(Order order)
        {
            if (order == null)
            {
                Console.WriteLine("Invalid Order");
                return;
            }
            SubmitForm sf = GenerateOrderForm(order);
            if (sf == null)
            {
                Console.WriteLine("Generate Submit Form Failed");
                return;
            }
            WriteLog(sf);
        }
    }

    class IPSGateway : PayGateway
    {
        protected override void WriteLog(SubmitForm sf)
        {
            Console.WriteLine("Log Wrote");
        }

        protected override SubmitForm GenerateOrderForm(Order order) { Console.WriteLine("Submit Form Generated");
            return new SubmitForm();
        }
    }
}

代码执行结果如下图：


代码说明

PayGateway类型是抽象模版角色。它定义了支付过程不变的部分，并且把变化部分定义为抽象操作，让子类去实现。其中的SubmitOrder方法是模版方法。

IPSGateway类型是具体模版角色。它代表了某一种支付网关，并且按照这种支付网关的接口标准来实现生成提交表单和记录日志的操作。


何时采用

如果某些类型的操作拥有共同的实现骨架和不同的实现细节的话，可以考虑使用模版方法来封装统一的部分。

 
实现要点 

复用算法的骨架，将可变的实现细节留给子类实现。

留给子类实现的方法需要在父类中定义，可以是抽象方法也可以是带有默认实现的方法。

 
注意事项 

模版方法可以说是最不像设计模式的设计模式，通常很多设计模式会和模版方法一起使用。