设计模式最佳套路4 —— 愉快地使用模板模式

2024-03-16 05:10
文章标签 模板 使用 设计模式 模式 最佳 套路 愉快

本文主要是介绍设计模式最佳套路4 —— 愉快地使用模板模式，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

本篇为设计模式第四篇，前三篇戳下方链接阅读：

  • 设计模式最佳套路1 —— 愉快地使用策略模式

  • 设计模式最佳套路2 —— 愉快地使用管道模式

  • 设计模式最佳套路3 —— 愉快地使用代理模式

什么是模板模式

模板模式（Template Pattern） 又叫模板方法模式，其定义了操作的流程，并将流程中的某些步骤延迟到子类中进行实现，使得子类在不改变操作流程的前提下，即可重新定义该操作的某些特定步骤。例如做菜，操作流程一般为 “准备菜”->“放油”->“炒菜”->“调味”->“装盘”，但可能对于不同的菜要放不同类型的油，不同的菜调味方式也可能不一样。

何时使用模板模式

当一个操作的流程较为复杂，可分为多个步骤，且对于不同的操作实现类，流程步骤相同，只有部分特定步骤才需要自定义，此时可以考虑使用模板模式。如果一个操作不复杂（即只有一个步骤），或者不存在相同的流程，那么应该使用策略模式。从这也可看出模板模式和策略模式的区别：策略模式关注的是多种策略（广度），而模板模式只关注同种策略（相同流程），但是具备多个步骤，且特定步骤可自定义（深度）。

愉快地使用模板模式


▐  背景

我们平台的动态表单在配置表单项的过程中，每新增一个表单项，都要根据表单项的组件类型（例如 单行文本框、下拉选择框）和当前输入的各种配置来转换好对应的 Schema 并保存在 DB 中。一开始，转换的代码逻辑大概是这样的：

public class FormItemConverter {/*** 将输入的配置转变为表单项** @param config 前端输入的配置* @return 表单项*/public FormItem convert(FormItemConfig config) {FormItem formItem = new FormItem();// 公共的表单项属性formItem.setTitle(config.getTitle());formItem.setCode(config.getCode());formItem.setComponent(config.getComponent());// 创建表单组件的属性FormComponentProps props = new FormComponentProps();formItem.setComponentProps(props);// 公共的组件属性if (config.isReadOnly()) {props.setReadOnly(true);}FormItemTypeEnum type = config.getType();// 下拉选择框的特殊属性处理if (type == ComponentTypeEnum.DROPDOWN_SELECT) {props.setAutoWidth(false);if (config.isMultiple()) {props.setMode("multiple");}}// 模糊搜索框的特殊属性处理if (type == ComponentTypeEnum.FUZZY_SEARCH) {formItem.setFuzzySearch(true);props.setAutoWidth(false);}// ...  其他组件的特殊处理// 创建约束规则List<FormItemRule> rules = new ArrayList<>(2);formItem.setRules(rules);// 每个表单项都可有的约束规则if (config.isRequired()) {FormItemRule requiredRule = new FormItemRule();requiredRule.setRequired(true);requiredRule.setMessage("请输入" + config.getTitle());rules.add(requiredRule);}// 文本输入框才有的规则if (type == ComponentTypeEnum.TEXT_INPUT || type == ComponentTypeEnum.TEXT_AREA) {Integer minLength = config.getMinLength();if (minLength != null && minLength > 0) {FormItemRule minRule = new FormItemRule();minRule.setMin(minLength);minRule.setMessage("请至少输入 " + minLength + " 个字");rules.add(minRule);}Integer maxLength = config.getMaxLength();if (maxLength != null && maxLength > 0) {FormItemRule maxRule = new FormItemRule();maxRule.setMax(maxLength);maxRule.setMessage("请最多输入 " + maxLength + " 个字");rules.add(maxRule);}}// ... 其他约束规则return formItem;}
}

很明显，这份代码违反了 开闭原则（对扩展开放，对修改关闭）：如果此时需要添加一种新的表单项（包含特殊的组件属性），那么不可避免的要修改 convert 方法来进行新表单项的特殊处理。观察上面的代码，将配置转变为表单项 这个操作，满足以下流程：

