一招搞定重复代码：模板方法模式实战

在日常撸代码的时候你肯定遇到过这种恶心的场景有几个业务流程它们整体的“套路”几乎是一模一样的只有中间那么一两个小步骤不一样。比如你要写一个解析文件的功能要支持解析 XML、JSON 和 CSV。这三者的流程都是下载文件 - 打开文件 - 【解析内容】 - 关闭文件 - 保存到数据库。除了【解析内容】这一步不一样其他的步骤简直是一个模子刻出来的。这时候很多新手的做法就是写三个类把相同的代码复制粘贴三遍。结果有一天产品经理说“下载文件之前先加个权限校验吧”得你只能苦逼地去那三个类里把权限校验的代码再补三遍。这要是漏改了一个直接就是一个线上 Bug。怎么解决这种“骨架相同细节不同”的痛点这时候就该请出设计模式里的老大哥——**模板方法模式Template Method Pattern**了。一、 什么是模板方法打个最简单的比方别去背网上那些晦涩难懂的定义。模板方法其实就是一套“固定流程的填空题”。想象一下你去星巴克看咖啡师做饮料。不管是做星巴克拿铁还是做冰摇红茶整体的流程其实都是固定的 4 步把水烧开。冲泡泡咖啡 or 泡茶。把饮料倒进杯子里。加小料加牛奶 or 加柠檬。在这 4 步里第 1 步和第 3 步是绝对固定的谁来做都一样。但第 2 步和第 4 步具体怎么做得看顾客点的是什么。在写代码时我们就可以把这个“固定的 4 步流程”写在一个父类里这就是模板然后把那些不确定的步骤冲泡、加小料留空让子类去具体实现。二、 用代码说话一看就懂废话不多说咱们直接上 Java 代码。第一步定义一个父类制作饮料的模板public abstract class BeverageTemplate { // 这就是我们的“模板方法”定义了核心的骨架流程 // 注意一定要加上 final 关键字防止子类瞎捣乱重写了这个大流程 public final void makeBeverage() { boilWater(); // 1. 烧开水固定 brew(); // 2. 冲泡不固定留给子类实现 pourInCup(); // 3. 倒入杯中固定 // 这是一个钩子方法Hook下面会详细讲 if (customerWantsCondiments()) { addCondiments(); // 4. 加小料不固定留给子类实现 } } // 固定步骤烧开水。直接在父类实现子类直接用 private void boilWater() { System.out.println(1. 烧开水...); } // 固定步骤倒进杯子。 private void pourInCup() { System.out.println(3. 把饮料倒进杯子里...); } // 抽象步骤冲泡。父类不管强制要求具体的子类去实现 protected abstract void brew(); // 抽象步骤加小料。强制要求子类实现 protected abstract void addCondiments(); // 钩子方法Hook给子类一个反悔的机会。默认是加小料的。 protected boolean customerWantsCondiments() { return true; } } ​第二步写具体的子类做咖啡和做茶先来个做咖啡的public class Coffee extends BeverageTemplate { Override protected void brew() { System.out.println(2. 用沸水冲泡咖啡粉); } Override protected void addCondiments() { System.out.println(4. 加糖和牛奶); } } ​再来个做茶的顺便用一下钩子方法假设这杯茶不加柠檬​public class Tea extends BeverageTemplate { Override protected void brew() { System.out.println(2. 用80度的水浸泡茶叶); } Override protected void addCondiments() { System.out.println(4. 加柠檬); } // 重写钩子方法返回 false表示这杯茶什么都不加 Override protected boolean customerWantsCondiments() { return false; } } ​第三步客户端调用public class Main { public static void main(String[] args) { System.out.println(--- 开始泡咖啡 ---); BeverageTemplate coffee new Coffee(); coffee.makeBeverage(); // 直接调模板方法 System.out.println(\n--- 开始泡纯茶 ---); BeverageTemplate tea new Tea(); tea.makeBeverage(); } } ​执行结果你会发现所有的流程都在你的掌控之中。如果是咖啡就走了 4 步如果是茶因为重写了钩子方法返回 false直接跳过了第 4 步。代码极其优雅。三、 拔高一点什么是“钩子Hook”在上面的代码里你看到了一个词叫“钩子Hook”。这是面试官非常喜欢问的一个细节。模板方法规定了死的骨架但有时候子类想要有一点**“微调的权力”**。比如整体流程是要加小料的但我今天偏偏想要一杯什么都不加的纯茶。这时候父类提供了一个返回 boolean 值的方法比如 customerWantsCondiments这就叫钩子。父类利用这个钩子来决定某些步骤要不要执行。子类如果不吭声不重写就按默认的来子类如果重写了就能通过钩子反向控制父类的流程。这其实完美体现了一个著名的好莱坞原则“Dont call us, well call you.”别打给我们我们会打给你。子类不需要主动去调用父类的方法而是父类把台子搭好到了需要子类表演的时候父类会自动调用子类实现的方法。四、 绝不仅仅是纸上谈兵框架里到处都是如果你觉得这就只是个泡咖啡的玩具代码那你就大错特错了。在我们天天用的神级框架里模板方法模式简直被用得烂大街了。Spring 框架里的各种 Template只要你在 Spring 里看到以 Template 结尾的类比如 JdbcTemplate、RedisTemplate、RestTemplate底层多多少少都用到了模板方法的思想。拿 JdbcTemplate 来说获取连接、创建 Statement、执行 SQL、处理异常、释放连接这套流程是死骨架模板而具体执行什么 SQL、怎么把结果映射成实体类则是留给你去实现的回调细节。Java Web 老古董HttpServlet还记得大学时写的 Servlet 吗你要写一个类继承 HttpServlet然后重写 doGet() 或者 doPost() 方法。其实 HttpServlet 内部有一个核心的 service() 方法它就是一个模板方法。它会根据 HTTP 请求的类型GET 还是 POST去路由调用对应的 doGet 或 doPost。你只需要在对应的方法里填空就行了根本不用管底层的 HTTP 协议是怎么解析的。并发编程的核心AQSAbstractQueuedSynchronizerJava 并发包JUC里的 ReentrantLock、CountDownLatch 等底层全靠 AQS 撑着。AQS 内部就把排队、阻塞、唤醒线程的骨架流程全部写好了。子类比如锁只需要重写 tryAcquire()尝试加锁和 tryRelease()尝试解锁这几个方法即可。这就是最顶级的模板方法应用。五、 总结一下什么时候该用模板方法只要你发现有多个类它们的整体操作步骤是一样的只有中间个别步骤的实现细节不同别犹豫直接抽出一个父类把骨架用 final 方法写死把差异留成 abstract 方法让子类去填空。好处代码复用率极高。以后要修改核心流程比如前面说的加个权限校验只需要改父类的一个地方所有子类自动生效再也不用满屏去找 CtrlC/V 的痕迹了。缺点由于 Java 是单继承的子类一旦继承了这个模板父类就不能再继承别的类了。而且如果业务变化太多可能会导致子类数量爆炸。总之模板方法模式是日常开发中最接地气、最容易落地的设计模式之一。掌握了它你的代码整洁度绝对能提升一个档次