工作 996？Template Method Pattern：我太难了

目的

做一件事情遵循着一定的步骤, 但每一步的具体细节可能不同, 就像把东西放入冰箱需要三步, 冰箱门打开, 把东西放进去, 冰箱门关上, 区别只是把苹果放进去的时候一个手拿放进去, 把西瓜放进去需要二个手抬进去, 把大象放进去需要 … …(我也不知道需要啥啦). ,这时候可以把步骤这种不变的部分和每一步的具体细节这种经常变化的部分剥离开, 从而实现代码的可拓展性

例子代码

作为程序猿/媛, 我们都是 “工作 996, 生病 ICU”(https://996.icu/#/zh_CN), 还要一些同学都 “007” 啦, 听说加班加的老婆都跑啦, 囧, 鲁迅也说过(好像不是周树人, 是鲁云还是马讯来着): “年轻的时候不修福报, 什么时候修福报呢”, 但是玩笑归玩笑, 好好工作固然很重要(不好好工作, 老板怎么换车呢, 这句话我还真在工作中听过,), 但是身体也是很重要的, 身体是最大的本钱, 有了身体不适的时候一定要去医院.

我们去看病的时候流程基本是固定的, 但是看每种不同的病的细节可能是不同, 比如码农几大职业病( 没有科学数据, 乱说的, 但是小伙伴们也要注意预防呀): 脱发, 青光眼, 颈椎病. 每种的治疗方法和所开的药等并不相同, 但是整体去看病的流程是相似的, 粗略分为挂号, 门诊, 拍片子, 买药这几个步骤, 这个时候刚学习了策略模式(请看第三篇文档)的同学就可以使用三种策略模式来完成这种模拟. 大概代码如下:

我们先定义一下策略模式的入参和出参:

入参:

/**
 * 看病策略的入参
 */
@Data
public class SeeTheDoctorStrategyRequest extends AbstractStrategyRequest {
    /**
     * 年龄
     */
    private Integer age;
}

出参:

/**
 * 返回药品类型
 */
@Getter
@AllArgsConstructor
public class SeeTheDoctorStrategyResponse extends AbstractStrategyResponse {
    /**
     * 药品类型
     */
    private MedicineType medicineType;
}

定义三个策略:

/**
 * 去皮肤科看脱发
 */
public class SeeDermatologistStrategy implements 
            Strategy<SeeTheDoctorStrategyRequest, SeeTheDoctorStrategyResponse> {

    @Override
    public SeeTheDoctorStrategyResponse executeStrategy(
                        SeeTheDoctorStrategyRequest request) {
        System.out.println("挂皮肤科的号");
        System.out.println("拿了号在叫号大厅等待");
        System.out.println("皮肤科医生门诊");
        if(request.getAge() < Constant.BEST_AGE) {
            System.out.println("还年轻, 不用来复查了");
        } else {
            System.out.println("吃完药还得来复查");
        }
        System.out.println("初步诊断是肾虚, 买一些蚂蚁大力丸");
        return new SeeTheDoctorStrategyResponse(MedicineType.ANT_POWERFUL_PILL);
    }
}

/**
 * 看眼科医生策略
 */
public class SeeOphthalmologistStrategy implements 
        Strategy<SeeTheDoctorStrategyRequest, SeeTheDoctorStrategyResponse> {

    @Override
    public SeeTheDoctorStrategyResponse executeStrategy(
                    SeeTheDoctorStrategyRequest request) {
        System.out.println("挂眼科的号");
        System.out.println("拿了号在叫号大厅等待");
        System.out.println("去眼科医生门诊");
        if(request.getAge() < Constant.BEST_AGE) {
            System.out.println("还年轻, 不用来复查了");
        } else {
            System.out.println("吃完药还得来复查");
        }
        System.out.println("买一些消炎药");
        return new SeeTheDoctorStrategyResponse(MedicineType.ANTICATARRHALS);
    }
}

/**
 * 颈椎病看骨科医生
 */
public class SeeOrthopedicSurgeonStrategy implements 
        Strategy<SeeTheDoctorStrategyRequest, SeeTheDoctorStrategyResponse>  {

    @Override
    public SeeTheDoctorStrategyResponse executeStrategy(
                    SeeTheDoctorStrategyRequest request) {
        System.out.println("挂骨科的号");
        System.out.println("拿了号在叫号大厅等待");
        System.out.println("去骨科医生门诊");
        if(request.getAge() < Constant.BEST_AGE) {
            System.out.println("还年轻, 不用来复查了");
        } else {
            System.out.println("吃完药还得来复查");
        }
        System.out.println("买一些活血化瘀药");
        return new SeeTheDoctorStrategyResponse(MedicineType.BLOOD_CIRCULATION_DRUGS);
    }
}

问题分析

以上的代码已经比 if-else 清晰了多啦, 按照策略模式的讲解也可以写个 context 类来负责路由到相关的类, 可是这里仍然可以发现三个问题:

第一个问题就是每个策略里面有重复的代码, if-esle 每段都一样, 这些代码最好单独提取到父类中

第二个问题是这些个类的步骤相似的, 却将步骤分的不是很细, 本来是相同的挂号, 等待叫号, 检查, 买药这些步骤, 阅读者却要每个类里面的代码都要读一遍才知道这些类全部是这个步骤, 如果这每个方法都成千上万行, 那就很痛苦啦

第三个问题是这个类的职责不是很单一, 既负责了不同的看病细节的实现, 比如买什么药, 又负责了组织整个看病流程, 如果这二个维度有一个维度需要修改了, 那么就得修改这个类

模板方法模式

我们定义了一个模板方法, 负责抽象看病过程中的各个细节

/**
 * 定义模板方法
 */
public abstract class AbstractSeeDoctorTemplateStrategy 
                          implements TemplateStrategy {

    /**
     * 获取疾病类型
     * @return
     */
    protected abstract DiseaseTypeEnum getDiseaseType();

    /**
     * 挂号
     */
    protected abstract void register();

    /**
     * 等待叫号
     */
    protected void waitDoctor() {
        System.out.println("拿了号在叫号大厅等待");
    }

    /**
     * 诊断
     */
    protected abstract void diagnosis();

    /**
     * 关于年龄的判断
     */
    protected void evaluateAge(Integer age) {
        if(age < Constant.BEST_AGE) {
            System.out.println("还年轻, 不用来复查了");
        } else {
            System.out.println("吃完药还得来复查");
        }
    }

    /**
     * 买药
     * @return
     */
    protected abstract MedicineType buyMedicine();
}

这个类有三种实现方式:

/**
 * 去皮肤科看脱发
 */
public class SeeDermatologistTemplateStrategy 
        extends AbstractSeeDoctorTemplateStrategy {
    @Override
    protected DiseaseTypeEnum getDiseaseType() {
        return DiseaseTypeEnum.HAIR_LOSS;
    }

    @Override
    protected void register() {
        System.out.println("挂皮肤科的号");
    }

    @Override
    protected void diagnosis() {
        System.out.println("皮肤科医生门诊");
    }

    @Override
    protected MedicineType buyMedicine() {
        System.out.println("初步诊断是肾虚, 买一些蚂蚁大力丸");
        return MedicineType.ANT_POWERFUL_PILL;
    }
}

/**
 * 看眼科医生策略
 */
public class SeeOphthalmologistTemplateStrategy 
                extends AbstractSeeDoctorTemplateStrategy {
    @Override
    protected DiseaseTypeEnum getDiseaseType() {
        return DiseaseTypeEnum.GLAUCOMA;
    }

    @Override
    protected void register() {
        System.out.println("挂眼科的号");
    }

    @Override
    protected void diagnosis() {
        System.out.println("去眼科医生门诊");
    }

    @Override
    protected MedicineType buyMedicine() {
        return MedicineType.ANTICATARRHALS;
    }
}

/**
 * 颈椎病看骨科医生
 */
public class SeeOrthopedicSurgeonTemplateStrategy 
            extends AbstractSeeDoctorTemplateStrategy {
    @Override
    protected DiseaseTypeEnum getDiseaseType() {
        return DiseaseTypeEnum.CERVICAL_PONDYLOPATHY;
    }

    @Override
    protected void register() {
        System.out.println("挂骨科的号");
    }

    @Override
    protected void diagnosis() {
        System.out.println("去骨科医生门诊");
    }

    @Override
    protected MedicineType buyMedicine() {
        return MedicineType.BLOOD_CIRCULATION_DRUGS;
    }
}

我们还需要定义一个不需要关系细节只管整个看病流程的模板类:

/**
 * 看医生的模板
 */
public class SeeDoctorTemplate {

    private SeeDoctorTemplate() {
    }

    public static MedicineType seeDoctor(AbstractSeeDoctorTemplateStrategy seeDoctorTemplateStrategy, Integer age) {
        seeDoctorTemplateStrategy.register();
        seeDoctorTemplateStrategy.waitDoctor();
        seeDoctorTemplateStrategy.diagnosis();
        seeDoctorTemplateStrategy.evaluateAge(age);
        return seeDoctorTemplateStrategy.buyMedicine();
    }
}

最后当想去看骨科的时候:

public static void main(String[] args) {
        SeeDoctorTemplate.seeDoctor(
        new SeeOrthopedicSurgeonTemplateStrategy(),
        24);
}

运行结果如下:

挂骨科的号
拿了号在叫号大厅等待
去骨科医生门诊
吃完药还得来复查

类图如下:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-K2wkTbKy-1602386098012)(/assets/SeeDermatologistTemplateStrategy.png)]

