QuickAF中使用Volley進(jìn)行網(wǎng)絡(luò)連接，使用Gson來解析響應(yīng)數(shù)據(jù)。為了更方便地執(zhí)行REST API網(wǎng)絡(luò)請(qǐng)求，QuickAF對(duì)Volley+Gson進(jìn)行了簡(jiǎn)單的封裝。
接口請(qǐng)求與響應(yīng)設(shè)計(jì)
接口
REST接口是基于HTTP協(xié)議的，一個(gè)接口的定義包含請(qǐng)求地址，請(qǐng)求方法，請(qǐng)求參數(shù)，響應(yīng)信息。請(qǐng)求地址為一個(gè)URL，由基地址和接口路徑和查詢字符串組成。比如http://127.0.0.1:8080/meituan/api/1.0/user/login?token=xxxxxxx; http://127.0.0.1:8080/meituan/api/1.0/ 為基地址，一套api，其基地址是相同的。1.0為接口版本，user/login為接口路徑，token=xxxxxx為查詢字符串。請(qǐng)求方法有GET/POST/PUT/DELETE等。QuickAF將接口地址抽象為IUrl接口
public interface IUrl {
/**
* return http method, see {@link com.android.volley.Request.Method}
*
* @return http method
* @see com.android.volley.Request.Method
*/
int getMethod();
/**
* return the full url
*
* @return
*/
String getUrl();
/**
* set query string to url.
*
* @param query query string, it a request parameter of string format usually
*/
void setQuery(String query);
}
請(qǐng)求
一般來說接口的請(qǐng)求比較簡(jiǎn)單，如果請(qǐng)求是application/json，將請(qǐng)求對(duì)象轉(zhuǎn)為json字符串即可。但是實(shí)際當(dāng)中，仍然有許多接口使用的還是application/x-www-form-urlencoded，這種方式簡(jiǎn)單，而且適用于網(wǎng)頁。QuickAF默認(rèn)以后者來提交http請(qǐng)求，并且支持以下兩種請(qǐng)求格式
- 鍵值對(duì)，這也是早期使用最多的，通過Map來存儲(chǔ)請(qǐng)求參數(shù)。
- 對(duì)象，通過反射機(jī)制將對(duì)象的屬性及屬性值轉(zhuǎn)化對(duì)鍵值對(duì)，具有很高的可擴(kuò)展性，一旦接口有變更，比如接口要求添加uuid參數(shù)，可以非常方便的修改請(qǐng)求基類來滿足業(yè)務(wù)需求，QuickAF建議使用這種方式來封裝請(qǐng)求。
通常在REST API中包含appKey, secret, uuid等全局請(qǐng)求參數(shù)，QuickAF的sample app中定義的請(qǐng)求基類如下：
public class BaseRequest implements java.io.Serializable {
public String appKey;
public String secret;
public String version;
public String uuid;
}
具體的業(yè)務(wù)API只需要繼承BaseRequest，然后添加具體的業(yè)務(wù)請(qǐng)求參數(shù)，比如注冊(cè)的請(qǐng)求
public class RegisterRequest extends BaseRequest {
public String phone;
public String code;
public String password;
}
對(duì)于GET請(qǐng)求，將請(qǐng)求對(duì)象轉(zhuǎn)為查詢字符串附在url中，對(duì)于POST請(qǐng)求，則將請(qǐng)求對(duì)象寫入body中。
響應(yīng)
REST API接口響應(yīng)一般包含狀態(tài)碼(status)，提示信息(message)及業(yè)務(wù)對(duì)象(data)，需要經(jīng)過json工具將其轉(zhuǎn)為對(duì)象，這個(gè)對(duì)象我們姑且稱之為接口對(duì)象。偽代碼如下：
class MyResponse {
int code;//業(yè)務(wù)響應(yīng)狀態(tài)碼
String message;//業(yè)務(wù)響應(yīng)信息，比如投票失敗
Object data;//業(yè)務(wù)響應(yīng)對(duì)象，比如登錄，返回的是一個(gè)User對(duì)象
}
其實(shí)業(yè)務(wù)模塊往往關(guān)心的只有業(yè)務(wù)對(duì)象(data)，因?yàn)閷?duì)于業(yè)務(wù)操作不成功的處理，可以在基類中統(tǒng)一處理。在QuickAF中，將接口對(duì)象抽象為IBaseResponse接口。
public interface IBaseResponse<Output> extends java.io.Serializable{
/**
* Return the business data object
*
* @return concrete business data
*/
Output getData();
}
請(qǐng)求任務(wù)
如果我們將請(qǐng)求視為輸入，響應(yīng)視為輸出，那么對(duì)于一次網(wǎng)絡(luò)請(qǐng)求，使用代碼實(shí)現(xiàn)的話，就是：
abstract class MyTask<Input,Output> {
void onSuccess(Output output); // 業(yè)務(wù)請(qǐng)求成功
void onError(RestError error);//業(yè)務(wù)請(qǐng)求失敗
Url getUrl();//業(yè)務(wù)請(qǐng)求地址
}
在QuickAF中，已經(jīng)實(shí)現(xiàn)了網(wǎng)絡(luò)請(qǐng)求與數(shù)據(jù)解析功能，所以對(duì)開發(fā)者來說，只需專注于業(yè)務(wù)接口，即：接口地址，請(qǐng)求對(duì)象，返回的業(yè)務(wù)對(duì)象(data)。業(yè)務(wù)請(qǐng)求成功，在相關(guān)的界面填充業(yè)務(wù)數(shù)據(jù)(data)，請(qǐng)求失敗，給出相應(yīng)的錯(cuò)誤信息(message)。
QuickAF有兩個(gè)執(zhí)行任務(wù)的方法
- 如果輸出為對(duì)象(Output)是一個(gè)對(duì)象，則需調(diào)用load方法，將Output的class傳進(jìn)去。
- 如果輸出為集合(List)，則需調(diào)用load2List方法，將集合中的元素class傳進(jìn)去。
- 自動(dòng)識(shí)別，調(diào)用load方法，無需傳入Output的class。
// method 1
class MyTask<Object, User> {
//... 獲取單個(gè)用戶，輸入為object，輸出為User
}
// 執(zhí)行任務(wù)
new MyTask().load(/*request*/null, User.class, /*don't load cache*/false);
// method 2 for List
class MyListTask<Object, List<User>> {
//... 獲取用戶列表，輸入為object, 輸出為L(zhǎng)ist<User>集合
}
new MyListTask().load2List(null, User.class, /*use cache*/true);
// method 3, auto load
new MyTask().load(null, false);// sampe to load(null, User.class, false)
new MyListTask().load(null, true);// sampe to load2List(null, User.class, false)
進(jìn)階操作
配置接口對(duì)象
接口對(duì)象，一個(gè)app，一般只有一個(gè)。定義如下
public class BaseResponse<Output> implements IBaseResponse {
private static final long serialVersionUID = -3440061414071692254L;
/**
* 狀態(tài)碼
*/
public int code;
/**
* 消息
*/
public String message;
/**
* 數(shù)據(jù)，業(yè)務(wù)對(duì)象
*/
public Output data;
public Output getData() {
return data;
}
}
然后可以在Application.onCreate()中配置。
// typically, you just config volley in Application.onCreate
VolleyConfig config = new VolleyConfig.Builder()
.setBaseResponseClass(WeatherBaseResponse.class)
.build();
VolleyManager.init(getApplicationContext(), config);
如果有喜歡使用OkHttp的同學(xué)，還可配置網(wǎng)絡(luò)連接使用OkHttp，需要寫一個(gè)OkHttpStack繼承自Volley的HurlStack，參考QuickAF示例app中的OkHttpStack.java.sample。
接口統(tǒng)一處理
主要是根據(jù)接口業(yè)務(wù)狀態(tài)碼進(jìn)行處理。比如定義業(yè)務(wù)操作成功，響應(yīng)碼為0，那么不為0的時(shí)候，就不應(yīng)該解析業(yè)務(wù)對(duì)象，轉(zhuǎn)入錯(cuò)誤分支。
protected abstract class AppBaseTask<Input, Output> extends RequestObjectTask<Input, Output> {
@Override
public boolean onInterceptor(IBaseResponse response) throws Exception {
if (response instanceof BaseResponse) {
BaseResponse resp = (BaseResponse) response;
if (0 != resp.code) {
onLogicError(new LogicError(null, resp.code, resp.message));
throw new InterceptorError();
}
}
return false;
}
public void onLogicError(LogicError error) {
if (404 == error.getCode() || 104 == error.getCode()) { {
// LoginActivity.go(MyApplication.instance);
return;
}
onError(new RestError(error));
}
}
數(shù)據(jù)模擬
接口對(duì)象或業(yè)務(wù)對(duì)象類需在mock()方法中給對(duì)象填充模擬值，參考示例工程中BaseInfo.java（這個(gè)類是所有業(yè)務(wù)對(duì)象模型的基類）。
最佳實(shí)踐
- 所有的請(qǐng)求繼承一個(gè)BaseRequest，接口定義的全局請(qǐng)求參數(shù)在BaseRequest中定義
- 一套接口API，定義一個(gè)全局的AppController及AppBaseTask來處理公共的業(yè)務(wù)，比如業(yè)務(wù)攔截。
- 所有的業(yè)務(wù)模型繼承一個(gè)BaseInfo
- 一個(gè)Controller對(duì)應(yīng)一個(gè)界面，應(yīng)繼承AppController，包含若干網(wǎng)絡(luò)請(qǐng)求Task
- 網(wǎng)絡(luò)請(qǐng)求Task回調(diào)作為內(nèi)部interface定義在具體的Controller中。
更多請(qǐng)參考demo app工程
關(guān)于
QuickAF是一個(gè)Android平臺(tái)上的app快速開發(fā)框架，歡迎讀者在github star或fork。本人寫作水平有限，歡迎廣大讀者指正，如有問題，可與我直接聯(lián)系或在我的官方博客中給出評(píng)論。
參考
QuickAF: https://github.com/Jamling/QuickAF
本文永久鏈接： http://www.ieclipse.cn/2017/05/12/Android/quickaf-rest/ 未經(jīng)允許，禁止轉(zhuǎn)載，如有問題，請(qǐng)?jiān)谖业牟┛驮柬撁嫣峤辉u(píng)論。
