Android代碼重構之-優雅的解決順序調用方法之間的耦合

背景

before:

在咱們APP啓動過程,咱們可能經常有這樣的需求:在APP第一次進入的時候根據網絡請求的結果彈一個對話框式的廣告, ok~ 很簡單,那麼代碼大體就是這樣(這邊都是僞代碼,爲了方便理解):java

@Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
       checkFirstDialogIfNeed();
    }
    /** * step 1 */
    private void checkFirstDialogIfNeed(){
        Utils.fakeRequest("http://www.api1.com", new HttpCallBack() {
            @Override
            public void onOk() {
                showADialog();
            }

            @Override
            public void onFailure() {
               //do nothing
            }
        });
    }
複製代碼

ok,作完上線node

step1

過了一陣子,產品同窗又跑過來了說: 「老闆的需求,咱們要在首頁第一次進來的時候加一個註冊協議的彈框」程序員小A: 「但是首頁已經以前有一個彈框了,直接一塊兒展現嗎?」產品同窗: 「一塊兒彈出來體驗很差,那你放在A彈框以後吧!」git

ok,那麼程序員小A尋思了一下,那應該就是這麼改了:程序員

@Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
           checkFirstDialogIfNeed();
    }

    private void checkFirstDialogIfNeed(){
        Utils.fakeRequest("http://www.api1.com", new HttpCallBack() {
            @Override
            public void onOk() {
                showADialog();
            }

            @Override
            public void onFailure() {
                //請求失敗直接跳過，請求註冊協議
                checkRegisterAgreement();
            }
        });
    }

    private void showADialog() {
        new AlertDialog.Builder(this)
                .setTitle("這是一條有態度的廣告")
                .setPositiveButton("我看完了", null)
                .setOnDismissListener(new DialogInterface.OnDismissListener() {
                    @Override
                    public void onDismiss(DialogInterface dialogInterface) {
                    	//彈框結束後請求註冊協議
                        checkRegisterAgreement();
                    }
                }).create().show();
    }
    private void checkRegisterAgreement() {
        Utils.fakeRequest("http://www.api2.com", new HttpCallBack() {
            @Override
            public void onOk() {
                showBDialog();
            }

            @Override
            public void onFailure() {
                //do nothing
            }
        });
    }
複製代碼

這麼下來,咱們先請求接口APi1,若是成功了彈廣告彈框A,彈框結束了調用註冊協議的方法,若是APi1 請求失敗,直接跳過廣告彈框A,繼而請求註冊協議,當註冊協議請求成功了彈出咱們的註冊協議彈框,這麼下來,咱們確實能夠保證註冊協議彈框在廣告彈框以後~github

step2

過了幾天,產品同窗又來了:「此次咱們首頁初次進來再加一個H5頁面跳轉,此次就加在廣告和註冊協議之間吧....」api

因而乎,小A繼續改了改代碼,整個代碼就成了這樣:數組

@Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        checkFirstDialogIfNeed();
    }

    private void checkFirstDialogIfNeed() {
        Utils.fakeRequest("http://www.api1.com", new HttpCallBack() {
            @Override
            public void onOk() {
                showADialog();
            }

            @Override
            public void onFailure() {
// //請求失敗直接跳過，請求註冊協議
// checkRegisterAgreement();
                checkNeedShowH5();
            }
        });
    }

    private void showADialog() {
        new AlertDialog.Builder(this)
                .setTitle("這是一條有態度的廣告")
                .setPositiveButton("我看完了", null)
                .setOnDismissListener(new DialogInterface.OnDismissListener() {
                    @Override
                    public void onDismiss(DialogInterface dialogInterface) {
                        // //彈框結束後請求註冊協議
// checkRegisterAgreement();
                        //如今產品要插入一個H5頁面優先請求
                        checkNeedShowH5();

                    }
                }).create().show();
    }
    
    private void checkRegisterAgreement() {
        Utils.fakeRequest("http://www.api2.com", new HttpCallBack() {
            @Override
            public void onOk() {
                showBDialog();
            }

            @Override
            public void onFailure() {
                //do nothing
            }
        });
    }

    private void showBDialog() {
        new AlertDialog.Builder(this)
                .setTitle("這是註冊協議")
                .setPositiveButton("我看完了", null)
                .setOnDismissListener(new DialogInterface.OnDismissListener() {
                    @Override
                    public void onDismiss(DialogInterface dialogInterface) {
                        //do nothing
                    }
                }).create().show();
    }

    private void checkNeedShowH5() {
        Utils.fakeRequest("http://www.api3.com", new HttpCallBack() {
            @Override
            public void onOk() {
                toH5Page();
            }

            @Override
            public void onFailure() {
                checkRegisterAgreement();
            }
        });
    }

    private void toH5Page() {
        startActivityForResult(new Intent(this, TestH5Activity.class), REQUEST_CODE_H5);
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        switch (requestCode) {
            case REQUEST_CODE_H5:
                checkRegisterAgreement();
                break;
            default:
                break;
        }
    }
