摘要：下面將開始分析它的源碼。僅僅定義了一個最小應有的行為。更好的選擇由于該庫是為定制而生，故此有一些防御性判斷，源碼顯得略為。

本文首發于泊浮目的專欄：https://segmentfault.com/blog...

在ZStack（或者說產品化的IaaS軟件）中的任務通常有很長的執行路徑，錯誤可能發生在路徑的任意一處。為了保證系統的正確性，需提供一種較為完善的回滾機制——在ZStack中，通過一個工作流引擎，ZStack的每一個步驟都被包裹在獨立的工作流中，可以在出錯的時候回滾。此外，通過在配置文件中組裝工作流的方式，關鍵的執行路徑可以被配置，這使得架構的耦合度進一步降低。

系統解耦合的手段除了之前文章所提到的分層、分割、分布等，還有一個重要手段是異步，業務之間的消息傳遞不是同步調用，而是將一個業務操作分成多個階段，每個階段之間通過共享數據的方式異步執行進行協作。

這即是一種在業務設計原則中——流程可定義原則的具象化。接觸過金融行業的同學肯定知道，不同的保險理賠流程是不一樣的。而承保流程和理賠流程是分離的，在需要時進行關聯，從而可以復用一些理賠流程，并提供一些個性化理賠流程。

就以創建VM為例，在ZStack中大致可以分以下幾個步驟：

    
        
            
                org.zstack.compute.vm.VmImageSelectBackupStorageFlow
                org.zstack.compute.vm.VmAllocateHostFlow
                org.zstack.compute.vm.VmAllocatePrimaryStorageFlow
                org.zstack.compute.vm.VmAllocateVolumeFlow
                org.zstack.compute.vm.VmAllocateNicFlow
                org.zstack.compute.vm.VmInstantiateResourcePreFlow
                org.zstack.compute.vm.VmCreateOnHypervisorFlow
                org.zstack.compute.vm.VmInstantiateResourcePostFlow
            
        

可以說是代碼即文檔了。在這里，ZStack顯式聲明這些Flow在Spring XML中，這些屬性將會被注入到createVmWorkFlowElements中。每一個Flow都被拆成了一個個較小的單元，好處不僅是將業務操作分成了多個階段易于回滾，還是可以有效復用這些Flow。這也是編程思想中“組合”的體現。

除了這種配置型聲明，還可以在代碼中靈活的使用這些FlowChain。在這里，我們將以Case來說明這些FlowChain的用法，避免對ZStack業務邏輯不熟悉的讀者看的一頭霧水。

一共有兩種可用的FlowChain：

SimpleFlowChain

ShareFlowChain

我們先來看一個Case。

    @Test
    public void test() {
        FlowChain chain = FlowChainBuilder.newShareFlowChain();

        chain.then(new ShareFlow() {
            int a;

            @Override
            public void setup() {
                flow(new NoRollbackFlow() {
                    @Override
                    public void run(FlowTrigger trigger, Map data) {
                        a = 1;
                        increase();
                        trigger.next();
                    }
                });

                flow(new NoRollbackFlow() {
                    @Override
                    public void run(FlowTrigger trigger, Map data) {
                        a = 2;
                        increase();
                        trigger.next();
                    }
                });
            }
        }).done(new FlowDoneHandler(null) {
            @Override
            public void handle(Map data) {
                success = true;
            }
        }).start();

        Assert.assertTrue(success);
        expect(2);
    }

我們可以看到，這就是一個工作流。完成一個工作流的時候（回調觸發時）執行下一個工作流——由trigger.next觸發。不僅如此，還可以添加Rollback屬性。

    @Test
    public void test() throws WorkFlowException {
        final int[] count = {0};

        new SimpleFlowChain()
                .then(new Flow() {
                    @Override
                    public void run(FlowTrigger chain, Map data) {
                        count[0]++;
                        chain.next();
                    }

                    @Override
                    public void rollback(FlowRollback chain, Map data) {
                        count[0]--;
                        chain.rollback();
                    }
                })
                .then(new Flow() {
                    @Override
                    public void run(FlowTrigger chain, Map data) {
                        count[0]++;
                        chain.next();
                    }

                    @Override
                    public void rollback(FlowRollback chain, Map data) {
                        count[0]--;
                        chain.rollback();
                    }
                })
                .then(new Flow() {
                    @Override
                    public void run(FlowTrigger chain, Map data) {
                        chain.fail(null);
                    }

                    @Override
                    public void rollback(FlowRollback chain, Map data) {
                        count[0]--;
                        chain.rollback();
                    }
                })
                .start();

        Assert.assertEquals(-1, count[0]);
    }

