看破设计模式之模板方法模式（Template Method）

一、模板方法模式概述

模式定义： 在一个方法中定义一个算法的步骤，并将一些步骤的实现延迟到子类中。模板方法使得子类在不改变算法结构的情况下，重新定义算f法中的某些步骤。
使用场景： 算法的步骤相同，但步骤具体实现有差异
模式结构：
1.抽象父类
定义了一个抽象父类，父类里有一个模板方法，还有一些抽象的步骤方法（原语操作）
2.实现的子类
实现了父类里所有的抽象步骤方法

UML图:

image.png

二、标准模板方法代码实现

• 抽象模板父类 Game.java

package com.saictest.demo.template;

public abstract class Game {
    final void play() {
        initGame();
        startGame();
        endGame();
    }

    //初始化游戏
    abstract void initGame();

    //开始游戏
    abstract void startGame();

    //结束游戏
    abstract void endGame();
}

• 具体实现子类 LOLGame.java

package com.saictest.demo.template;

public class LOLGame extends Game {
    @Override
    void initGame() {
        System.out.println("初始化LOL");
    }

    @Override
    void startGame() {
        System.out.println("开始玩LOL");
    }

    @Override
    void endGame() {
        System.out.println("LOL 结束");
    }
}

• 具体实现子类 DotaGame.java

package com.saictest.demo.template;

public class DotaGame extends Game {
    @Override
    void initGame() {
        System.out.println("初始化Dota");
    }

    @Override
    void startGame() {
        System.out.println("开始玩Dota");
    }

    @Override
    void endGame() {
        System.out.println("Dota 结束");
    }
}

• 调用

package com.saictest.demo.template;

public class MyMain {
    
    public static void main(String[] args) {
        Game game = new LOLGame();
        game.play();
        System.out.println();
        game = new DotaGame();
        game.play();
    }
}

• 结果

初始化LOL
开始玩LOL
LOL 结束

初始化Dota
开始玩Dota
Dota 结束

三、模式理解重点

这个模式的重点在于父类提供了一个算法，并让子类去实现算法中的某些步骤

四、模板方法用例

1.dubbo负载均衡算法

Dubbo提供了四种负载均衡：RandomLoadBalance，RoundRobinLoadBalance，LeastActiveLoadBalance，ConsistentHashLoadBalance。

image.png

LoadBalance

接口类LoadBalance只提供了一个方法

<T> Invoker<T> select(List<Invoker<T>> invokers, URL url, Invocation invocation) throws RpcException;

AbstractLoadBalance

抽象父类AbstractLoadBalance使用模板方法，具体负载均衡算法由子类的doSelect实现

public abstract class AbstractLoadBalance implements LoadBalance {

    public <T> Invoker<T> select(List<Invoker<T>> invokers, URL url, Invocation invocation) {
        if (invokers == null || invokers.size() == 0)
            return null;
        if (invokers.size() == 1)
            return invokers.get(0);
        return doSelect(invokers, url, invocation);
    }

    protected abstract <T> Invoker<T> doSelect(List<Invoker<T>> invokers, URL url, Invocation invocation);

    protected int getWeight(Invoker<?> invoker, Invocation invocation) {
        int weight = invoker.getUrl().getMethodParameter(invocation.getMethodName(), Constants.WEIGHT_KEY, Constants.DEFAULT_WEIGHT);
        if (weight > 0) {
                         ......................
        }
        return weight;
    }
    
    static int calculateWarmupWeight(int uptime, int warmup, int weight) {
                         ......................
    }

}

LeastActiveLoadBalance

子类具体的负载均衡算法

public class LeastActiveLoadBalance extends AbstractLoadBalance {

    public static final String NAME = "leastactive";
    
    private final Random random = new Random();

    protected <T> Invoker<T> doSelect(List<Invoker<T>> invokers, URL url, Invocation invocation) {
        int length = invokers.size(); // 总个数
        int leastActive = -1; // 最小的活跃数
        int leastCount = 0; // 相同最小活跃数的个数
        int[] leastIndexs = new int[length]; // 相同最小活跃数的下标
        int totalWeight = 0; // 总权重
        int firstWeight = 0; // 第一个权重，用于于计算是否相同
        boolean sameWeight = true; // 是否所有权重相同
        for (int i = 0; i < length; i++) {
            Invoker<T> invoker = invokers.get(i);
            int active = RpcStatus.getStatus(invoker.getUrl(), invocation.getMethodName()).getActive(); // 活跃数
            int weight = invoker.getUrl().getMethodParameter(invocation.getMethodName(), Constants.WEIGHT_KEY, Constants.DEFAULT_WEIGHT); // 权重
            if (leastActive == -1 || active < leastActive) { // 发现更小的活跃数，重新开始
                leastActive = active; // 记录最小活跃数
                leastCount = 1; // 重新统计相同最小活跃数的个数
                leastIndexs[0] = i; // 重新记录最小活跃数下标
                totalWeight = weight; // 重新累计总权重
                firstWeight = weight; // 记录第一个权重
                sameWeight = true; // 还原权重相同标识
            } else if (active == leastActive) { // 累计相同最小的活跃数
                leastIndexs[leastCount ++] = i; // 累计相同最小活跃数下标
                totalWeight += weight; // 累计总权重
                // 判断所有权重是否一样
                if (sameWeight && i > 0 
                        && weight != firstWeight) {
                    sameWeight = false;
                }
            }
        }
        // assert(leastCount > 0)
        if (leastCount == 1) {
            // 如果只有一个最小则直接返回
            return invokers.get(leastIndexs[0]);
        }
        if (! sameWeight && totalWeight > 0) {
            // 如果权重不相同且权重大于0则按总权重数随机
            int offsetWeight = random.nextInt(totalWeight);
            // 并确定随机值落在哪个片断上
            for (int i = 0; i < leastCount; i++) {
                int leastIndex = leastIndexs[i];
                offsetWeight -= getWeight(invokers.get(leastIndex), invocation);
                if (offsetWeight <= 0)
                    return invokers.get(leastIndex);
            }
        }
        // 如果权重相同或权重为0则均等随机
        return invokers.get(leastIndexs[random.nextInt(leastCount)]);
    }
}

六、心得参考

http://www.runoob.com/design-pattern/template-pattern.html
HeadFirst设计模式