生产的例子

如果我们加入了福报厂, 每逢双十一等大促需要保证体统的主要功能正常运行, 一些平时用来优化用户体验的功能可能在流量过大的时候被人降级掉, 或者不重要的这部分代码报错的时候不影响主要流程, 只要输出日志来提供报警和监控就可以. 所以会产生大量类似这样的代码.

if (AI 开关没打开) {
    返回用户评分是 0 
}
try {
    执行真正的业务逻辑给用户打分并返回
} catch (Exception e) {
    打印 AI 错误日志
    返回用户评分是 0 
}

或者这样的业务:

if (营销开关没打开) {
    返回用户优惠卷列表是空
}
try {
    执行真正的业务逻辑查询用户优惠卷并返回
} catch (Exception e) {
    打印查询优惠卷日志
    返回用户优惠卷列表为空
}

上面的代码大量重复, 并且对于阅读者来说看了半天异常处理逻辑, 不知道真正的业务逻辑, 这时候我们就可以定义一个模板方法:

/**
 * 弱依赖方法
 *
 * @param <T>
 * @param <R>
 */
public interface WeakFunction<T, R> {

    /**
     * 是否是业务开关打开
     * @return
     */
    default boolean isBusinessOpen() {
        return false;
    }

    /**
     * 执行弱依赖方法, 真正的业务逻辑
     *
     * @param request
     * @return
     */
    R execute(T request);
}

然后使用模板去处理:

public class WeakTemplate {

    private WeakTemplate() {
    }

    /**
     * 执行弱依赖模板
     *
     * @param weakFunction 真正的业务逻辑
     * @param request      请求入参
     * @param defaultValue 开关关了或者执行失败时候的值
     * @param tip          //报错的提示信息
     * @param <T>
     * @param <R>
     * @return
     */
    public static <T, R> R doWeakFunction(
                WeakFunction<T, R> weakFunction, 
                T request, R defaultValue, String tip) {
        //使用卫语句
        if (!weakFunction.isBusinessOpen()) {
            return defaultValue;
        }
        try {
            return weakFunction.execute(request);
        } catch (Exception e) {
            System.out.println(tip + e.getMessage());
            return defaultValue;
        }
    }
}

微信: