App 组件化/模块化之路——如何封装网络请求框架
App 组件化/模块化之路——如何封装网络请求框架
在 App 开发中网络请求是每个开发者必备的开发库,也出现了许多优秀开源的网络请求库。例如
这些网络请求库很大程度上提高程序猿的编码效率。但是随着业务的发展,App 变得越来越大,我们将这些网络请求库加入到项目中直接使用,对我们业务类的入侵是非常强的。如果要进行业务分离时,这些网络请求代码将是一个阻止我们进一步工作的绊脚石。对开发者来说是非常痛苦的。
因此我们构建的网络请求框架要可以解决以下问题:
- 分离业务与网络请求代码
- 网络库可以很容易的被替换
- 网络库可以很方便的复用
所以在 App 组件化/模块化开发架构思路 一文中,我们把网络请求作为内核层的一个组件。
封装第三方网络请求接口
一般来说,目前绝大部分 App 的数据请求都是使用 HTTP 协议,而数据交换的协议使用 json 格式。因此可以封装一个通用的请求接口。(当然还有其他一些协议,例如微信的 mars ,但是封装的思路是一致的,本文为了简单说明,暂时使用通用网络请求框架,不排除以后会对 mars 的封装)
首先预览一下框架结构
IRequest
这个类封装了网络请求的通用接口,定义请求接口 doRequest()
、获取请求连接 getUrl()
、获取请求方法 getHttpMethod()
等。
public interface IRequest {
enum HttpMethod {
GET, POST, PUT, DELETE
}
//... 为了减少代码的篇幅,省略一些对本文说明不重要的片段,本文代码可以在
//https://github.com/wecodexyz/Componentization 获取到
void addParams(Map<String, String> params); String getUrl(); Pair<Integer, String> doRequest(); boolean isSupportCache(); void addHeader(String key, String value); HttpMethod getHttpMethod(); //... 为了减少代码的篇幅,省略一些对本文说明不重要的片段,本文代码可以在
//https://github.com/wecodexyz/Componentization 获取到
}
Request
这个类是个抽象类,对 IRequest
的实现。目前是一个简单封装的实现。
RequestWrapper
这个类是一个泛型类,继承于 Request
并对第三方请求库的封装。例如本文就是对 okhttp
的封装,而泛型 T 对象就是请求得到的具体数据类型。如果要对其他请求库进行封装,就可以参考这个类的实现。
注意这个类封装是纯粹的网络请求,不应该包含业务类相关的代码。否则无解决上文提出的三个问题。
public abstract class RequestWrapper extends Request { //... 为了减少代码的篇幅,省略一些对本文说明不重要的片段,本文代码可以在
//https://github.com/wecodexyz/Componentization 获取到 @Override
public Pair<Integer, String> doRequest() {
Pair<Integer, String> result = new Pair<>(ERROR_NETWORK, "");
okhttp3.Request request = null; if (getHttpMethod() == HttpMethod.POST) {
request = requestBuilder().url(getUrl()).post(requestBody()).build();
} else {
request = requestBuilder().url(getUrlWithParams()).build();
}
try {
Response response = mClient.newCall(request).execute();
if (response.isSuccessful()) {
result = new Pair<>(response.code(), response.body().string());
} else {
result = new Pair<>(response.code(), response.message());
}
} catch (IOException e) {
Log.e(TAG, e.getMessage());
}
return result;
} //... 为了减少代码的篇幅,省略一些对本文说明不重要的片段,本文代码可以在
//https://github.com/wecodexyz/Componentization 获取到 }
关键的代码是在 doRequest()
方法中,该方法实现了网络请求的代码,返回一个 Pair<Integer,String>
对象,该对象的 first
属性是一个请求 code
,用于标识网络请求码(即是网络请求返回的200,404,301等)。而 second
就是网络请求的数据。
BaseTextRequest
这个类就是网络请求框架提供给业务类使用的一个接口。本文一开始就提出来 json 作为交互数据请求的协议。那么此类的封装就有利于业务数据的访问。
public abstract class BaseTextRequest<T> extends RequestWrapper { public BaseTextRequest(Context context) {
super(context);
} public Flowable<T> request() {
return Flowable.fromCallable(new Callable<Pair<Integer, String>>() {
@Override
public Pair<Integer, String> call() throws Exception {
Pair<Integer, String> result = doRequest();
return result;
}
}).flatMap(new Function<Pair<Integer, String>, Publisher<T>>() {
@Override
public Publisher<T> apply(@NonNull Pair<Integer, String> pair) throws Exception {
if (isSuccessful(pair.first)) {
return Flowable.just(onRequestFinish(pair.second));
}
return Flowable.just(onRequestError(pair.first, pair.second));
}
}); } @Override
public boolean isSupportCache() {
return true;
} protected abstract T onRequestFinish(String result); protected abstract T onRequestError(int code, String message);
}
由于请求网络是耗时的操作,rxjava2 来实现网络请求异步操作。 request
是对 RequestWrapper.doRequest() 方法的封装,并得到一个 Flowable
对象。同时定义了 onRequestFinish()
和 onRequestError()
两个方法。
这两个方法就是具体业务类要处理的逻辑。
SimpleTextRequest
假设有一个请求业务数据接口,返回数据是一个字符串。那么我们使用我们的框架就是这样来使用。本文例子是请求我们项目中的 README.md 的内容。用起来非常简单,只要继承于 BaseTextRequest,并实现 getUrl()
、 onRequestFinish()
onRequestError()
、 getHttpMethod()
这几个方法。
注意严格来说这是一个业务类,所以是不应该放在 core 目录下的。
public class SimpleTextRequest extends BaseTextRequest<String> { public SimpleTextRequest(Context context, Map<String, String> params) {
super(context);
addParams(params);
} @Override
public String getUrl() {
return "https://raw.githubusercontent.com/wecodexyz/Componentization/master/README.md";
} @Override
public HttpMethod getHttpMethod() {
return HttpMethod.GET;
} @Override
protected String onRequestFinish(String result) {
//这里可以实现对 json 数据的解析,例如使用 JSONObject
//对象解析具体的业务
return result;
} @Override
protected String onRequestError(int code, String message) {
return message;
}
}
测试请求框架
request = new SimpleTextRequest(this, null);
request.request()
.subscribeOn(Schedulers.computation())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<String>() {
@Override
public void accept(@NonNull String s) throws Exception {
textView.setText(s);
//这里返回接口请求的数据
}
}, new Consumer<Throwable>() {
@Override
public void accept(@NonNull Throwable throwable) throws Exception {
textView.setText(throwable.getMessage());
}
});
本文运行的结果
项目地址:https://github.com/wecodexyz/Componentization
微信关注我们,可以获取更多
App 组件化/模块化之路——如何封装网络请求框架的更多相关文章
- App 组件化/模块化之路——使用SDK的思路进行模块化设计接口
在不久之前分享一篇<App 组件化/模块化之路——如何封装网络请求框架>文章介绍了我在项目中封装网络请求框架的思路.开发一个 App 会涉及到很多网络请求 API ,例如登录注册接口.用户 ...
- App 组件化/模块化之路——Android 框架组件(Android Architecture Components)使用指南
面对越来越复杂的 App 需求,Google 官方发布了Android 框架组件库(Android Architecture Components ).为开发者更好的开发 App 提供了非常好的样本. ...
- App 组件化/模块化之路——构建开发架构思路
App 组件化/模块化开发架构思路 随着业务的发展 App 开发技术也越来越成熟,对开发者来说 App 代码量也迅速地增长到一个数量级.对于如何架构 App 已经每个开发者面临的实际问题.好的架构可以 ...
- App 组件化/模块化之路——Repository 模式
什么是 Repository 模式 Repository 这个词直译过来仓库.仓储的意思.这个意思其实也能反应出 Repository 模式作用.App 开发中少不了对数据的操作,数据的来源可能有很多 ...
- Android 组件化/模块化之路——在展示层搭建MVP结构
Android 组件化/模块化之路——在展示层搭建MVP结构 什么是MVP Model–View–Presenter (MVP) 源于 Model–View–Controller (MVC) 的结构设 ...
- 第六十二篇、AFN3.0封装网络请求框架,支持缓存
1.网络请求 第一种实现方式: 功能:GET POST 请求 缓存逻辑: 1.是否要刷新本地缓存,不需要就直接发起无缓存的网络请求,否则直接读取本地数据 2.需要刷新本地缓存,先读取本地数据,有就返回 ...
- 得到、微信、美团、爱奇艺APP组件化架构实践
一.背景 随着项目逐渐扩展,业务功能越来越多,代码量越来越多,开发人员数量也越来越多.此过程中,你是否有过以下烦恼? 项目模块多且复杂,编译一次要5分钟甚至10分钟?太慢不能忍? 改了一行代码 或只调 ...
- 一步步搭建Retrofit+RxJava+MVP网络请求框架(二),个人认为这次封装比较强大了
在前面已经初步封装了一个MVP的网络请求框架,那只是个雏形,还有很多功能不完善,现在进一步进行封装.添加了网络请求时的等待框,retrofit中添加了日志打印拦截器,添加了token拦截器,并且对Da ...
- 2020,最新APP重构:网络请求框架
在现在的app,网络请求是一个很重要的部分,app中很多部分都有或多或少的网络请求,所以在一个项目重构时,我会选择网络请求框架作为我重构的起点.在这篇文章中我所提出的架构,并不是所谓的 最好 的网络请 ...
随机推荐
- 探讨SQL Server并发处理队列数据不阻塞解决方案
前言 之前对于并发这一块确实接触的比较少,自从遇到现在的老大,每写完一块老大都会过目一下然后给出意见,期间确实收获不少,接下来有几篇会来讲解SQL Server中关于并发这一块的内容,有的是总结,有的 ...
- Java 8 新特性1-函数式接口
Java 8 新特性1-函数式接口 (原) Lambda表达式基本结构: (param1,param2,param3) -> {代码块} 例1: package com.demo.jdk8; i ...
- poi jsp xls
poi jsp xls <%@ page language="java" pageEncoding="UTF-8"import="java.ut ...
- angular实现的文字上下无缝滚动
最近在学习angularJs,业余时间随便写了一个文字上下无缝滚动的例子,主要写了一个小小的指令. css代码:主要控制样式 <style type="text/css"&g ...
- 结构化CSS设计思维
LESS.SASS等预处理器给CSS开发带来了语法的灵活和便利,其本身却没有给我们带来结构化设计思维.很少有人讨论CSS的架构设计,而很多框架本身,如Bootstrap确实有架构设计思维作为根基. 要 ...
- 一天搞定CSS:表单(form)--20
1.表单标签 2.input标签属性与取值 代码演示 <!DOCTYPE html> <html> <head> <meta charset="UT ...
- webApi签名验证
还是一如既往先上结构图如下: 上一讲说明了redis,也谢谢心态的建议.这里经过改进后的redis的地址 当然这里是加密了的,具体实现如下图: 这里提供的解密. 先把加密解密的帮助类放上来. usin ...
- Javascript加载执行顺序
本文主要内容 一.不同位置的script标签执行顺序 二.document.ready和window.onload的区别 一.不同位置的script标签执行顺序 整个加载的过程从解析头部开始,比如ht ...
- 第二章完结,包含exam练习
正则方程(Normal Equation) 梯度下降是最小化代价函数\(J(\theta)\)的一种方式,这里提出了另一种方式即正则方式不使用迭代方式:\(\theta = (X^TX)^{-1}X^ ...
- Why you should QC your reads AND your assembly?
鲤鱼基因组:http://www.ntv.cn/a/20140923/52953.shtml 关于鲤鱼基因组的测定,数据质量控制遭到质疑. Why you should QC your reads ...