基于Spring實現(xiàn)管道模式的方法步驟

本篇內(nèi)容主要講解“基于Spring實現(xiàn)管道模式的方法步驟”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學(xué)習(xí)“基于Spring實現(xiàn)管道模式的方法步驟”吧!

管道模式（Pipeline Pattern） 是責(zé)任鏈模式（Chain of Responsibility Pattern）的常用變體之一。在管道模式中，管道扮演著流水線的角色，將數(shù)據(jù)傳遞到一個加工處理序列中，數(shù)據(jù)在每個步驟中被加工處理后，傳遞到下一個步驟進行加工處理，直到全部步驟處理完畢。

PS：純的責(zé)任鏈模式在鏈上只會有一個處理器用于處理數(shù)據(jù)，而管道模式上多個處理器都會處理數(shù)據(jù)。

何時使用管道模式

任務(wù)代碼較為復(fù)雜，需要拆分為多個子步驟時，尤其是后續(xù)可能在任意位置添加新的子步驟、刪除舊的子步驟、交換子步驟順序，可以考慮使用管道模式。

愉快地使用管道模式

• 背景回放

最開始做模型平臺的時候，創(chuàng)建模型實例的功能，包括：“輸入數(shù)據(jù)校驗 -> 根據(jù)輸入創(chuàng)建模型實例 -> 保存模型實例到相關(guān) DB 表”總共三個步驟，也不算復(fù)雜，所以當(dāng)時的代碼大概是這樣的：

public class ModelServiceImpl implements ModelService {

    /**
     * 提交模型（構(gòu)建模型實例）
     */
    public CommonReponse<Long> buildModelInstance(InstanceBuildRequest request) {
        // 輸入數(shù)據(jù)校驗
        validateInput(request);
        // 根據(jù)輸入創(chuàng)建模型實例
        ModelInstance instance = createModelInstance(request);
        // 保存實例到相關(guān) DB 表
        saveInstance(instance);
    }
}

然而沒有過多久，我們發(fā)現(xiàn)表單輸入數(shù)據(jù)的格式并不完全符合模型的輸入要求，于是我們要加入 “表單數(shù)據(jù)的預(yù)處理”。這功能還沒動手呢，又有業(yè)務(wù)方提出自己也存在需要對數(shù)據(jù)進行處理的情況（比如根據(jù)商家的表單輸入，生成一些其他業(yè)務(wù)數(shù)據(jù)作為模型輸入）。

所以在 “輸入數(shù)據(jù)校驗” 之后，還需要加入 “表單輸入輸出預(yù)處理” 和 “業(yè)務(wù)方自定義數(shù)據(jù)處理（可選）”。這個時候我就面臨一個選擇：是否繼續(xù)通過在 buildModelInstance 中加入新的方法來實現(xiàn)這些新的處理步驟？好處就是可以當(dāng)下偷懶，但是壞處呢：

1. ModelService 應(yīng)該只用來接收 HSF 請求，而不應(yīng)該承載業(yè)務(wù)邏輯，如果將 提交模型 的邏輯都寫在這個類當(dāng)中，違反了 單一職責(zé)，而且后面會導(dǎo)致 類代碼爆炸。

2. 將來每加入一個新的處理步驟或者刪除某個步驟，我就要修改 buildModelInstance 這個本應(yīng)該非常內(nèi)聚的方法，違反了 開閉原則。

所以，為了不給以后的自己挖坑，我覺得要思考一個萬全的方案。這個時候，我小腦袋花開始飛轉(zhuǎn)，突然閃過了 Netty 中的 ChannelPipeline —— 對哦，管道模式，不就正是我需要的嘛！

管道模式的實現(xiàn)方式也是多種多樣，接下來基于前面的背景，我分享一下我目前基于 Spring 實現(xiàn)管道模式的 “最佳套路”。

• 定義管道處理的上下文

/**
 * 傳遞到管道的上下文
 */
@Getter
@Setter
public class PipelineContext {