  1. 创建表单项，并设置通用的表单项属性，然后再对不同表单项的特殊属性进行处理

  2. 创建组件属性，处理通用的组件属性，然后再对不同组件的特殊属性进行处理

  3. 创建约束规则，处理通用的约束规则，然后再对不同表单项的特性约束规则进行处理

这不正是符合模板模式的使用场景（操作流程固定，特殊步骤可自定义处理）吗？基于上面这个场景，下面我就分享一下我目前基于 Spring 实现模板模式的 “最佳套路”（如果你有更好的套路，欢迎赐教和讨论哦）~

▐  方案

  • 定义出模板

即首先定义出表单项转换的操作流程，即如下的 convert 方法（使用 final 修饰，确保子类不可修改操作流程）：

public abstract class FormItemConverter {/*** 子类可处理的表单项类型*/public abstract FormItemTypeEnum getType();/*** 将输入的配置转变为表单项的操作流程** @param config 前端输入的配置* @return 表单项*/public final FormItem convert(FormItemConfig config) {FormItem item = createItem(config);// 表单项创建完成之后，子类如果需要特殊处理，可覆写该方法afterItemCreate(item, config);FormComponentProps props = createComponentProps(config);item.setComponentProps(props);// 组件属性创建完成之后，子类如果需要特殊处理，可覆写该方法afterPropsCreate(props, config);List<FormItemRule> rules = createRules(config);item.setRules(rules);// 约束规则创建完成之后，子类如果需要特殊处理，可覆写该方法afterRulesCreate(rules, config);return item;}/*** 共用逻辑：创建表单项、设置通用的表单项属性*/private FormItem createItem(FormItemConfig config) {FormItem formItem = new FormItem();formItem.setCode(config.getCode());formItem.setTitle(config.getTitle());formItem.setComponent(config.getComponent());return formItem;}/*** 表单项创建完成之后，子类如果需要特殊处理，可覆写该方法*/protected void afterItemCreate(FormItem item, FormItemConfig config) { }/*** 共用逻辑：创建组件属性、设置通用的组件属性*/private FormComponentProps createComponentProps(FormItemConfig config) {FormComponentProps props = new FormComponentProps();if (config.isReadOnly()) {props.setReadOnly(true);}if (StringUtils.isNotBlank(config.getPlaceholder())) {props.setPlaceholder(config.getPlaceholder());}return props;}/*** 组件属性创建完成之后，子类如果需要特殊处理，可覆写该方法*/protected void afterPropsCreate(FormComponentProps props, FormItemConfig config) { }/*** 共用逻辑：创建约束规则、设置通用的约束规则*/private List<FormItemRule> createRules(FormItemConfig config) {List<FormItemRule> rules = new ArrayList<>(4);if (config.isRequired()) {FormItemRule requiredRule = new FormItemRule();requiredRule.setRequired(true);requiredRule.setMessage("请输入" + config.getTitle());rules.add(requiredRule);}return rules;}/*** 约束规则创建完成之后，子类如果需要特殊处理，可覆写该方法*/protected void afterRulesCreate(List<FormItemRule> rules, FormItemConfig config) { }
}

