应用模板代码地址：https://github.com/thfhongfeng/AndroidAppTemplate
App最核心的东西就是数据，因此数据请求框架是App必不可少的，也是最重要的一个组件架构。
常用的数据主要有两种：文本数据，文件数据。
依据于这两种数据的处理，数据请求框架的请求接口也就顺理成章的包括了至少下面几个：
1. 文本的数据请求（文本以Json方式组织）
2. 文件的上传请求
3. 文件的下载请求
4. 网络附属信息的获取与设置（cookies等）
本应用模板的数据请求框架的实现主要在tool模块的request文件夹中。
69FQB03ZNN9V9K2QUD)SZ6H.png
请求框架目录分为四部分：
1. 请求接口及本地化封装实体（最外层接口及实体）
2. 具体实现（impl文件夹）
3. 拦截器（interceptor文件夹）
4. 回调（callback文件夹）
请求接口IRequestManager：
public interface IRequestManager {
String SESSION_ID = "JSESSIONID";
String COOKIE_KEY = "Cookie";
String MOBILE_MODEL_KEY = "mobileModel";
void setJsonRequest(@NonNull RequestBean requestBean,
@NonNull IResponseListener.OnResponseListener listener);
void setDownloadRequest(@NonNull DownloadRequestBean requestBean, @NonNull IResponseListener.OnDownloadListener listener);
void setUploadRequest(@NonNull UploadRequestBean requestBean, @NonNull IResponseListener.OnUploadListener processListener,
@NonNull IResponseListener.OnResponseListener responseListener);
void cancelBySign(Object sign);
void cancelAll();
void addGlobalSessionCookie(HashMap<String, String> headerMap);
void removeGlobalSessionCookie(List<String> keyList);
Map<String, String> getSessionCookie();
String getSessionId();
void setSessionId(String sessionId);
void clearCookie();
enum RequestType {
STRING, // stringRequest
UPLOAD, // uploadRequest
DOWNLOAD, // downloadRequest
BITMAP // bitmapRequest
}
enum ActionType {
COMMON, // common
RETRY_AFTER_RE_LOGIN, // retry after re-login
RETRY_WHEN_ERROR // retry when error
}
}
使用者通过RequestManager获取具体的请求框架管理者实体，而具体请求管理者通过实现IRequestManager来为使用者提供服务。这是一个典型的工厂模式。使用者需要在初始化请求框架的时候提供一个RequestManager的工厂给框架。这个工厂类通过配置APP_THIRD_DATA_SOURCE_PROVIDER来确定使用哪个具体的请求框架实现者，从而做到请求框架第三方库的可替代性。
public interface IRequestManagerFactory {
IRequestManager makeRequestManager(Context context, HashMap<String, String> head);
}
public static void init(Context context, HashMap<String, String> head, @NonNull IRequestManagerFactory factory) {
if (context != null) {
mApplicationContext = context;
} else {
mApplicationContext = AppUtils.getApplication();
}
mRequestManager = factory.makeRequestManager(context, head);
mLoadingRequestMap = new HashMap<>();
mErrorRequestMap = new HashMap<>();
}
RequestManager.init(this, new IRequestManagerFactory() {
@Override
public IRequestManager makeRequestManager(Context context, HashMap<String, String> head) {
switch (com.pine.config.BuildConfig.APP_THIRD_DATA_SOURCE_PROVIDER) {
case "local":
return DbRequestManager.getInstance().init(context, head, new IDbRequestServer() {
@Override
public DbResponse request(Bundle bundle) {
return RouterManager.getInstance(ConfigKey.BUNDLE_DB_SEVER_KEY).callDataCommandDirect(mApplication,
RouterDbServerCommand.callDbServerCommand, bundle);
}
});
default:
switch (BuildConfig.APP_THIRD_HTTP_REQUEST_PROVIDER) {
case "nohttp":
return NoRequestManager.getInstance().init(context, head);
default:
return NoRequestManager.getInstance().init(context, head);
}
}
}
});
需要说明的是：本框架的网络请求实际上只实现了一个基于nohttp的三方库网络请求（以后补充），local方式是为了方便demo演示，而使用本地数据模拟的网络请求。从这里也可以看出本框架的解耦性：即不关注数据来源，网络的也好，本地的也好，都可以通过这个框架来请求（只要给出实现）；不关注具体的第三方实现库（nohttp也好，其它的也好，只要在impl中继承IRequestManager做好实现即可）。
请求框架流程图：
请求框架流程图.png
登陆请求响应拦截器
请求响应的登陆判断基本上是app必备要素（很多请求都是需要登陆的，而未登陆或者session失效等会导致请求响应401），也比较典型。这个就可以通过请求响应拦截器来处理。
- 首先，在LoginApplication中为请求框架添加了一个LoginResponseInterceptor登陆请求响应拦截器，也就是说所有的请求响应都会先被这个拦截器做拦截过滤，只有符合条件的请求响应才能通过（当服务端请求响应告诉客户端需要登陆时，客户端应该进行的通用操作：比如跳到登陆界面等）。
public class LoginApplication extends BaseApplication {
private final static String TAG = LogUtils.makeLogTag(LoginApplication.class);
public static void attach() {
switch (BuildConfig.APP_THIRD_DATA_SOURCE_PROVIDER) {
case "local":
break;
default:
RequestManager.addGlobalResponseInterceptor(new LoginResponseInterceptor());
break;
}
}
}
- 在各类请求得到请求响应后，先交给LoginResponseInterceptor进行处理。
@Override
public boolean onIntercept(int what, RequestBean requestBean, Response response) {
if (requestBean.getCallback() instanceof LoginCallback) {
mIsReLoginProcessing = false;
if (!response.isSucceed() && what == LoginCallback.RE_LOGIN_CODE) {
LoginApplication.setLogin(false);
if (!tryToSendReLogin()) { // 发出自动登录失败
flushAllNoAuthRequest();
mNoAuthRequestMap.clear();
return false;
}
return true;
} else if (what == LoginCallback.RE_LOGIN_CODE) {
String res = (String) response.getData();
try {
JSONObject jsonObject = new JSONObject(res);
if (jsonObject == null || !jsonObject.optBoolean(LoginConstants.SUCCESS, false)) {
mPerReLoginCount = 0;
reloadAllNoAuthRequest();
}
} catch (JSONException e) {
}
}
} else if (requestBean.getRequestType() == IRequestManager.RequestType.STRING && requestBean.isReloadForNoAuthWhenReLogin()) {
if (response.getResponseCode() == ResponseCode.NOT_LOGIN) { // 拦截401错误
if (mNoAuthRequestMap != null &&
!mNoAuthRequestMap.containsKey(requestBean.getKey())) {
mNoAuthRequestMap.put(requestBean.getKey(), requestBean);
}
if (!mIsReLoginProcessing) {
LoginApplication.setLogin(false);
if (!tryToSendReLogin()) { // 发出自动登录失败
flushAllNoAuthRequest();
mNoAuthRequestMap.clear();
}
}
return true;
}
}
if (IRequestManager.ActionType.RETRY_AFTER_RE_LOGIN == requestBean.getActionType()) {
if (mNoAuthRequestMap != null &&
mNoAuthRequestMap.containsKey(requestBean.getKey())) {
mNoAuthRequestMap.remove(requestBean);
}
}
return false;
}
登陆请求响应流程图：
登陆请求响应流程.png
对于登陆请求：
- 正常的登陆请求，不做处理，直接通过。
- 重登陆请求：登陆失败---在次数允许范围内尝试再次重登陆，如果发出请求失败（次数超限，请求数据不合规等），则通过flushAllNoAuthRequest将所有未授权的非登陆请求响应（mNoAuthRequestMap中保存的RequestBean）返回给调用者，并clear掉这些请求；如果发出请求成功，则直接拦截，等待本次重登陆请求响应。登陆成功---重新发出之前需要授权而失败的非登陆请求。
对于非登陆请求：
如果需要登陆，但当前不是登陆状态，服务端返回401，将该请求添加到mNoAuthRequestMap中，并发出重登陆请求。同样的，发送失败，则通过flushAllNoAuthRequest将所有未授权的非登陆请求响应（mNoAuthRequestMap中保存的RequestBean）返回给调用者，并clear掉这些请求；如果发出请求成功，则直接拦截，等待本次重登陆请求响应。登陆成功---重新发出之前需要授权而失败的非登陆请求。
网友评论