複製代碼

首先將原有step1 結束以後再也不調用註冊協議,而是調用請求H5的方法
因爲去H5是一個Activity的跳轉,因此咱們在onActivityResult裏咱們繼續以前的註冊協議的調用.

看看大體demo效果: markdown

再後來......幾經迭代,首頁首次的彈框和頁面跳轉已經有七、8個了,當每次產品有相似需求的時候,咱們又要重複上面的過程了,每次大概梳理個大半天吧.網絡

你們是否有發現什麼問題嗎? 1.首頁次序之間強耦合,每次一旦要在兩者以前插入一個其餘彈框或者頁面,咱們每次都要修改在它以前和以後的調用鏈,至少要修改三處,很容易漏掉,可是實際上它們彼此之間除了次序以外,沒有其餘關聯. 2.每次新需求來的時候都要完整梳理原有邏輯,比較浪費時間,影響效率.數據結構

思考:

1.可否在一個鏈中統一管理要處理的事情,每一個事情之間互相不關聯,只要簡單配置就能夠輕鬆替換它們之間的順序. 2.後來維護者,很清晰的就能知道調用的次序,無需每次從新梳理整個業務代碼.

設計:

1.咱們是否能夠把每件要作的事情抽象成一個節點,每一個節點只關心本身的任務是否完成,它並不知道它是第幾個,也不知道它前面或者後面的是誰. 2.每一個節點統一由一個流來管理,它做爲全局統籌者,能夠控制從任意節點開始、控制整個流的開啓與結束等,每一個節點的順序由流來管理.

實現:

after:

帶着以上設計思路,我對代碼作了一下重構,代碼變成了這樣:

public class AfterActivity extends AppCompatActivity {

    private static final int REQUEST_CODE_H5 = 1;

    /** * 初次廣告彈框 */
    private static final int NODE_FIRST_AD = 10;

    /** * 初次進入h5頁 */
    private static final int NODE_CHECK_H5 = 20;

    /** * 初次進入的註冊協議 */
    private static final int NODE_REGISTER_AGREEMENT = 30;