    /**
     * 處理開始時間
     */
    private LocalDateTime startTime;

    /**
     * 處理結(jié)束時間
     */
    private LocalDateTime endTime;

    /**
     * 獲取數(shù)據(jù)名稱
     */
    public String getName() {
        return this.getClass().getSimpleName();
    }
}

• 定義上下文處理器

/**
 * 管道中的上下文處理器
 */
public interface ContextHandler<T extends PipelineContext> {

    /**
     * 處理輸入的上下文數(shù)據(jù)
     *
     * @param context 處理時的上下文數(shù)據(jù)
     * @return 返回 true 則表示由下一個 ContextHandler 繼續(xù)處理，返回 false 則表示處理結(jié)束
     */
    boolean handle(T context);
}

為了方便說明，我們現(xiàn)在先定義出最早版 【提交模型邏輯】 的上下文和相關(guān)處理器：

/**
 * 模型實例構(gòu)建的上下文
 */
@Getter
@Setter
public class InstanceBuildContext extends PipelineContext {

    /**
     * 模型 id
     */
    private Long modelId;

    /**
     * 用戶 id
     */
    private long userId;

    /**
     * 表單輸入
     */
    private Map<String, Object> formInput;

    /**
     * 保存模型實例完成后，記錄下 id
     */
    private Long instanceId;

    /**
     * 模型創(chuàng)建出錯時的錯誤信息
     */
    private String errorMsg;

    // 其他參數(shù)

    @Override
    public String getName() {
        return "模型實例構(gòu)建上下文";
    }
}

處理器 - 輸入數(shù)據(jù)校驗：

@Component
public class InputDataPreChecker implements ContextHandler<InstanceBuildContext> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public boolean handle(InstanceBuildContext context) {
        logger.info("--輸入數(shù)據(jù)校驗--");

        Map<String, Object> formInput = context.getFormInput();

        if (MapUtils.isEmpty(formInput)) {
            context.setErrorMsg("表單輸入數(shù)據(jù)不能為空");
            return false;
        }

        String instanceName = (String) formInput.get("instanceName");

        if (StringUtils.isBlank(instanceName)) {
            context.setErrorMsg("表單輸入數(shù)據(jù)必須包含實例名稱");
            return false;
        }

        return true;
    }
}

處理器 - 根據(jù)輸入創(chuàng)建模型實例：

@Component
public class ModelInstanceCreator implements ContextHandler<InstanceBuildContext> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public boolean handle(InstanceBuildContext context) {
        logger.info("--根據(jù)輸入數(shù)據(jù)創(chuàng)建模型實例--");

        // 假裝創(chuàng)建模型實例

        return true;
    }
}

處理器 - 保存模型實例到相關(guān)DB表：

@Component
public class ModelInstanceSaver implements ContextHandler<InstanceBuildContext> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public boolean handle(InstanceBuildContext context) {
        logger.info("--保存模型實例到相關(guān)DB表--");

        // 假裝保存模型實例

        return true;
    }
}

到這里，有個問題就出現(xiàn)了：應(yīng)該使用什么樣的方式，將同一種 Context 的 ContextHandler 串聯(lián)為管道呢？思考一下：

1. 給 ContextHandler 加一個 setNext 方法，每個實現(xiàn)類必須指定其下一個處理器。缺點也很明顯，如果在當(dāng)前管道中間加入一個新的 ContextHandler，那么要勢必要修改前一個 ContextHandler 的 setNext 方法；另外，代碼是寫給人閱讀的，這樣做沒法一眼就直觀的知道整個管道的處理鏈路，還要進入到每個相關(guān)的 ContextHandler 中去查看才知道。

2. 給 ContextHandler 加上 @Order 注解，根據(jù) @Order 中給定的數(shù)字來確定每個 ContextHandler 的序列，一開始時每個數(shù)字間隔的可以大些（比如 10、20、30），后續(xù)加入新的 ContextHandler 時，可以指定數(shù)字為 （11、21、31）這種，那么可以避免上面方案中要修改代碼的問題，但是仍然無法避免要進入每個相關(guān)的 ContextHandler 中去查看才能知道管道處理鏈路的問題。

