模板方法模式是类的行为模式。准备一个抽象类,将部分逻辑以具体方法以及具体构造函数的形式体现,然后声明一些抽象方法来迫使子类实现剩余的逻辑,不同的子类可以有不同的方式实现这些抽象方法,从而对剩余的逻辑有不同的实现。这就是模板方法模式的用意。
模板方法模式基于继承
的代码复用。
模板方法模式需要开发抽象类和具体子类设计师之间的协作。一个设计师负责给出一个算法的轮廓和骨架;另一个设计师负责给出这个算法的各个逻辑步骤。代表这些具体逻辑步骤的方法称为基本方法(primitive method)
,而将这些基本方法汇总起来的方法叫做模板方法(template method)
,这个设计模式的名字就是从此而来的。
1. 模板方法的结构
模板方法所代表的行为称为顶级行为,其逻辑称为顶级逻辑。这里设计到两个角色:
-
抽象模板(Abstract Template)角色
定义一个或多个抽象行为,以便让子类实现,这些抽象操作叫做基本操作,它们是一个顶级逻辑的组成步骤。
定义并实现了一个模板方法。这个模板方法一般是一个具体方法,他给出了一个顶级逻辑的骨架,而逻辑的组成步骤在相应的抽象操作中,推迟到子类实现,顶级逻辑也有可能调用一些具体方法。
-
具体模板(Concrete Template)角色
实现父类所定义的一个或多个抽象方法,它们是一个顶级逻辑的组成步骤。
每一个抽象模板角色都可以有任意多个具体模板角色与之对应,而每一个具体模板角色都可以给出这些抽象方法(也就是顶级逻辑的组成步骤)的不同实现,从而使得顶级逻辑的实现各不相同。
2. 模板方法的代码实现
模板方法类,abstractMethod()
、hookMethod()
等基本方法是顶级逻辑(templateMethod()
)的组成步骤。
//抽象模板角色
public abstract class AbstractTemplate {
//模板方法的顶级逻辑
public void templateMethod() {
abstractMethod();
hookMethod();
concreteMethod();
}
//基本方法(强制由子类实现)
protected abstract void abstractMethod();
//基本方法(可选择由子类实现)
protected void hookMethod(){}
//公共方法(父类实现)
private final void concreteMethod(){
//业务相关代码
}
}
具体模板角色类,实现了父类所声明的基本方法,abstractMethod()
方法所代表的就是强制子类实现的剩余逻辑,而hookMethod()方法是可选择实现的逻辑,不是必须实现的。
//具体模板角色
public class ConcreteTemplate extends AbstractTemplate {
//强制重写父类的抽象方法
@Override
protected void abstractMethod() {
//业务相关代码
}
//选择重写父类的具体方法
@Override
protected void hookMethod() {
//业务相关代码
}
}
模板方法的关键是:子类可以置换父类的可变部分,但是子类却不可以改变模板方法所代表的顶级逻辑。
每当定义一个新的子类时,不要按照控制流程的思路去想,而应该按照“责任”的思路去想。换言之,应当考虑哪些操作是必须置换掉的,哪些操作是可以置换掉的,以及哪些操作是不可以置换掉的。使用模板方法可以使这些逻辑变得清晰。
3. 模板方法模式中的方法
模板方法模式可以分为两大类:模板方法和基本方法。
3.1 模板方法
一个模板方法是定义在抽象类中的,把基本操作方法组合在一起形成一个总算法或一个总行为的方法。
一个抽象类可以有任意多个模板方法,而不限于一个。每个模板方法都可以调用任意多个具体方法。
3.2 基本方法
基本方法又可以分为三种:抽象方法(Abstract Method)、具体方法(Concrete Method)、钩子方法(Hook Method)。
抽象方法:一个抽象方法由抽象类声明,由具体子类实现。在Java语言中抽象方法使用abstract关键字。
具体方法:一个具体方法由抽象类声明实现,而子类并不实现或置换。
钩子方法:一个钩子方法由抽象类声明并实现,而子类会加以扩展,通常抽象类给出的实现是一个空实现,作为方法的默认实现。
3.3 默认钩子方法
一个钩子方法常常由抽象类给出一个空实现作为此方法的默认实现。这个空的钩子方法叫做“Do Nothing Hook”,显然,这种默认钩子方法在缺省适配模式里面已经见过了,一个缺省适配模式将的是一个类为一个接口提供一个默认的空实现,从而使得缺省适配类的子类不必像实现接口那个必须给出所有方法的实现,因为通常一个具体类并不需要所有的方法。
3.4 钩子方法的命名规则
钩子方法的名字应当以do开始,这是熟悉设计模式的java开发人员的标准做法。在上面的例子中,钩子方法hookMethod()应当以do开头,在httpServlet类中,也遵从这一命名规则,如doGet()、doPost()等方法。
4. 模板设计模式的优缺点
4.1 优点
- 提高代码的复用性。
将相同部分的代码放在抽象的父类中。 - 提高了扩展性。
将不同的代码放到了不同的子类中,通过子类扩展新的行为。 - 实现了开放封闭原则。
通过一个父类调用其子类的操作,通过对子类的扩展增加新的行为,实现了“开放-封闭”原则。
4.2 缺点
引入了抽象类,每个不同的实现都需要一个子类来实现,导致类的个数增加,增加了系统实现的复杂性。
5. 应用场景
- 一次性实现一个算法不变的部分,并将可变的行为留给子类来实现。
- 各子类中公共的行为应被提取出来并集中到一个公共父类中以避免代码的重复。
- 控制子类的扩展。
5.1 银行利息计算
考虑一个计算存款利息的例子。假设系统需要支持两种存款账号,即货币市场(Money Market)账号和定期存款(Certificate of Deposite)账号。这两种账号的存款利息是不同的,因此,在计算一个存户的存款利息额时,必须区分两种不同的账号类型。
这个系统的总行为应当是计算出利息,那么就决定了作为一个模板方法模式的顶级逻辑应当是利息计算。利息计算涉及到两个步骤:一是基本方法给出账户种类,另一个基本方法给出利息的百分比。这两个基本方法构成具体逻辑,因为账号的类型不同,所以具体逻辑会有所不同。
抽象模板角色
//抽象模板角色
public abstract class Account {
//模板方法
public final double calulateInterest() {
//计算利率
double interestRate = doCalulateInterestRate();
String accountType = doCalulateAccountType();
//计算账户余额
double amount = calulateAmount(accountType);
//返回利息
return amount * interestRate;
}
//查看卡片信息
protected abstract String doCalulateAccountType();
//计算利率
protected abstract double doCalulateInterestRate();
//基本方法,已经实现
private double calulateAmount(String accountType) {
//省略逻辑代码
return 100.00;
}
}
具体子类角色
public class MoneyMarketAccount extends Account{
@Override
protected String doCalulateAccountType() {
return "Money Market";
}
@Override
protected double doCalulateInterestRate() {
return 0.045;
}
}
客户端
public class AccountClient {
public static void main(String[] args) {
Account account=new MoneyMarketAccount();
double interest = account.calulateInterest();
System.out.println("现金账户的利息是"+interest+"元");
}
}
5.2 模板方法在Servlet中的应用
使用Servlet需要继承一个HttpServlet的抽象类,HttpServlet类提供了一个service()方法,这个方法调用七个doXXX()方法中的一个或多个,完成对客户端调用的响应。这些doXXX()方法需要由HttpServlet的具体子类提供,因此是典型的模板方法模式。
protected void service(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException
{
String method = req.getMethod();
if (method.equals(METHOD_GET)) {
long lastModified = getLastModified(req);
if (lastModified == -1) {
// servlet doesn't support if-modified-since, no reason
// to go through further expensive logic
doGet(req, resp);
} else {
long ifModifiedSince = req.getDateHeader(HEADER_IFMODSINCE);
if (ifModifiedSince < (lastModified / 1000 * 1000)) {
// If the servlet mod time is later, call doGet()
// Round down to the nearest second for a proper compare
// A ifModifiedSince of -1 will always be less
maybeSetLastModified(resp, lastModified);
doGet(req, resp);
} else {
resp.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
}
}
} else if (method.equals(METHOD_HEAD)) {
long lastModified = getLastModified(req);
maybeSetLastModified(resp, lastModified);
doHead(req, resp);
} else if (method.equals(METHOD_POST)) {
doPost(req, resp);
} else if (method.equals(METHOD_PUT)) {
doPut(req, resp);
} else if (method.equals(METHOD_DELETE)) {
doDelete(req, resp);
} else if (method.equals(METHOD_OPTIONS)) {
doOptions(req,resp);
} else if (method.equals(METHOD_TRACE)) {
doTrace(req,resp);
} else {
//
// Note that this means NO servlet supports whatever
// method was requested, anywhere on this server.
//
String errMsg = lStrings.getString("http.method_not_implemented");
Object[] errArgs = new Object[1];
errArgs[0] = method;
errMsg = MessageFormat.format(errMsg, errArgs);
resp.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED, errMsg);
}
}
我们可以通过重写父类的doGet和doPost方法,完成自己的逻辑。
public class TestServlet extends HttpServlet {
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
System.out.println("using the GET method");
}
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
System.out.println("using the POST method");
}
}
即:HttpServlet担任抽象模板角色:
模板方法:由service()方法担任。
基本方法:由doPost()、doGet()等方法担任。
TestServlet担任具体模板角色:
TestServlet置换掉了父类HttpServlet中七个基本方法中的其中两个,分别是doGet()和doPost()。
参考实现
1.《JAVA与模式》之模板方法模式
2. 模板方法模式的优缺点