    private WorkFlow workFlow;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        startWorkFlow();
    }

    private void startWorkFlow() {
        workFlow = new WorkFlow.Builder()
                .withNode(getFirstAdNode())
                .withNode(getShowRegisterAgreementNode())
                .withNode(getShowH5Node())
                .create();
        workFlow.start();
    }

    private WorkNode getFirstAdNode() {
        return WorkNode.build(NODE_FIRST_AD, new Worker() {
            @Override
            public void doWork(final Node current) {
                Utils.fakeRequest("http://www.api1.com", new HttpCallBack() {
                    @Override
                    public void onOk() {
                        new AlertDialog.Builder(AfterActivity.this)
                                .setTitle("這是一條有態度的廣告")
                                .setPositiveButton("我看完了", null)
                                .setOnDismissListener(new DialogInterface.OnDismissListener() {
                                    @Override
                                    public void onDismiss(DialogInterface dialogInterface) {
                                        //僅僅只需關心本身是否完成，下一個節點會自動執行
                                        current.onCompleted();
                                    }
                                }).create().show();
                    }

                    @Override
                    public void onFailure() {
                        //僅僅只需關心本身是否完成，下一個節點會自動執行
                        current.onCompleted();
                    }
                });
            }
        });
    }

    private WorkNode getShowRegisterAgreementNode() {
        return WorkNode.build(NODE_REGISTER_AGREEMENT, new Worker() {
            @Override
            public void doWork(final Node current) {
                Utils.fakeRequest("http://www.api2.com", new HttpCallBack() {
                    @Override
                    public void onOk() {
                        new AlertDialog.Builder(AfterActivity.this)
                                .setTitle("這是註冊協議")
                                .setPositiveButton("我看完了", null)
                                .setOnDismissListener(new DialogInterface.OnDismissListener() {
                                    @Override
                                    public void onDismiss(DialogInterface dialogInterface) {
                                        current.onCompleted();
                                    }
                                }).create().show();
                    }

                    @Override
                    public void onFailure() {
                        current.onCompleted();
                    }
                });
            }
        });
    }

    private WorkNode getShowH5Node() {
        return (WorkNode.build(NODE_CHECK_H5, new Worker() {
            @Override
            public void doWork(final Node current) {
                Utils.fakeRequest("http://www.api3.com", new HttpCallBack() {
                    @Override
                    public void onOk() {
                        startActivityForResult(new Intent(AfterActivity.this, TestH5Activity.class), REQUEST_CODE_H5);
                    }

                    @Override
                    public void onFailure() {
                        current.onCompleted();
                    }
                });
            }
        }));
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        switch (requestCode) {
            case REQUEST_CODE_H5:
                workFlow.continueWork();
                break;
            default:
                break;
        }
    }
}
複製代碼

通過上述重構,如今的首頁流程:

進入首頁要作的幾件事之間相互無關聯,它們的位置能夠任意切換,只需改變id大小即可輕鬆調整它們的執行順序.
想要加入或者插入節點無需改動原有邏輯.

項目源碼傳送門

實現思路:

設計每一個工做節點

1.我但願每一個任務間彼此獨立,只關心本身的事情是否完成,我把它抽象成一個節點,每一個節點只有本身的節點id 和完成的方法:

public interface Node {
    /** * 節點id * * @return 當前節點id */
    int getId();
    /** * 任務完成時觸發 */
    void onCompleted();
}
複製代碼

至於爲何要提供id,後面會講到.

咱們再來看看它的實現類WorkNode的核心代碼:

public class WorkNode implements Node {
    /** * 節點id */
    private int nodeId;

    /** * 節點工做者 */
    private Worker worker;

    private WorkCallBack callBack;

  	public static WorkNode build(int nodeId, Worker worker) {
        return new WorkNode(nodeId, worker);
    }

    /** * @param worker 調用者傳入，即真正執行要作的事情 */
    public WorkNode(int nodeId, Worker worker) {
        this.nodeId = nodeId;
        this.worker = worker;
    }

    /** * 由workFlow來決定調用 * * @param callBack 當調用onCompleted 以後回調給WorkFlow */
    void doWork(WorkCallBack callBack) {
        this.callBack = callBack;
        worker.doWork(this);
    }

    @Override
    public int getId() {
        return nodeId;
    }

    @Override
    public void onCompleted() {
        if (null != callBack) {
            callBack.onWorkCompleted();
        }
    }

    interface WorkCallBack {

        /** * 當前任務完成 */
        void onWorkCompleted();

    }
}
複製代碼

構造方法中傳入了節點id,和Worker, 這個Worker的doWork方法的實現就是咱們這個節點真正要作的事情:

public interface Worker {
    /** * 執行任務 * * @param current 當前節點 */
    void doWork(Node current);

}
複製代碼

至此咱們回看下demo中對WorkNode的構建:

