設計模式最佳套路 4 —— 愉快地使用模板模式
什麼是模板模式
模板模式(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 方法來進行新表單項的特殊處理。觀察上面的代碼,將配置轉變爲表單項 這個操作,滿足以下流程:
-
創建表單項,並設置通用的表單項屬性,然後再對不同表單項的特殊屬性進行處理
-
創建組件屬性,處理通用的組件屬性,然後再對不同組件的特殊屬性進行處理
-
創建約束規則,處理通用的約束規則,然後再對不同表單項的特性約束規則進行處理
這不正是符合模板模式的使用場景(操作流程固定,特殊步驟可自定義處理)嗎?基於上面這個場景,下面我就分享一下我目前基於 Spring 實現模板模式的 “最佳套路”(如果你有更好的套路,歡迎賜教和討論哦)~
方案
-
定義出模板
即首先定義出表單項轉換的操作流程,即如下的 convert 方法(使用 final 修飾,確保子類不可修改操作流程):
-
模板的實現
針對不同的表單項,對特殊步驟進行自定義處理:
-
製作簡單工廠
-
投入使用
Factory 只負責獲取 Converter,每個 Converter 只負責對應表單項的轉換功能,Manager 只負責邏輯編排,從而達到功能上的 “低耦合高內聚”。
-
設想一次擴展
此時要加入一種新的表單項 —— 數字選擇器(NUMBER_PICKER),它有着特殊的約束條件:最小值和最大值,輸入到 FormItemConfig 時分別爲 minNumer 和 maxNumber。
@Component
public class NumberPickerConverter extends FormItemConverter {
@Override
public FormItemTypeEnum getType() {
return FormItemTypeEnum.NUMBER_PICKER;
}
@Override
protected 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 的關聯關係 —— 完美符合 “開閉原則”。
作者 | 之葉
編輯 | 橙子君
出品 | 阿里巴巴新零售淘系技術
本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源:https://mp.weixin.qq.com/s/QBmDiyfST13nQJUcPLLXOg