  • 模板的实现

针对不同的表单项，对特殊步骤进行自定义处理：

/*** 下拉选择框的转换器*/
@Component
public class DropdownSelectConverter extends FormItemConverter {@Overridepublic FormItemTypeEnum getType() {return FormItemTypeEnum.DROPDOWN_SELECT;}@Overrideprotected void afterPropsCreate(FormComponentProps props, FormItemConfig config) {props.setAutoWidth(false);if (config.isMultiple()) {props.setMode("multiple");}}
}/*** 模糊搜索框的转换器*/
@Component
public class FuzzySearchConverter extends FormItemConverter {@Overridepublic FormItemTypeEnum getType() {return FormItemTypeEnum.FUZZY_SEARCH;}@Overrideprotected void afterItemCreate(FormItem item, FormItemConfig config) {item.setFuzzySearch(true);}@Overrideprotected void afterPropsCreate(FormComponentProps props, FormItemConfig config) {props.setAutoWidth(false);}
}/*** 通用文本类转换器*/
public abstract class CommonTextConverter extends FormItemConverter {@Overrideprotected void afterRulesCreate(List<FormItemRule> rules, FormItemConfig config) {Integer minLength = config.getMinLength();if (minLength != null && minLength > 0) {FormItemRule minRule = new FormItemRule();minRule.setMin(minLength);minRule.setMessage("请至少输入 " + minLength + " 个字");rules.add(minRule);}Integer maxLength = config.getMaxLength();if (maxLength != null && maxLength > 0) {FormItemRule maxRule = new FormItemRule();maxRule.setMax(maxLength);maxRule.setMessage("请最多输入 " + maxLength + " 个字");rules.add(maxRule);}}
}/*** 单行文本框的转换器*/
@Component
public class TextInputConverter extends CommonTextConverter {@Overridepublic FormItemTypeEnum getType() {return FormItemTypeEnum.TEXT_INPUT;}
}/*** 多行文本框的转换器*/
@Component
public class TextAreaConvertor extends FormItemConverter {@Overridepublic FormItemTypeEnum getType() {return FormItemTypeEnum.TEXT_AREA;}
}

  • 制作简单工厂

@Component
public class FormItemConverterFactory {private static final EnumMap<FormItemTypeEnum, FormItemConverter> CONVERTER_MAP = new EnumMap<>(FormItemTypeEnum.class);/*** 根据表单项类型获得对应的转换器** @param type 表单项类型* @return 表单项转换器*/public FormItemConverter getConverter(FormItemTypeEnum type) {return CONVERTER_MAP.get(type);}@Autowiredpublic void setConverters(List<FormItemConverter> converters) {for (final FormItemConverter converter : converters) {CONVERTER_MAP.put(converter.getType(), converter);}}
}

  • 投入使用

@Component
public class FormItemManagerImpl implements FormItemManager {@Autowiredprivate FormItemConverterFactory converterFactory;@Overridepublic List<FormItem> convertFormItems(JSONArray inputConfigs) {return IntStream.range(0, inputConfigs.size()).mapToObj(inputConfigs::getJSONObject).map(this::convertFormItem).collect(Collectors.toList());}private FormItem convertFormItem(JSONObject inputConfig) {FormItemConfig itemConfig = inputConfig.toJavaObject(FormItemConfig.class);FormItemConverter converter = converterFactory.getConverter(itemConfig.getType());if (converter == null) {throw new IllegalArgumentException("不存在转换器：" + itemConfig.getType());}return converter.convert(itemConfig);}
}

Factory 只负责获取 Converter，每个 Converter 只负责对应表单项的转换功能，Manager 只负责逻辑编排，从而达到功能上的 “低耦合高内聚”。