private WorkNode getFirstAdNode() {
        return WorkNode.build(NODE_FIRST_AD, new Worker() {
            @Override
            public void doWork(final Node current) {
                Utils.fakeRequest("http://www.api1.com", new HttpCallBack() {
                    @Override
                    public void onOk() {
                        new AlertDialog.Builder(AfterActivity.this)
                                .setTitle("這是一條有態度的廣告")
                                .setPositiveButton("我看完了", null)
                                .setOnDismissListener(new DialogInterface.OnDismissListener() {
                                    @Override
                                    public void onDismiss(DialogInterface dialogInterface) {
                                        //僅僅只需關心本身是否完成，下一個節點會自動執行
                                        current.onCompleted();
                                    }
                                }).create().show();
                    }

                    @Override
                    public void onFailure() {
                        //僅僅只需關心本身是否完成，下一個節點會自動執行
                        current.onCompleted();
                    }
                });
            }
        });
    }
複製代碼

是否是很清晰?節點只須要關心本身是否作完了,調用完onCompleted以後,一切與我無關了,後續作什麼就交給WorkFlow去處理了.

那節點的doWork方法是何時被調用的呢? 它內部是怎麼安排工做的呢?,咱們來設計WorkFlow.

設計工做流:

首先做爲全部節點的管理者,固然要把它們存下來,用什麼數據結構來存呢?回顧一下個人需求: 能夠靈活控制節點的執行順序, so...通過反覆篩選,我最終選擇了SparseArray來存放咱們全部的節點,由於咱們爲每一個節點提供id做爲key:

一來能夠提升代碼可讀性.
二來,SparseArray內部是數組實現的,並且是按照key的大小升序排列的,基於這個特性,咱們只須要改變定義Key值的大小關係就能夠改變它們在數組中的順序.

若是你對SparseArray 的原理不是特別瞭解,能夠參考個人上一篇文章:

SparseArray 那些事兒（帶給你更細緻的分析）

咱們再來看看用SparseArray來實現的WorkFlow:

public class WorkFlow {

    private SparseArray<WorkNode> flowNodes;

    public WorkFlow(SparseArray<WorkNode> flowNodes) {
        this.flowNodes = flowNodes;
    }

    /** * 開始工做，默認從第一個節點 */
    public void start() {
        startWithNode(flowNodes.keyAt(0));
    }

    /** * 基於某個節點Id 開始工做 * * @param startNodeId 節點id */
    public void startWithNode(int startNodeId) {
        final int startIndex = flowNodes.indexOfKey(startNodeId);
        WorkNode startNode = flowNodes.valueAt(startIndex);
        startNode.doWork(new WorkNode.WorkCallBack() {
            @Override
            public void onWorkCompleted() {
                findAndExecuteNextNodeIfExist(startIndex);
            }
        });
    }

    private void findAndExecuteNextNodeIfExist(int startIndex) {
        final int nextIndex = startIndex + 1;
        final WorkNode nextNode = flowNodes.valueAt(nextIndex);
        if (null != nextNode) {
            nextNode.doWork(new WorkNode.WorkCallBack() {
                @Override
                public void onWorkCompleted() {
                    findAndExecuteNextNodeIfExist(nextIndex);
                }
            });
        }
    }
    
}
複製代碼

咱們在demo中調用的start()的方法,其實內部調用的是 startWithNode 方法,這個方法接收一個參數 startNodeId ,也就是咱們構建節點的id,咱們在 SparseArray 中找到節點,直接開始執行.
當咱們在節點內部調用完 onCompleted 方法以後, 會直接回調 onWorkCompleted 方法,此時咱們再看看是否有下一個節點,當有下一個節點以後,一直遞歸到下一個沒有節點爲止.

至此,咱們原理基本分析完成,經過內部 SparseArray的設計,咱們能夠靈活從任意節點開始執行,外部的WorkFlow就是一個全局的管理者,咱們能夠拓展不少其餘功能,好比 continueWork() :當咱們在節點之外但願讓流程繼續執行下去的時候(參考Demo的 onActivityResult), revert():回退到上一節點等等

總結:

WorkFlow,很好的接耦了各個次序任務直接的相互依賴,提升了開發效率
它也很好的提升了代碼的可維護性和可讀性,很是便於後來新次序任務的拓展