3. 提前寫好一份路由表，指定好 ”Context -> 管道“ 的映射（管道用 List<ContextHandler> 來表示），以及管道中處理器的順序 。Spring 來根據(jù)這份路由表，在啟動時就構(gòu)建好一個 Map，Map 的鍵為 Context 的類型，值為 管道（即 List<ContextHandler>）。這樣的話，如果想知道每個管道的處理鏈路，直接看這份路由表就行，一目了然。缺點嘛，就是每次加入新的 ContextHandler 時，這份路由表也需要在對應(yīng)管道上進行小改動 —— 但是如果能讓閱讀代碼更清晰，我覺得這樣的修改是值得的、可接受的~

• 構(gòu)建管道路由表

基于 Spring 的 Java Bean 配置，我們可以很方便的構(gòu)建管道的路由表：

/**
 * 管道路由的配置
 */
@Configuration
public class PipelineRouteConfig implements ApplicationContextAware {

    /**
     * 數(shù)據(jù)類型->管道中處理器類型列表 的路由
     */
    private static final
    Map<Class<? extends PipelineContext>,
        List<Class<? extends ContextHandler<? extends PipelineContext>>>> PIPELINE_ROUTE_MAP = new HashMap<>(4);

    /*
     * 在這里配置各種上下文類型對應(yīng)的處理管道：鍵為上下文類型，值為處理器類型的列表
     */
    static {
        PIPELINE_ROUTE_MAP.put(InstanceBuildContext.class,
                               Arrays.asList(
                                       InputDataPreChecker.class,
                                       ModelInstanceCreator.class,
                                       ModelInstanceSaver.class
                               ));

        // 將來其他 Context 的管道配置
    }

    /**
     * 在 Spring 啟動時，根據(jù)路由表生成對應(yīng)的管道映射關(guān)系
     */
    @Bean("pipelineRouteMap")
    public Map<Class<? extends PipelineContext>, List<? extends ContextHandler<? extends PipelineContext>>> getHandlerPipelineMap() {
        return PIPELINE_ROUTE_MAP.entrySet()
                                 .stream()
                                 .collect(Collectors.toMap(Map.Entry::getKey, this::toPipeline));
    }

    /**
     * 根據(jù)給定的管道中 ContextHandler 的類型的列表，構(gòu)建管道
     */
    private List<? extends ContextHandler<? extends PipelineContext>> toPipeline(
            Map.Entry<Class<? extends PipelineContext>, List<Class<? extends ContextHandler<? extends PipelineContext>>>> entry) {
        return entry.getValue()
                    .stream()
                    .map(appContext::getBean)
                    .collect(Collectors.toList());
    }

    private ApplicationContext appContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        appContext = applicationContext;
    }
}

• 定義管道執(zhí)行器

最后一步，定義管道執(zhí)行器。管道執(zhí)行器 根據(jù)傳入的上下文數(shù)據(jù)的類型，找到其對應(yīng)的管道，然后將上下文數(shù)據(jù)放入管道中去進行處理。

/**
 * 管道執(zhí)行器
 */
@Component
public class PipelineExecutor {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    /**
     * 引用 PipelineRouteConfig 中的 pipelineRouteMap
     */
    @Resource
    private Map<Class<? extends PipelineContext>,
                List<? extends ContextHandler<? super PipelineContext>>> pipelineRouteMap;

