App開發：模擬服務器數據接口 - MockApi
App開發：模擬服務器數據接口 - MockApi
為了方便app開發過程中，不受服務器接口的限制，便於客戶端功能的快速測試，可以在客戶端實現一個模擬服務器數據接口的MockApi模塊。本篇文章就嘗試為使用gradle的android項目設計實現MockApi。
需求概述
在app開發過程中，在和服務器人員協作時，一般會第一時間確定數據接口的請求參數和返回數據格式，然後服務器人員會盡快提供給客戶端可調試的假數據接口。不過有時候就算是假數據接口也來不及提供，或者是接口數據格式來回變動——很可能是客戶端展示的原因，這個是產品設計決定的，總之帶來的問題就算服務器端的開發進度會影響客戶端。
所以，如果可以在客戶端的正常項目代碼中，自然地（不影響最終apk）添加一種模擬服務器數據返回的功能，這樣就可以很方便的在不依賴服務器的情況下展開客戶端的開發。而且考慮一種情況，為了測試不同網絡速度，網絡異常以及服務器錯誤等各種“可能的真實數據請求的場景”對客戶端UI交互的影響，我們往往需要做很多手動測試——千篇一律！如果本地有一種控制這種服務器響應行為的能力那真是太好了。
本文將介紹一種為客戶端項目增加模擬數據接口功能的方式，希望能減少一些開發中的煩惱。
設計過程
下面從分層設計、可開關模擬模塊、不同網絡請求結果的制造這幾個方面來闡述下模擬接口模塊的設計。
為了表達方便，這裏要實現的功能表示為“數據接口模擬模塊”，對應英文為MockDataApi，或簡寫為MockApi，正常的數據接口模塊定義為DataApi。
分層思想
說到分層設計，MVC、MVP等模式一定程度上就起到了對代碼所屬功能的一個劃分。分層設計簡單的目標就是讓項目代碼更加清晰，各層相互獨立，好處不多說。
移動app的邏輯主要就是交互邏輯，然後需要和服務器溝通數據。所以最簡單的情形下可以將一個功能（比如一個列表界面）的實現分UI層和數據訪問層。
下面將數據訪問層表述為DataApi模塊，DataApi層會定義一系列的接口來描述不同類別的數據訪問請求。UI層使用這些接口來獲取數據，而具體的數據訪問實現類就可以在不修改UI層代碼的情況下進行替換。
例如，有一個ITaskApi定義了方法List<Task> getTasks()，UI層一個界面展示任務列表，那麽它使用ITaskApi來獲取數據，而具體ITaskApi的實現類可以由DataApi層的一個工廠類DataApiManager來統一提供。
有了上面的分層設計，就可以為UI層動態提供真實數據接口或模擬數據接口。
模擬接口的開關
可能大家都經歷過在UI層代碼裏臨時寫一些假數據得情況。比如任務列表界面，開發初，可以寫一個mockTaskData()方法來返回一個List<Task>
不能讓“模擬數據”的代碼到處散亂，在分層設計的方式下，可以將真實的數據接口DataApi和模擬數據接口MockDataApi分別作為兩個數據接口的實現模塊，這樣就可以根據項目的構建類型來動態提供不同的數據接口實現。
實現MockDataApi的動態提供的方法也不止一種。
一般的java項目可以使用“工廠模式+反射”來動態提供不同的接口實現類，再專業點就是依賴註入——DI框架的使用了。
目前gradle是java的最先進的構建工具，它支持根據buildType來分別指定不同的代碼資源，或不同的依賴。
可以在一個單獨的類庫module（就是maven中的項目）中來編寫各種MockDataApi的實現類，然後主app module在debug構建時添加對它的依賴，此時數據接口的提供者DataApiManager可以向UI層返回這些mock類型的實例。
為了讓“正常邏輯代碼”和mock相關代碼的關聯盡量少，可以提供一個MockApiManager來唯一獲取各個MockDataApi的實例。然後在debug構建下的MockApiManager會返回提供了mock實現的數據接口實例，而release構建時MockApiManager會一律返null。
不同請求結果的模擬
MockApi在多次請求時提供不同的網絡請求結果，如服務器錯誤，網絡錯誤，成功等，並模擬出一定的網絡延遲，這樣就很好的滿足了UI層代碼的各種測試需求。
為了達到上述目標，定義一個接口IMockApiStrategy來表示對數據請求的響應策略，它定義了方法onResponse(int callCount)。根據當前請求的次數callCount，onResponse()會得到不同的模擬響應結果。很明顯，可以根據測試需要提供不同的請求響應策略，比如不斷返回成功請求，或者不斷返回錯誤請求，或輪流返回成功和錯誤等。
關鍵代碼解析
下面就給出各個部分的關鍵代碼，來說明以上所描述的MockDataApi模塊的實現。
UI層代碼
作為示例，界面MainActivity是一個“任務列表”的展示。任務由Task類表示：
public class Task {
public String name;
}界面MainActivity使用一個TextView來顯示“加載中、任務列表、網絡錯誤”等效果，並提供一個Button來點擊刷新數據。代碼如下：
public class MainActivity extends Activity {
private TextView tv_data;
private boolean requesting = false;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
tv_data = (TextView) findViewById(R.id.tv_data);
getData();
}
private void getData() {
if (requesting) return;
requesting = true;
ITaskApi api = DataApiManager.ofTask();
if (api != null) {
api.getTasks(new DataApiCallback<List<Task>>() {
@Override
public void onSuccess(List<Task> data) {
// 顯示數據
StringBuilder sb = new StringBuilder("請求數據成功：\n");
for (int i = 0; i < data.size(); i++) {
sb.append(data.get(i).name).append("\n");
}
tv_data.setText(sb.toString());
requesting = false;
}
@Override
public void onError(Throwable e) {
// 顯示錯誤
tv_data.setText("錯誤：\n" + e.getMessage());
requesting = false;
}
@Override
public void onStart() {
// 顯示loading
tv_data.setText("正在加載...");
}
});
}
}
public void onRefreshClick(View view) {
getData();
}
}在UI層代碼中，使用DataApiManager.ofTask()獲得數據訪問接口的實例。
考慮到數據請求會是耗時的異步操作，這裏每個數據接口方法接收一個DataApiCallback<T> 回調對象，T是將返回的數據類型。
public interface DataApiCallback<T> {
void onSuccess(T data);
void onError(Throwable e);
void onStart();
}接口DataApiCallback定義了數據接口請求數據開始和結束時的通知。
DataApiManager
根據分層設計，UI層和數據訪問層之間的通信就是基於DataApi接口的，每個DataApi接口提供一組相關數據的獲取方法。獲取Task數據的接口就是ITaskApi：
public interface ITaskApi {
void getTasks(DataApiCallback<List<Task>> callback);
}UI層通過DataApiManager來獲得各個DataApi接口的實例。也就是在這裏，會根據當前項目構建是debug還是release來選擇性提供MockApi或最終的DataApi。
public class DataApiManager {
private static final boolean MOCK_ENABLE = BuildConfig.DEBUG;
public static ITaskApi ofTask() {
if (MOCK_ENABLE) {
ITaskApi api = MockApiManager.getMockApi(ITaskApi.class);
if (api != null) return api;
}
return new NetTaskApi();
}
}當MOCK_ENABLE為true時，會去MockApiManager檢索一個所需接口的mock實例，如果沒找到，會返回真實的數據接口的實現，上面的NetTaskApi就是。倘若現在服務器還無法進行聯合調試，它的實現就簡單的返回一個服務器錯誤：
public class NetTaskApi implements ITaskApi {
@Override
public void getTasks(DataApiCallback<List<Task>> callback) {
// 暫時沒用實際的數據接口實現
callback.onError(new Exception("數據接口未實現"));
}
}MockApiManager
DataApiManager利用MockApiManager來獲取數據接口的mock實例。這樣的好處是模擬數據接口的相關類型都被“封閉”起來，僅通過一個唯一類型來獲取已知的DataApi的一種（這裏就指mock）實例。這樣為分離出mock相關代碼打下了基礎。
在DataApiManager中，獲取數據接口實例時會根據開關變量MOCK_ENABLE判斷是否可以返回mock實例。僅從功能上看是滿足動態提供MockApi的要求了。不過，為了讓最終release構建的apk中不包含多余的mock相關的代碼，可以利用gradle提供的buildVariant。
buildVariant
使用gradle來構建項目時，可以指定不同的buildType，默認會有debug和release兩個“構建類型”。此外，還可以提供productFlavors來提供不同的“產品類型”，如demo版，專業版等。
每一種productFlavor和一個buildType組成一個buildVariant（構建變種）。
可以為每一個buildType，buildVariant，或productFlavor指定特定的代碼資源。
這裏利用buildType來為debug和release構建分別指定不同的MockApiManager類的實現。
默認的項目代碼是在src/main/java/目錄下，創建目錄/src/debug/java/來放置只在debug構建時編譯的代碼。在/src/release/java/目錄下放置只在release構建時編譯的代碼。
- debug構建時的MockApiManager
public class MockApiManager {
private static final MockApiManager INSTANCE = new MockApiManager();
private HashMap<String, BaseMockApi> mockApis;
private MockApiManager() {}
public static <T> T getMockApi(Class<T> dataApiClass) {
if (dataApiClass == null) return null;
String key = dataApiClass.getName();
try {
T mock = (T) getInstance().mockApis.get(key);
return mock;
} catch (Exception e) {
return null;
}
}
private void initApiTable() {
mockApis = new HashMap<>();
mockApis.put(ITaskApi.class.getName(), new MockTaskApi());
}
private static MockApiManager getInstance() {
if (INSTANCE.mockApis == null) {
synchronized (MockApiManager.class) {
if (INSTANCE.mockApis == null) {
INSTANCE.initApiTable();
}
}
}
return INSTANCE;
}
}靜態方法getMockApi()根據傳遞的接口類型信息從mockApis中獲取可能的mock實例，mockApis中註冊了需要mock的那些接口的實現類對象。
- release構建時的MockApiManager
public class MockApiManager {
public static <T> T getMockApi(Class<T> dataApiClass) {
return null;
}
}因為最終release構建時是不需要任何mock接口的，所以此時getMockApi()一律返回null。也沒有任何和提供mock接口相關的類型。
通過為debug和release構建提供不同的MockApiManager代碼，就徹底實現了MockApi代碼的動態添加和移除。
MockApi的實現
模擬數據接口的思路非常簡單：根據請求的次數callCount，運行一定的策略來不斷地返回不同的響應結果。
響應結果包括“網絡錯誤、服務器錯誤、成功”三種狀態，而且還提供一定的網絡時間延遲的模擬。
IMockApiStrategy
接口IMockApiStrategy的作用就是抽象對請求返回不同響應結果的策略，響應結果由IMockApiStrategy.Response表示。
public interface IMockApiStrategy {
void onResponse(int callCount, Response out);
/**
* Mock響應返回結果，表示響應的狀態
*/
class Response {
public static final int STATE_NETWORK_ERROR = 1;
public static final int STATE_SERVER_ERROR = 2;
public static final int STATE_SUCCESS = 3;
public int state = STATE_SUCCESS;
public int delayMillis = 600;
}
}Response表示的響應結果包含結果狀態和延遲時間。
作為一個默認的實現，WheelApiStrategy類根據請求次數，不斷返回上述的三種結果：
public class WheelApiStrategy implements IMockApiStrategy {
@Override
public void onResponse(int callCount, Response out) {
if (out == null) return;
int step = callCount % 10;
switch (step) {
case 0:
case 1:
case 2:
case 3:
out.state = Response.STATE_SUCCESS;
break;
case 4:
case 5:
out.state = Response.STATE_SERVER_ERROR;
break;
case 6:
case 7:
out.state = Response.STATE_SUCCESS;
break;
case 8:
case 9:
out.state = Response.STATE_NETWORK_ERROR;
break;
}
out.delayMillis = 700;
}
}方法onResponse()的參數out僅僅是為了避免多次創建小對象，對應debug構建，倒也沒太大意義。
BaseMockApi
針對每一個數據訪問接口，都可以提供一個mock實現。比如為接口ITaskApi提供MockTaskApi實現類。
為了簡化代碼，抽象基類BaseMockApi完成了大部分公共的邏輯。
public abstract class BaseMockApi {
protected int mCallCount;
private IMockApiStrategy mStrategy;
private Response mResponse = new Response();
public Response onResponse() {
if (mStrategy == null) {
mStrategy = getMockApiStrategy();
}
if (mStrategy != null) {
mStrategy.onResponse(mCallCount, mResponse);
mCallCount++;
}
return mResponse;
}
protected IMockApiStrategy getMockApiStrategy() {
return new WheelApiStrategy();
}
protected void giveErrorResult(final DataApiCallback<?> callback, Response response) {
Action1<Object> onNext = null;
AndroidSchedulers.mainThread().createWorker().schedule(new Action0() {
@Override
public void call() {
callback.onStart();
}
});
switch (response.state) {
case Response.STATE_NETWORK_ERROR:
onNext = new Action1<Object>() {
@Override
public void call(Object o) {
callback.onError(new IOException("mock network error."));
}
};
break;
case Response.STATE_SERVER_ERROR:
onNext = new Action1<Object>() {
@Override
public void call(Object o) {
callback.onError(new IOException("mock server error."));
}
};
break;
}
if (onNext != null) {
Observable.just(10086)
.delay(response.delayMillis, TimeUnit.MILLISECONDS)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(onNext);
}
}
public <T> void giveSuccessResult(final Func0<T> dataMethod, final DataApiCallback<T> callback, final Response response) {
AndroidSchedulers.mainThread().createWorker().schedule(new Action0() {
@Override
public void call() {
Observable.create(new Observable.OnSubscribe<T>() {
@Override
public void call(Subscriber<? super T> subscriber) {
Log.