【设计模式】模板方法模式

一、概念介绍

模板方法模式是一种行为型设计模式，旨在通过设计一个抽象类，达到规范其实现类执行流程的目的。这里的流程不仅包括业务流程，还包括日志打印、异常捕获等系统流程。

好处：

1. 减少通用逻辑的重复书写，修改通用逻辑时只需修改模板类
2. 避免重要逻辑被遗漏
3. 统一日志打印格式，方便监控和定位问题
4. 具有可扩展性，实现类可以自定义具体的业务逻辑

二、代码示例

首先，我们需要定义一个抽象类，也就是模板类。

@Slf4j
public abstract class ServiceTemplate<T, R> {

	// 提供一个可以被外部调用的方法，约定了模板方法的通用执行流程
	public R process(T request) {
		log.info("start invoke, request={}", request);
		try {
			validParam(request);
			R response = doBiz(request);
			log.info("end invoke, request={}", request); 
			return response;
		} catch (Exception e) {
			log.error("invoke failed, errMsg={}", e.getMessage());
			return null;
		}
	}
	
	// 参数校验，交给子类实现（protected修饰，避免外部直接调用，子类可重写）
	protected abstract void validParam(T request);
	
	// 业务逻辑，交给子类实现（protected修饰，避免外部直接调用，子类可重写）
	protected abstract R doBiz(T request);
}

上面的模板类约定了方法执行时，必须有入参和出参日志打印，且必须捕获业务异常。

实现类可以自行决定参数校验逻辑和业务执行逻辑，只需实现上面的validParam()和doBiz()即可。

三、参考资料

【成为架构师】8. 成为工程师 - 搭建系统先搭建框架