模板方法模式

2.1 模式结构

模板方法模式结构比较简单，其核心是抽象类和其中的模板方法的设计，其结构如图2所示：

由图2可知，模板方法模式包含如下两个角色：

(1) AbstractClass（抽象类）：在抽象类中定义了一系列基本操作(PrimitiveOperations)，这些基本操作可以是具体的，也可以是抽象的，每一个基本操作对应算法的一个步骤，在其子类中可以重定义或实现这些步骤。同时，在抽象类中实现了一个模板方法(Template Method)，用于定义一个算法的框架，模板方法不仅可以调用在抽象类中实现的基本方法，也可以调用在抽象类的子类中实现的基本方法，还可以调用其他对象中的方法。

(2) ConcreteClass（具体子类）：它是抽象类的子类，用于实现在父类中声明的抽象基本操作以完成子类特定算法的步骤，也可以覆盖在父类中已经实现的具体基本操作。

2.2 模式实现

模板方法

一个模板方法是定义在抽象类中的、把基本操作方法组合在一起形成一个总算法或一个总行为的方法。这个模板方法定义在抽象类中，并由子类不加以修改地完全继承下来。模板方法是一个具体方法，它给出了一个顶层逻辑框架，而逻辑的组成步骤在抽象类中可以是具体方法，也可以是抽象方法。由于模板方法是具体方法，因此模板方法模式中的抽象层只能是抽象类，而不是接口。

基本方法

(1) 抽象方法：一个抽象方法由抽象类声明、由其具体子类实现。在C#语言里一个抽象方法以abstract关键字标识。

(2) 具体方法：一个具体方法由一个抽象类或具体类声明并实现，其子类可以进行覆盖也可以直接继承。

(3) 钩子方法：一个钩子方法由一个抽象类或具体类声明并实现，而其子类可能会加以扩展。通常在父类中给出的实现是一个空实现（可使用virtual关键字将其定义为虚函数），并以该空实现作为方法的默认实现，当然钩子方法也可以提供一个非空的默认实现。

在模板方法模式中，钩子方法有两类：第一类钩子方法可以与一些具体步骤“挂钩”，以实现在不同条件下执行模板方法中的不同步骤，这类钩子方法的返回类型通常是bool类型的，这类方法名一般为IsXXX()，用于对某个条件进行判断，如果条件满足则执行某一步骤，否则将不执行，如下代码片段所示：

……  
//模板方法  
public void TemplateMethod()   
{  
Open();  
Display();  
//通过钩子方法来确定某步骤是否执行  
if (IsPrint())   
{  
    Print();  
}  
}  

//钩子方法  
public bool IsPrint()  
{  
    return true;  
}  
……

在代码中IsPrint()方法即是钩子方法，它可以决定Print()方法是否执行，一般情况下，钩子方法的返回值为true，如果不希望某方法执行，可以在其子类中覆盖钩子方法，将其返回值改为false即可，这种类型的钩子方法可以控制方法的执行，对一个算法进行约束。

还有一类钩子方法就是实现体为空的具体方法，子类可以根据需要覆盖或者继承这些钩子方法，与抽象方法相比，这类钩子方法的好处在于子类如果没有覆盖父类中定义的钩子方法，编译可以正常通过，但是如果没有覆盖父类中声明的抽象方法，编译将报错。

在模板方法模式中，抽象类的典型代码如下：

abstract class AbstractClass   
{  
//模板方法  
public void TemplateMethod()   
{  
        PrimitiveOperation1();  
        PrimitiveOperation2();  
        PrimitiveOperation3();  
}  

//基本方法—具体方法  
public void PrimitiveOperation1()   
{  
    //实现代码  
}  

//基本方法—抽象方法  
    public abstract void PrimitiveOperation2();      

//基本方法—钩子方法  
public virtual void PrimitiveOperation3()     
{  }  
}