  • 设想一次扩展

此时要加入一种新的表单项 —— 数字选择器（NUMBER_PICKER），它有着特殊的约束条件：最小值和最大值，输入到 FormItemConfig 时分别为 minNumer 和 maxNumber。

@Component
public class NumberPickerConverter extends FormItemConverter {@Overridepublic FormItemTypeEnum getType() {return FormItemTypeEnum.NUMBER_PICKER;}@Overrideprotected void afterRulesCreate(List<FormItemRule> rules, FormItemConfig config) {Integer minNumber = config.getMinNumber();// 处理最小值if (minNumber != null) {FormItemRule minNumRule = new FormItemRule();minNumRule.setMinimum(minNumber);minNumRule.setMessage("输入数字不能小于 " + minNumber);rules.add(minNumRule);}Integer maxNumber = config.getMaxNumber();// 处理最大值if (maxNumber != null) {FormItemRule maxNumRule = new FormItemRule();maxNumRule.setMaximum(maxNumber);maxNumRule.setMessage("输入数字不能大于 " + maxNumber);rules.add(maxNumRule);}}
}

此时，我们只需要添加对应的枚举和实现对应的 FormItemConverter，并不需要修改任何逻辑代码，因为 Spring 启动时会自动帮我们处理好 NUMBER_PICKER 和 NumberPickerConverter 的关联关系 —— 完美符合 “开闭原则”。

淘系技术部-全域营销团队-诚招英才

战斗在阿里电商的核心地带，负责连接供需两端，支持电商营销领域的各类产品、平台和解决方案，其中包括聚划算、百亿补贴、天猫U先、天猫小黑盒、天猫新品孵化、品牌号等重量级业务。我们深度参与双11、618、99划算节等年度大促，不断挑战技术的极限！ 团队成员背景多样，有深耕电商精研技术的老司机，也有朝气蓬勃的小萌新，更有可颜可甜的小姐姐，期待具有好奇心和思考力的你的加入！

【招聘岗位】Java 工程师 、数据工程师

如果您有兴趣可将简历发至 michaelchow.zm@alibaba-inc.com

或者添加作者微信 wx_zhou_mi 进行详细咨询，欢迎来撩~

✿  拓展阅读

作者|之叶

编辑|橙子君

出品|阿里巴巴新零售淘系技术

这篇关于设计模式最佳套路4 —— 愉快地使用模板模式的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/814379。

相关文章

Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
Linux join命令的使用及说明

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出
阅读更多...
Linux jq命令的使用解读

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.
阅读更多...
Linux kill正在执行的后台任务 kill进程组使用详解

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本，并kill2.1 进程查看2.2 遇到的
阅读更多...
详解SpringBoot+Ehcache使用示例

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储：配置灵活性：编码示例引入依赖：配置ehcache.XML文件：配置
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
k8s按需创建PV和使用PVC详解

k8s按需创建PV和使用PVC详解

《k8s按需创建PV和使用PVC详解》Kubernetes中,PV和PVC用于管理持久存储,StorageClass实现动态PV分配,PVC声明存储需求并绑定PV,通过kubectl验证状态,注意回收... 目录1.按需创建 PV（使用 StorageClass）创建 StorageClass2.创建 PV
阅读更多...
Redis 基本数据类型和使用详解

Redis 基本数据类型和使用详解

《Redis基本数据类型和使用详解》String是Redis最基本的数据类型,一个键对应一个值,它的功能十分强大,可以存储字符串、整数、浮点数等多种数据格式,本文给大家介绍Redis基本数据类型和... 目录一、Redis 入门介绍二、Redis 的五大基本数据类型2.1 String 类型2.2 Hash
阅读更多...
Redis中Hash从使用过程到原理说明

Redis中Hash从使用过程到原理说明

《Redis中Hash从使用过程到原理说明》RedisHash结构用于存储字段-值对,适合对象数据,支持HSET、HGET等命令,采用ziplist或hashtable编码,通过渐进式rehash优化... 目录一、开篇：Hash就像超市的货架二、Hash的基本使用1. 常用命令示例2. Java操作示例三
阅读更多...
Linux创建服务使用systemctl管理详解

Linux创建服务使用systemctl管理详解

《Linux创建服务使用systemctl管理详解》文章指导在Linux中创建systemd服务,设置文件权限为所有者读写、其他只读,重新加载配置,启动服务并检查状态,确保服务正常运行,关键步骤包括权... 目录创建服务 /usr/lib/systemd/system/设置服务文件权限：所有者读写js，其他
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2