去年10月底換到了新公司，做移動(dòng)研發(fā)組的負(fù)責(zé)人，剛開(kāi)始接手android項(xiàng)目時(shí)，發(fā)現(xiàn)該項(xiàng)目真的是一團(tuán)糟。首先是其架構(gòu)，是按功能模塊進(jìn)行劃分的，本來(lái)按模塊劃分也挺好的，可是，他卻分得太細(xì)，總共分為了17個(gè)模塊，而好幾個(gè)模塊也就只有兩三個(gè)類而已。但應(yīng)用本身其實(shí)比較簡(jiǎn)單，要按功能模塊來(lái)分的話，最多五個(gè)模塊就夠了。另外，有好多模塊劃分也很模糊，也有很多類按其功能其實(shí)可以屬于多個(gè)模塊的，也有些類定義不明確，做了不該做的事。有時(shí)候，我要找一個(gè)界面的Activity，按照其功能應(yīng)該屬于A模塊的，可是在A模塊里卻找不到，于是，我只好去AndroidManifest文件里找了，找到才發(fā)現(xiàn)原來(lái)在B模塊里。也有時(shí)候，我要找另一個(gè)界面的Activity，可我看遍了所有模塊，也沒(méi)看出這個(gè)界面應(yīng)該屬于哪個(gè)模塊，沒(méi)法子，又只能去AndroidManifest文件里找了，找到才發(fā)現(xiàn)竟然在C模塊里。代碼也是又亂又臭，導(dǎo)致出現(xiàn)一大堆bug又不好找，改好一個(gè)bug又出現(xiàn)另一個(gè)。整個(gè)項(xiàng)目從架構(gòu)到代碼都是又臭又亂，開(kāi)發(fā)人員只是不停地改bug，根本沒(méi)法做新功能，更別談擴(kuò)展了。當(dāng)時(shí)，公司已經(jīng)有為不同客戶定制化app的需求，而現(xiàn)有的架構(gòu)完全無(wú)法滿足這樣的需求。因此，我決定重構(gòu)，搭建一個(gè)易維護(hù)、易擴(kuò)展、可定制的項(xiàng)目。

我將項(xiàng)目分為了四個(gè)層級(jí)：模型層、接口層、核心層、界面層。模型層定義了所有的模型；接口層封裝了服務(wù)器提供的API；核心層處理所有業(yè)務(wù)邏輯；界面層就處理界面的展示。幾個(gè)層級(jí)之間的關(guān)系如下圖所示：

下面展開(kāi)說(shuō)明具體的每個(gè)層次：

接口層

接口層封裝了網(wǎng)絡(luò)底層的API，并提供給核心層調(diào)用。剛開(kāi)始，為了簡(jiǎn)單，該層的核心類我只定義了4個(gè)：

1. PostEngine，請(qǐng)求引擎類，對(duì)請(qǐng)求的發(fā)送和響應(yīng)結(jié)果進(jìn)行處理；
2. Response，響應(yīng)類，封裝了Http請(qǐng)求返回的數(shù)據(jù)結(jié)構(gòu)；
3. Api，接口類，定義了所有接口方法；
4. ApiImpl，接口實(shí)現(xiàn)類，實(shí)現(xiàn)所有接口方法。

PostEngine將請(qǐng)求封裝好發(fā)送到服務(wù)器，并對(duì)響應(yīng)結(jié)果的json數(shù)據(jù)轉(zhuǎn)化為Response對(duì)象返回。Response其實(shí)就是響應(yīng)結(jié)果的json數(shù)據(jù)實(shí)體類，json數(shù)據(jù)是有固定結(jié)構(gòu)的，分為三類，如下：

{"event": "0", "msg": "success"}
{"event": "0", "msg": "success", "obj":{...}}
{"event": "0", "msg": "success", "objList":[{...}, {...}], "currentPage": 1, "pageSize": 20, "maxCount": 2, "maxPage": 1}

event為返回碼，0表示成功，msg則是返回的信息，obj是返回的單個(gè)數(shù)據(jù)對(duì)象，objList是返回的數(shù)據(jù)對(duì)象數(shù)組，currentPage表示當(dāng)前頁(yè)，pageSize則表示當(dāng)前頁(yè)最多對(duì)象數(shù)量，maxCount表示對(duì)象數(shù)據(jù)總量，maxPage表示總共有多少頁(yè)。根據(jù)此結(jié)構(gòu)，Response基本的定義如下：

public class Response<T> {
    private String event;
    private String msg;
    private T obj;
    private T objList;
    private int currentPage;
    private int pageSize;
    private int maxCount;
    private int maxPage;

    //getter和setter方法
    ...    
}

每個(gè)屬性名稱都要與json數(shù)據(jù)對(duì)應(yīng)的名稱相一致，否則無(wú)法轉(zhuǎn)化。obj和objList用泛型則可以轉(zhuǎn)化為相應(yīng)的具體對(duì)象了。

Api接口類定義了所有的接口方法，方法定義類似如下：

public Response<Void> login(String loginName, String password);
public Response<VersionInfo> getLastVersion();
public Response<List<Coupon>> listNewCoupon(int currentPage, int pageSize);

ApiImpl則實(shí)現(xiàn)所有Api接口了，實(shí)現(xiàn)代碼類似如下：