rollback由FlowTrigger的fail觸發。這樣我們可以保證在發生一些錯誤的時候及時回滾，防止我們的系統處于一個有臟數據的中間狀態。同時，Map也可以用來在Flow之間傳遞上下文。

public class TestShareFlow {
    int[] count = {0};
    boolean success;

    private void increase() {
        count[0]++;
    }

    private void decrease() {
        count[0]--;
    }

    private void expect(int ret) {
        Assert.assertEquals(count[0], ret);
    }

    @Test
    public void test() {
        FlowChain chain = FlowChainBuilder.newShareFlowChain();

        chain.then(new ShareFlow() {
            int a;

            @Override
            public void setup() {
                flow(new NoRollbackFlow() {
                    @Override
                    public void run(FlowTrigger trigger, Map data) {
                        a = 1;
                        increase();
                        trigger.next();
                    }
                });

                flow(new NoRollbackFlow() {
                    @Override
                    public void run(FlowTrigger trigger, Map data) {
                        a = 2;
                        increase();
                        trigger.next();
                    }
                });
            }
        }).done(new FlowDoneHandler(null) {
            @Override
            public void handle(Map data) {
                success = true;
            }
        }).start();

        Assert.assertTrue(success);
        expect(2);
    }


    @Before
    public void setUp() throws Exception {
        new BeanConstructor().build();
    }
}

比起SimpleFlowChain，ShareFlowChain則是一個Inner class，在相同的作用域里，傳遞數據變得更加的方便了。

在ZStack中，FlowChain作為核心庫，其實現也是非常的簡單（可以直接參考SimpleFlowChain和ShareFlowChain），本質就是將任務放入List中，由內部方法進行迭代，在此基礎上做了一系列操作。下面將開始分析它的源碼。

public interface FlowChain {
    List getFlows();

    FlowChain insert(Flow flow);

    FlowChain insert(int pos, Flow flow);

    FlowChain setFlowMarshaller(FlowMarshaller marshaller);

    FlowChain then(Flow flow);

    FlowChain done(FlowDoneHandler handler);

    FlowChain error(FlowErrorHandler handler);

    FlowChain Finally(FlowFinallyHandler handler);

    FlowChain setData(Map data);

    FlowChain putData(Map.Entry... es);

    FlowChain setName(String name);

    void setProcessors(List processors);

    Map getData();

    void start();

    FlowChain noRollback(boolean no);

    FlowChain allowEmptyFlow();
}

接口的名字非常的易懂，那么在這里就不多作解釋了。FlowChain僅僅定義了一個Flow最小應有的行為。

//定義了Flow的回滾操作接口
public interface FlowRollback extends AsyncBackup {
    //回滾操作
    void rollback();
    //設置跳過回滾操作
    void skipRestRollbacks();
}

//定義了觸發器的行為接口
public interface FlowTrigger extends AsyncBackup {
    //觸發失敗，調用errorHandle
    void fail(ErrorCode errorCode);
    //觸發下一個flow
    void next();
    //setError后，在下次調用next的時才會調用errorHandle
    void setError(ErrorCode error);
}

public interface Flow {
    void run(FlowTrigger trigger, Map data);

    void rollback(FlowRollback trigger, Map data);
}

Flow的定義其實非常的簡單——一組方法。執行和對應的回滾，一般在ZStack中都以匿名內部類的方式傳入。

在之前的SimpleFlowChain的case中。我們可以看到一系列的鏈式調用，大致如下：

new SimpleFlowChain().then(new flow()).then(new flow()).then(new flow()).start();

then本質是往List flows里添加一個flow。

    public SimpleFlowChain then(Flow flow) {
        flows.add(flow);
        return this;
    }