在抽象类中，模板方法TemplateMethod()定义了算法的框架，在模板方法中调用基本方法以实现完整的算法，每一个基本方法如PrimitiveOperation1()、PrimitiveOperation2()等均实现了算法的一部分，对于所有子类都相同的基本方法可在父类提供具体实现，例如PrimitiveOperation1()，否则在父类声明为抽象方法或钩子方法，由不同的子类提供不同的实现，例如PrimitiveOperation2()和PrimitiveOperation3()。

具体子类的典型代码如下：

class ConcreteClass : AbstractClass   
{  
public override void PrimitiveOperation2()   
{  
    //实现代码  
}  

public override void PrimitiveOperation3()   
{  
    //实现代码  
}  
}

在模板方法模式中，由于面向对象的多态性，子类对象在运行时将覆盖父类对象，子类中定义的方法也将覆盖父类中定义的方法，因此程序在运行时，具体子类的基本方法将覆盖父类中定义的基本方法，子类的钩子方法也将覆盖父类的钩子方法，从而可以通过在子类中实现的钩子方法对父类方法的执行进行约束，实现子类对父类行为的反向控制。

3 模板方法模式应用实例

下面通过一个应用实例来进一步学习和理解模板方法模式。

实例说明

某软件公司欲为某银行的业务支撑系统开发一个利息计算模块，利息计算流程如下：

(1) 系统根据账号和密码验证用户信息，如果用户信息错误，系统显示出错提示；

(2) 如果用户信息正确，则根据用户类型的不同使用不同的利息计算公式计算利息（如活期账户和定期账户具有不同的利息计算公式）；

(3) 系统显示利息。

试使用模板方法模式设计该利息计算模块。

实例类图

通过分析，本实例结构图如图3所示。

图3 银行利息计算模块结构图

在图3中，Account充当抽象类角色，CurrentAccount和SavingAccount充当具体子类角色。

实例代码

(1) Account：账户类，充当抽象类。

abstract class Account  
    {  
        //基本方法——具体方法  
        public bool Validate(string account, string password)   
        {  
            Console.WriteLine("账号：{0}", account);  
            Console.WriteLine("密码：{0}", password);  
            //模拟登录  
            if (account.Equals("张无忌") && password.Equals("123456"))   
            {  
                return true;  
            }  
            else   
            {  
                return false;  
            }  
        }  

        //基本方法——抽象方法  
        public abstract void CalculateInterest();  

        //基本方法——具体方法  
        public void Display()   
        {  
            Console.WriteLine("显示利息！");  
        }  

        //模板方法  
        public void Handle(string account, string password)   
        {  
            if (!Validate(account,password))   
            {  
                Console.WriteLine("账户或密码错误！");  
                return;  
            }  
            CalculateInterest();  
            Display();  
        }  
    }  
}

(2) CurrentAccount：活期账户类，充当具体子类。

class CurrentAccount : Account  
    {  
        //覆盖父类的抽象基本方法  
        public override void CalculateInterest()   
        {  
            Console.WriteLine("按活期利率计算利息！");  
        }  
    }

(3) SavingAccount：定期账户类，充当具体子类。

 class SavingAccount : Account  
    {  
        //覆盖父类的抽象基本方法  
        public override void CalculateInterest()   
        {  
            Console.WriteLine("按定期利率计算利息！");  
        }  
    }

(4) 配置文件App.config，在配置文件中存储了具体子类的类名。

<?xml version="1.0" encoding="utf-8" ?>  
<configuration>  
  <appSettings>  
    <add key="subClass" value="CurrentAccount"/>  
  </appSettings>  
</configuration>

(5) Program：客户端测试类

class Program  
    {  
        static void Main(string[] args)  
        {  
            Account account;  
            //读取配置文件  
            string subClassStr = ConfigurationManager.AppSettings["subClass"];  
            //反射生成对象  
            account = (Account)Assembly.Load("TemplateMethodSample").CreateInstance(subClassStr);  
            account.Handle("张无忌", "123456");  
            Console.Read();  
        }  
    }