@Override
public Response<Void> login(String loginName, String password) {
    try {
        String method = Api.LOGIN;
        List<NameValuePair> params = new ArrayList<NameValuePair>();
        params.add(new BasicNameValuePair("loginName", loginName));
        params.add(new BasicNameValuePair("password", EncryptUtil.makeMD5(password)));
        TypeToken<Response<Void>> typeToken = new TypeToken<Response<Void>>(){};
        return postEngine.specialHandle(method, params, typeToken);
    } catch (Exception e) {
        //異常處理
    }
}

實(shí)現(xiàn)中將請(qǐng)求參數(shù)和返回的類型定義好，調(diào)用PostEngine對(duì)象進(jìn)行處理。
接口層的核心基本上就是這些了。

核心層

核心層介于接口層和界面層之間，主要處理業(yè)務(wù)邏輯，集中做數(shù)據(jù)處理。向上，給界面層提供數(shù)據(jù)處理的接口，稱為Action；向下，調(diào)用接口層向服務(wù)器請(qǐng)求數(shù)據(jù)。向上的Action中定義的方法類似如下：

public void getCustomer(String loginName, CallbackListener<Customer> callbackListener);

這是一個(gè)獲取用戶信息的方法，因?yàn)樾枰蚪涌趯诱?qǐng)求服務(wù)器Api數(shù)據(jù)，所以添加了callback監(jiān)聽(tīng)器，在callback里對(duì)返回的數(shù)據(jù)結(jié)果進(jìn)行操作。CallbackListener就定義了一個(gè)成功和一個(gè)失敗的方法，代碼如下：

public interface CallbackListener<T> {
    /**
     * 請(qǐng)求的響應(yīng)結(jié)果為成功時(shí)調(diào)用
     * @param data  返回的數(shù)據(jù)
     */
    public void onSuccess(T data);

    /**
     * 請(qǐng)求的響應(yīng)結(jié)果為失敗時(shí)調(diào)用
     * @param errorEvent 錯(cuò)誤碼
     * @param message    錯(cuò)誤信息
     */
    public void onFailure(String errorEvent, String message);
}

接口的實(shí)現(xiàn)基本分為兩步：

1. 參數(shù)檢查，檢查參數(shù)的合法性，包括非空檢查、邊界檢查、有效性檢查等；
2. 使用異步任務(wù)調(diào)用接口層的Api，返回響應(yīng)結(jié)果。

需要注意的是，Action是面向界面的，界面上的數(shù)據(jù)可能需要根據(jù)不同情況調(diào)用不同的Api。
后續(xù)擴(kuò)展可以在這里添加緩存，但也要視不同情況而定，比如有些變化太快的數(shù)據(jù)，添加緩存就不太適合了。

界面層

界面層處于最上層，其核心就是負(fù)責(zé)界面的展示。
因?yàn)楣居袨椴煌虘舳ㄖ撇煌琣pp的需求，因此，這里就需要建立多個(gè)app的界面，這是一個(gè)很麻煩的事情，還好，Android Studio提供了很方便的方法可以大大減少工作量，主要通過(guò)設(shè)置Gradle，不同app可以添加不同的productFlavors。
界面層package的定義我也并不按照舊版的功能模塊劃分，而根據(jù)不同類型劃分，主要分為以下幾個(gè)包：

其中，activity、adapter、fragment各自都有一個(gè)基類，做統(tǒng)一的處理，比如定義了一些共用的常量、對(duì)象和方法等。
界面層是最復(fù)雜，最容易變得混亂不堪，最容易出問(wèn)題的層級(jí)。所以，從架構(gòu)到代碼，很多東西都需要設(shè)計(jì)好，以及規(guī)范好，才能保證程序易維護(hù)、易擴(kuò)展。后續(xù)的文章里將會(huì)詳細(xì)分享下我在這方面的經(jīng)驗(yàn)。

模型層

模型層橫跨所有層級(jí)，封裝了所有數(shù)據(jù)實(shí)體類，基本上也是跟json的obj數(shù)據(jù)一致的，在接口層會(huì)將obj轉(zhuǎn)化為相應(yīng)的實(shí)體類，再通過(guò)Action傳到界面層。另外，模型層還定義了一些常量，比如用戶狀態(tài)、支付狀態(tài)等。在Api里返回的是用1、2、3這樣定義的，而我則用枚舉類定義了這些狀態(tài)。用枚舉類定義，就可以避免了邊界的檢查，同時(shí)也更明了，誰(shuí)會(huì)記得那么多1、2、3都代表什么狀態(tài)呢。然而用枚舉類定義的話，就必須能將1、2、3轉(zhuǎn)化為相應(yīng)的枚舉常量。這里，我提供兩種實(shí)現(xiàn)方式：

1. 使用gson的@SerializedName標(biāo)簽，比如0為FALSE，1為TRUE，則可以如下定義：

public enum BooleanType {
    @SerializedName("0")
    FALSE,
    @SerializedName("1")
    TRUE
}

1. 通過(guò)定義一個(gè)value，如下：

public enum BooleanType {
    FALSE("0"),
    TRUE("1");

    private String value;

    BooleanType(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }
}

通過(guò)gson的方式，直接訪問(wèn)TRUE或FALSE就會(huì)自動(dòng)序列化為1或0；如果通過(guò)第二種方式，因?yàn)闆](méi)有序列化，則需要通過(guò)getValue方式獲取1或0。

結(jié)束

以上就是最基本的架構(gòu)了，講得比較簡(jiǎn)單，只列了幾個(gè)核心的東西。并沒(méi)有進(jìn)一步去擴(kuò)展，擴(kuò)展是下一步的事情了，后續(xù)的文章里會(huì)慢慢展開(kāi)。