    /**
     * 同步處理輸入的上下文數(shù)據(jù)<br/>
     * 如果處理時上下文數(shù)據(jù)流通到最后一個處理器且最后一個處理器返回 true，則返回 true，否則返回 false
     *
     * @param context 輸入的上下文數(shù)據(jù)
     * @return 處理過程中管道是否暢通，暢通返回 true，不暢通返回 false
     */
    public boolean acceptSync(PipelineContext context) {
        Objects.requireNonNull(context, "上下文數(shù)據(jù)不能為 null");
        // 拿到數(shù)據(jù)類型
        Class<? extends PipelineContext> dataType = context.getClass();
        // 獲取數(shù)據(jù)處理管道
        List<? extends ContextHandler<? super PipelineContext>> pipeline = pipelineRouteMap.get(dataType);

        if (CollectionUtils.isEmpty(pipeline)) {
            logger.error("{} 的管道為空", dataType.getSimpleName());
            return false;
        }

        // 管道是否暢通
        boolean lastSuccess = true;

        for (ContextHandler<? super PipelineContext> handler : pipeline) {
            try {
                // 當(dāng)前處理器處理數(shù)據(jù)，并返回是否繼續(xù)向下處理
                lastSuccess = handler.handle(context);
            } catch (Throwable ex) {
                lastSuccess = false;
                logger.error("[{}] 處理異常，handler={}", context.getName(), handler.getClass().getSimpleName(), ex);
            }

            // 不再向下處理
            if (!lastSuccess) { break; }
        }

        return lastSuccess;
    }
}

• 使用管道模式

此時，我們可以將最開始的 buildModelInstance 修改為：

public CommonResponse<Long> buildModelInstance(InstanceBuildRequest request) {
    InstanceBuildContext data = createPipelineData(request);
    boolean success = pipelineExecutor.acceptSync(data);

    // 創(chuàng)建模型實例成功
    if (success) {
        return CommonResponse.success(data.getInstanceId());
    }

    logger.error("創(chuàng)建模式實例失?。簕}", data.getErrorMsg());
    return CommonResponse.failed(data.getErrorMsg());
}

這個時候我們再為 InstanceBuildContext 加入新的兩個 ContextHandler：FormInputPreprocessor（表單輸入數(shù)據(jù)預(yù)處理） 和 BizSideCustomProcessor（業(yè)務(wù)方自定義數(shù)據(jù)處理）。

@Component
public class FormInputPreprocessor implements ContextHandler<InstanceBuildContext> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public boolean handle(InstanceBuildContext context) {
        logger.info("--表單輸入數(shù)據(jù)預(yù)處理--");

        // 假裝進行表單輸入數(shù)據(jù)預(yù)處理

        return true;
    }
}

@Component
public class BizSideCustomProcessor implements ContextHandler<InstanceBuildContext> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public boolean handle(InstanceBuildContext context) {
        logger.info("--業(yè)務(wù)方自定義數(shù)據(jù)處理--");

        // 先判斷是否存在自定義數(shù)據(jù)處理，如果沒有，直接返回 true

        // 調(diào)用業(yè)務(wù)方的自定義的表單數(shù)據(jù)處理

        return true;
    }
}

此時 buildModelInstance 不需要做任何修改，我們只需要在 “路由表” 里面，將這兩個 ContextHandler 加入到 InstanceBuildContext 關(guān)聯(lián)的管道中，Spring 啟動的時候，會自動幫我們構(gòu)建好每種 Context 對應(yīng)的管道：

總結(jié)

通過管道模式，我們大幅降低了系統(tǒng)的耦合度和提升了內(nèi)聚程度與擴展性：

ModelService 只負(fù)責(zé)處理 HSF 請求，不用關(guān)心具體的業(yè)務(wù)邏輯 PipelineExecutor 只做執(zhí)行工作，不用關(guān)心具體的管道細節(jié) 每個 ContextHandler 只負(fù)責(zé)自己那部分的業(yè)務(wù)邏輯，不需要知道管道的結(jié)構(gòu)，與其他ContextHandler 的業(yè)務(wù)邏輯解耦 新增、刪除 或者 交換子步驟時，都只需要操作路由表的配置，而不要修改原來的調(diào)用代碼

到此，相信大家對“基于Spring實現(xiàn)管道模式的方法步驟”有了更深的了解，不妨來實際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進入相關(guān)頻道進行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！