再來看看start

    @Override
    public void start() {
        // 檢測flow中是否設置了processors。一般用來打trace
        if (processors != null) {
            for (FlowChainProcessor p : processors) {
                p.processFlowChain(this);
            }
        }
        //如果flows為空但是之前在設置中允許為空，那么就直接直接done部分的邏輯。不然就報錯
        if (flows.isEmpty() && allowEmptyFlow) {
            callDoneHandler();
            return;
        }

        if (flows.isEmpty()) {
            throw new CloudRuntimeException("you must call then() to add flow before calling start() or allowEmptyFlow() to run empty flow chain on purpose");
        }
        //每個flow必須有一個map，用來傳遞上下文
        if (data == null) {
            data = new HashMap();
        }
        //標記為已經開始
        isStart = true;
        //如果沒有名字的話給flow 取一個名字，因為很有可能是匿名使用的flow
        if (name == null) {
            name = "anonymous-chain";
        }

        logger.debug(String.format("[FlowChain(%s): %s] starts", id, name));
        //打印trace，方便調試
        if (logger.isTraceEnabled()) {
            List names = CollectionUtils.transformToList(flows, new Function() {
                @Override
                public String call(Flow arg) {
                    return String.format("%s[%s]", arg.getClass(), getFlowName(arg));
                }
            });
            logger.trace(String.format("execution path:
%s", StringUtils.join(names, " -->
")));
        }
        //生成一個迭代器
        it = flows.iterator();
        //從it中獲取一個不需要跳過的flow開始執行。如果沒有獲取到，就執行done邏輯
        Flow flow = getFirstNotSkippedFlow();
        if (flow == null) {
            // all flows are skipped
            callDoneHandler();
        } else {
            runFlow(flow);
        }
    }

再來看一下runFlow中的代碼

    private void runFlow(Flow flow) {
        try {
            //看報錯信息就可以猜到在做什么防御措施了：如果一個transaction在一個flow中沒有被關閉而跳到下一個flow時，會拋出異常。這個防御機制來自于一個實習生寫的bug，當時被排查出來的時候花了非常大的力氣——現象非常的詭異。所以現在被寫在了這里。
            if (TransactionSynchronizationManager.isActualTransactionActive()) {
                String flowName = null;
                String flowClassName = null;
                if (currentFlow != null) {
                    flowName = getFlowName(currentFlow);
                    flowClassName = currentFlow.getClass().getName();
                }

                throw new CloudRuntimeException(String.format("flow[%s:%s] opened a transaction but forgot closing it", flowClassName, flowName));
            }
            //toRun就是一個當前要run的flow
            Flow toRun = null;
            if (flowMarshaller != null) {
            //flowMarshaller 實際上是一個非常惡心的玩意兒。尤其在一些配置好掉的xml flow突然因為一些條件而改變接下來執行的flow令人很無語...但是也提供了一些靈活性。
                toRun = flowMarshaller.marshalTheNextFlow(currentFlow == null ? null : currentFlow.getClass().getName(),
                        flow.getClass().getName(), this, data);
                if (toRun != null) {
                    logger.debug(String.format("[FlowChain(%s): %s] FlowMarshaller[%s] replaces the next flow[%s] to the flow[%s]",
                            id, name, flowMarshaller.getClass(), flow.getClass(), toRun.getClass()));
                }
            }
       
            if (toRun == null) {
                toRun = flow;
            }

            if (CoreGlobalProperty.PROFILER_WORKFLOW) {
                //對flow的監視。比如flow的執行時間等
                stopWatch.start(toRun);
            }

            currentFlow = toRun;

            String flowName = getFlowName(currentFlow);
            String info = String.format("[FlowChain(%s): %s] start executing flow[%s]", id, name, flowName);
            logger.debug(info);
            //在flow中還允許定義afterDone afterError afterFinal的行為。稍后將會介紹
            collectAfterRunnable(toRun);
            //終于到了run，這里就是調用者傳入的行為來決定run中的邏輯
            toRun.run(this, data);
             //fail的邏輯稍后解析
        } catch (OperationFailureException oe) {
            String errInfo = oe.getErrorCode() != null ? oe.getErrorCode().toString() : "";
            logger.warn(errInfo, oe);
            fail(oe.getErrorCode());
        } catch (FlowException fe) {
            String errInfo = fe.getErrorCode() != null ? fe.getErrorCode().toString() : "";
            logger.warn(errInfo, fe);
            fail(fe.getErrorCode());
        } catch (Throwable t) {
            logger.warn(String.format("[FlowChain(%s): %s] unhandled exception when executing flow[%s], start to rollback",
                    id, name, flow.getClass().getName()), t);
            fail(errf.throwableToInternalError(t));
        }
    }

fail

    @Override
    public void fail(ErrorCode errorCode) {
        isFailCalled = true;
        setErrorCode(errorCode);
        //放入Stack中，之后Rollback會根據Stack中的flow順序來
        rollBackFlows.push(currentFlow);
        //rollback會對this.rollBackFlows中flow按照順序調用rollback
        rollback();
    }

//定義了觸發器的行為接口
public interface FlowTrigger extends AsyncBackup {
    //觸發失敗，調用errorHandle
    void fail(ErrorCode errorCode);
    //觸發下一個flow
    void next();
    //setError后，在下次調用next的時才會調用errorHandle
    void setError(ErrorCode error);
}

之前已經看過fail的代碼。接下來來看看next和setError。

    @Override
    public void next() {
        //如果flow沒有run起來的情況下，是不能調用next的
        if (!isStart) {
            throw new CloudRuntimeException(
                    String.format("[FlowChain(%s): %s] you must call start() first, and only call next() in Flow.run()",
                            id, name));
        }
        //當rollback開始的時候也不允許next
        if (isRollbackStart) {
            throw new CloudRuntimeException(
                    String.format("[FlowChain(%s): %s] rollback has started, you can"t call next()", id, name));
        }
        //將當前flow的push進rollback用的stack
        rollBackFlows.push(currentFlow);

        logger.debug(String.format("[FlowChain(%s): %s] successfully executed flow[%s]", id, name, getFlowName(currentFlow)));
        //獲取下一個flow。在這里才是真正意義上的next
        Flow flow = getFirstNotSkippedFlow();
        if (flow == null) {
            // no flows, or all flows are skipped
            if (errorCode == null) {
                callDoneHandler();
            } else {
                callErrorHandler(false);
            }
        } else {
            runFlow(flow);
        }
    }

可以看一下getFirstNotSkippedFlow，本質上是利用了迭代器的特性。

    private Flow getFirstNotSkippedFlow() {
        Flow flow = null;
        while (it.hasNext()) {
            flow = it.next();
            if (!isSkipFlow(flow)) {
                break;
            }
        }

        return flow;
    }

接下來是setError

    @Override
    public void setError(ErrorCode error) {
        setErrorCode(error);
    }

//往下看
    private void setErrorCode(ErrorCode errorCode) {
        this.errorCode = errorCode;
    }

根據之前的next邏輯：

        if (flow == null) {
            // no flows, or all flows are skipped
            if (errorCode == null) {
                callDoneHandler();
            } else {
                callErrorHandler(false);
            }
        } else {
            runFlow(flow);
        }

我們可以大致猜想到，如果在next的時候當前error不為空，則調用錯誤handle。這樣在setError后還可以做一些事情。

無論是調用errorHandle還是doneHandle，都會調用finalHandle。finalHandle也允許用戶定義這部分的邏輯，使flow更加的靈活。

由于該庫是為ZStack定制而生，故此有一些防御性判斷，源碼顯得略為verbose。如果有同學對此感興趣，想將其應用到自己的系統中，筆者推薦使用：jdeferred。

Java Deferred/Promise library similar to JQuery

由于JavaScript 中的代碼都是異步調用的。簡單說，它的思想是，每一個異步任務返回一個Promise對象，該對象有一個then方法，允許指定回調函數。

在這里列出幾個較為簡單的示范，或者有興趣的讀者也可以參考這里：

import org.jdeferred.DeferredManager;
import org.jdeferred.Promise;
import org.jdeferred.impl.DefaultDeferredManager;
import org.junit.After;
import org.junit.Assert;
import org.junit.Test;

import java.util.concurrent.TimeUnit;


public class deferSimpleTest {

    private static int var = 0;
    final DeferredManager dm = new DefaultDeferredManager();

    @After
    public void cleanUp() {
        var = 0;
    }


    @Test
    public void test() {
        Promise p1 = dm.when(() -> {
            var += 1;
        }).then(result -> {
            var += 1;
        });

        Promise p2 = dm.when(() -> {
            var += 1;
        }).then(result -> {
            var += 1;
        });

        dm.when(p1, p2).done(Void -> var += 1);
        Assert.assertEquals(5, var);
    }

    @Test
    public void test2() {
        final DeferredManager dm = new DefaultDeferredManager();

        Promise promise = dm.when(() -> {
                var += 1;
            }).then(result -> {
                var += 1;
            });

        dm.when(promise).done(Void -> var += 1);
        Assert.assertEquals(3, var);
    }

    @Test
    public void testBadCallback() {
        Promise promise = dm.when(() -> {
            try {
                TimeUnit.SECONDS.sleep(1);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        });
        dm.when(promise).done(Void -> {
                    var += 1;
                    throw new RuntimeException("this exception is expected");
                }
        ).fail(Void -> {
            System.out.print("fail!");
            var -= 1;
        });
        Assert.assertEquals(0, var);

    }
}

如果你在使用Java8，那么也可以通過CompletableFuture來得到“類似”的支持。