结果及分析

编译并运行程序，输出结果如下：

账号：张无忌
密码：123456
按活期利率计算利息！
显示利息！

4 钩子方法的使用

模板方法模式中，在父类中提供了一个定义算法框架的模板方法，还提供了一系列抽象方法、具体方法和钩子方法，其中钩子方法的引入使得子类可以控制父类的行为。最简单的钩子方法就是空方法，代码如下：

public virtual void Display() {   }

当然也可以在钩子方法中定义一个默认的实现，如果子类不覆盖钩子方法，则执行父类的默认实现代码。

另一种钩子方法可以实现对其他方法进行约束，这种钩子方法通常返回一个bool类型，即返回true或false，用来判断是否执行某一个基本方法，下面通过一个实例来说明这种钩子方法的使用。

某软件公司欲为销售管理系统提供一个数据图表显示功能，该功能的实现包括如下几个步骤：

(1) 从数据源获取数据；

(2) 将数据转换为XML格式；

(3) 以某种图表方式显示XML格式的数据。

该功能支持多种数据源和多种图表显示方式，但所有的图表显示操作都基于XML格式的数据，因此可能需要对数据进行转换，如果从数据源获取的数据已经是XML数据则无须转换。

由于该数据图表显示功能的三个步骤次序是固定的，且存在公共代码（例如数据格式转换代码），满足模板方法模式的适用条件，可以使用模板方法模式对其进行设计。因为数据格式的不同，XML数据可以直接显示，而其他格式的数据需要进行转换，因此第(2)步“将数据转换为XML格式”的执行存在不确定性，为了解决这个问题，可以定义一个钩子方法IsNotXMLData()来对数据转换方法进行控制。通过分析，该图表显示功能的基本结构如图4所示：

图4 数据图表显示功能结构图

可以将公共方法和框架代码放在抽象父类中，代码如下：

abstract class DataViewer  
    {  
        //抽象方法：获取数据  
        public abstract void GetData();  

        //具体方法：转换数据  
        public void ConvertData()   
        {  
            Console.WriteLine("将数据转换为XML格式。");  
        }  

        //抽象方法：显示数据  
        public abstract void DisplayData();  

        //钩子方法：判断是否为XML格式的数据  
        public virtual bool IsNotXMLData()  
        {  
            return true;  
        }  

        //模板方法  
        public void Process()  
        {  
            GetData();  
            //如果不是XML格式的数据则进行数据转换  
            if (IsNotXMLData())  
            {  
                ConvertData();  
            }  
            DisplayData();  
        }  
    }

在上面的代码中，引入了一个钩子方法IsNotXMLData()，其返回类型为bool类型，在模板方法中通过它来对数据转换方法ConvertData()进行约束，该钩子方法的默认返回值为true，在子类中可以根据实际情况覆盖该方法，

其中用于显示XML格式数据的具体子类XMLDataViewer代码如下：

 class XMLDataViewer : DataViewer  
    {  
        //实现父类方法：获取数据  
        public override void GetData()   
        {  
            Console.WriteLine("从XML文件中获取数据。");  
        }  

        //实现父类方法：显示数据，默认以柱状图方式显示，可结合桥接模式来改进  
        public override void DisplayData()   
        {  
            Console.WriteLine("以柱状图显示数据。");  
        }  

        //覆盖父类的钩子方法  
        public override bool IsNotXMLData()  
        {  
            return false;  
        }  
    }

客户端代码如下：

 class Program  
    {  
        static void Main(string[] args)  
        {  
            DataViewer dv;  
            dv = new XMLDataViewer();  
            dv.Process();  
        }  
    }

该程序运行结果如下：

从XML文件中获取数据。
以柱状图显示数据。

posted @ 2019-01-26 16:46 Archer-Fang 阅读(288) 评论(0) 收藏举报

刷新页面返回顶部

模板方法模式

公告