Android 二次封装网络加载框架(2)

2401_84121603

于 2024-04-22 04:33:46 发布

阅读量947

点赞数 27

分类专栏：程序员文章标签： android 网络

本文链接：https://blog.csdn.net/2401_84121603/article/details/138054893

版权

程序员专栏收录该内容

198 篇文章 0 订阅

订阅专栏

随着需求的变更或者时间的迁移，某些框架可能已经不能满足我们的需求，我们需要使用新的框架来代替。
对第三方框架进行封装，是为了达到对模块项目的控制，已最小的代价替换框架，达到对项目的控制。

或许你会认为对第三方框架再进行一次封装，没有必要。那是你没有尝试过一行行复制张贴代码，进行替换。

有人可能会想， AS 不是有批量替换的功能吗，干嘛还要封装？

首先，你能保证调用到的地方参数都一模一样吗？
第二，能用更优雅的方式实现，为什么要用最粗暴的方式去替换。

接下来我们先来看一下 okHttp 的使用

Okhttp 的使用

OkHttpClient.Builder mBuilder= new OkHttpClient.Builder().

connectTimeout(10, TimeUnit.SECONDS).writeTimeout(10, TimeUnit.SECONDS)

.readTimeout(30, TimeUnit.SECONDS)

.addInterceptor(new LoggingInterceptor())

.cache(new Cache(mContext.getExternalFilesDir(“okhttp”),cacheSize));

client=mBuilder.build();

Request.Builder builder = new Request.Builder().url(url).tag(option.mTag);

builder=configHeaders(builder,option);

Request build = builder.build();

client.newCall(build).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) {

handleError(e, iResponseListener);

}

@Override

public void onResponse(Call call, Response response) throws IOException {

handleResult(response, iResponseListener);

}

});

如果不进行封装，okHttp 请求网络大概是这样的，想一下，如果我们在项目中都这样使用，要替换框架，那花费的工作量要多大。

不过这种方法，在项目中大多数人不会这样使用，至少都会封装成为一个工具类。封装完成之后如下。

public static void doGet(Context context,String url, Map<String, String> paramsMap, NetworkOption networkOption,

final IResponseListener iResponseListener){

OkHttpClient.Builder mBuilder= new OkHttpClient.Builder().

connectTimeout(10, TimeUnit.SECONDS).writeTimeout(10, TimeUnit.SECONDS)

.readTimeout(30, TimeUnit.SECONDS)

.addInterceptor(new LoggingInterceptor())

.cache(new Cache(context.getExternalFilesDir(“okhttp”),cacheSize));

OkHttpClient cilent = mBuilder.build();

Request.Builder builder = new Request.Builder().url(url);

Request build = builder.build();

cilent.newCall(build).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) {

handleError(e, iResponseListener);

}

@Override

public void onResponse(Call call, Response response) throws IOException {

handleResult(response, iResponseListener);

}

});

}

public static void doPost(Context context,String url, Map<String, String> paramsMap, NetworkOption networkOption,

final IResponseListener iResponseListener) {

OkHttpClient.Builder mBuilder= new OkHttpClient.Builder().

connectTimeout(10, TimeUnit.SECONDS).writeTimeout(10, TimeUnit.SECONDS)

.readTimeout(30, TimeUnit.SECONDS)

.addInterceptor(new LoggingInterceptor())

.cache(new Cache(context.getExternalFilesDir(“okhttp”),cacheSize));

OkHttpClient cilent = mBuilder.build();

url= NetUtils.checkUrl(url);

final NetworkOption option=NetUtils.checkNetworkOption(networkOption,url);

FormBody.Builder builder = new FormBody.Builder();

FormBody formBody = builder.build();

Request.Builder requestBuilder = new Request.Builder().url(url).post(formBody).tag(option.mTag);

Request request = requestBuilder.build();

cilent.newCall(request).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) {

handleError(e,iResponseListener);

}

@Override

public void onResponse(Call call, Response response) throws IOException {

handleResult(response,iResponseListener);

}

});

}

这种封装成工具类的比完全没有封装的好了很多，但是还是存在一定的问题的。封装成工具类的话，别人完全有权限访问你这个工具类，他可以随时修改你工具类里面的实现，这给维护带来了一定的成本。那有没有更好的方法呢？

大多数人都会想到的是封装统一网络接口，没错，确实是这样。于是，经过一番思考以后，我们可能写出以下的代码。

void doGet(Context context，String url, final Map<String, String> paramsMap, final IResponseListener iResponseListener);

如果我们需要动态配置请求头呢，请求 TAG 呢，这时候你会怎么写,继续增加参数吗？

这时候接口可能如下：

public interface NetRequest{

void doGet(Context context，String url, final Map<String, String> paramsMap,final Map<String, String> headMap， String tag,final IResponseListener iResponseListener);

}

那以后如果要配置缓存路径呢，配置请求超时时间，读取超时时间呢，直接在方法中增加相应的参数？

这样的做法是不太明智的，会导致接口越来越臃肿。

既然这样，那有没有办法解决呢？

首先，我们先回想一下，网络请求那些参数是必要的，那些是非必要的，即可有可无的。

必要选项

url，请求网址
paramsMap ，请求参数
iResponseListener 请求结果的回调

非必要选项

context 通常是用来配置配置一些缓存等一些信息
headMap 请求头
tag 请求 TAG，用来区分或者取消网络请求
connectTimeout 连接超时时间
readTimeout 读取超时时间
writeTimeout 写入超时时间

了解完必要参数和非必要参数之后，我们的接口要怎样提取呢？

不知道大家有没有注意到 okHttpClient 的构建，他将所有的网络配置都提取封装在 OkHttpClient，Request 中，在请求网络的时候减少了相应的参数，简洁灵活。

OkHttpClient.Builder mBuilder= new OkHttpClient.Builder().

connectTimeout(10, TimeUnit.SECONDS).writeTimeout(10, TimeUnit.SECONDS)

.readTimeout(30, TimeUnit.SECONDS)

.addInterceptor(new LoggingInterceptor())

.cache(new Cache(context.getExternalFilesDir(“okhttp”),cacheSize));

OkHttpClient cilent = mBuilder.build();

Request.Builder builder = new Request.Builder().url(url);

client.newCall(builder.build()).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) {

handleError(e, iResponseListener);

}

@Override

public void onResponse(Call call, Response response) throws IOException {

handleResult(response, iResponseListener);

}

});

看了 OKhttp 的代码，我们也可以依样画葫芦，我们可以将非必要参数封装在一个实体类 NetworkOption 当中，必要的参数作为方法参数，这样接口变成以下的形式。

void doGet(String url, final Map<String, String> paramsMap, final IResponseListener iResponseListener);

void doGet(String url, final Map<String, String> paramsMap, NetworkOption networkOption, final IResponseListener iResponseListener);

对比直接在方法中增加相应的参数，是不是简洁很多。

接着，我们一起来看一下 NetworkOption 的属性。基本上，只要 okhttp 可以配置的，我们都可以往里面配置。这里列举了一些常用的字段，baseUrl，请求标志 tag，请求头 mHeaders。-connectTimeout 连接超时时间，readTimeout 读取超时时间，writeTimeout 写入超时时间就不一一列举了。

public class NetworkOption {

/**

网络请求的 TAG

public String mBaseUrl;

public String mTag;

public Map<String,String> mHeaders;

public NetworkOption(String tag) {

this.mTag = tag;

}

public static final class Builder{

public String tag;

public Map<String,String> mHeaders;

public String mBaseUrl;

public Builder setTag(String tag){

this.tag=tag;

return this;

}

public Builder setHeaders(Map<String,String> headers){

mHeaders=headers;

return this;

}

public Builder setBaseUrl(String baseUrl) {

mBaseUrl = baseUrl;

return this;

}

public NetworkOption build(){

NetworkOption networkOption = new NetworkOption(tag);

networkOption.mHeaders=mHeaders;

networkOption.mBaseUrl=mBaseUrl;

return networkOption;

}

同时，考虑到 NetworkOption 对象的配置会比较复杂，这里我们采用了建造者模式来构建。有兴趣的话，可以参考我的这一篇博客。建造者模式（Builder）及其应用

建造者模式的优点

封装性很好，将产品本身与产品的创建过程解耦，对外屏蔽了对象的构建过程
扩展性强，如果有新的需求，只需要增加新的具体建造者，无须修改原有类库的代码

最后的封装实现

NetRequest 接口的封装

public interface NetRequest {

void init(Context context);

void doGet(String url, final Map<String, String> paramsMap, final IResponseListener iResponseListener);

void doGet(String url, final Map<String, String> paramsMap, NetworkOption networkOption, final IResponseListener iResponseListener);

void doPost(String url, final Map<String, String> paramsMap, final IResponseListener iResponseListener);

void doPost(String url, final Map<String, String> paramsMap, NetworkOption networkOption,

final IResponseListener iResponseListener);

void cancel(Object tag);

}

可以看到，我们主要有几个方法

init 方法，主要用来配置一些初始化参数
doGet 有两个方法，其中一个方法是另外一个方法的重载，这样设计的目的是为了减少调用方法的时候减少方法参数的传递
doPost 跟 doGet 方法一样，就不说了
cancel 主要是用来取消网络请求的。在项目当中，在 Activity 或者 Fragment 销毁的时候，最好取消网络请求，不然可能导致内存泄露或者异常，如空指针异常等。

OkHttpRequest 的实现

OkHttp 的配置是非常灵活的，这样我们主要看一下怎么配置请求头，请求参数，以及怎样取消网络请求。

public class OKHttpRequest implements NetRequest {

// ----- 省略若干方法，有兴趣的话上 github 查阅

@Override

public void doGet(String url, Map<String, String> paramsMap, final IResponseListener iResponseListener) {

doGet(url,paramsMap,null,iResponseListener);

}

@Override

public void doGet(String url, Map<String, String> paramsMap, NetworkOption networkOption,

final IResponseListener iResponseListener) {

url= NetUtils.checkUrl(url);

url=NetUtils.appendUrl(url,paramsMap);

final NetworkOption option=NetUtils.checkNetworkOption(networkOption,url);

Request.Builder builder = new Request.Builder().url(url).tag(option.mTag);

builder=configHeaders(builder,option);

Request build = builder.build();

getCilent().newCall(build).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) {

handleError(e, iResponseListener);

}

@Override

public void onResponse(Call call, Response response) throws IOException {

handleResult(response, iResponseListener);

}

});

}

private Request.Builder configHeaders(Request.Builder builder, NetworkOption option) {

Map<String, String> headers = option.mHeaders;

if(headers==null || headers.size()==0){

return builder;

}

Set<Map.Entry<String, String>> entries = headers.entrySet();

for(Map.Entry<String, String> entry: entries){

String key = entry.getKey();

String value = entry.getValue();

// 添加请求头

builder.addHeader(key,value);

}

return builder;

}

@Override

public void doPost(String url, Map<String, String> paramsMap, final IResponseListener iResponseListener) {

doPost(url,paramsMap,null,iResponseListener);

}

private FormBody.Builder configPushParam(FormBody.Builder builder, Map<String, String> paramsMap) {

if(paramsMap!=null){

Set<Map.Entry<String, String>> entries = paramsMap.entrySet();

for(Map.Entry<String,String> entry:entries ){

String key = entry.getKey();

String value = entry.getValue();

builder.add(key,value);

}

return builder;

}

@Override

public void doPost(String url, Map<String, String> paramsMap, NetworkOption networkOption,

final IResponseListener iResponseListener) {

url= NetUtils.checkUrl(url);

final NetworkOption option=NetUtils.checkNetworkOption(networkOption,url);

// 以表单的形式提交

FormBody.Builder builder = new FormBody.Builder();

builder=configPushParam(builder,paramsMap);

FormBody formBody = builder.build();

Request.Builder requestBuilder = new Request.Builder().url(url).post(formBody).tag(option.mTag);

requestBuilder=configHeaders(requestBuilder,option);

Request request = requestBuilder.build();

getCilent().newCall(request).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) {

handleError(e,iResponseListener);

}

@Override

public void onResponse(Call call, Response response) throws IOException {

handleResult(response,iResponseListener);

}

});

}

@Override

public void cancel(Object tag) {

if(client!=null){

if(client != null) {

// 在等待队列中查找是否有相应的请求

for(Call call : client.dispatcher().queuedCalls()) {

if(call.request().tag().equals(tag))

call.cancel();

}

// 在正在请求的请求队列中查找是否有相应的请求

for(Call call : client.dispatcher().runningCalls()) {

if(call.request().tag().equals(tag))

call.cancel();

}

}
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

资源分享

一线互联网面试专题

379页的Android进阶知识大全

网上学习 Android的资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。希望这份系统化的技术体系对大家有一个方向参考。

2020年虽然路途坎坷，都在说Android要没落，但是，不要慌，做自己的计划，学自己的习，竞争无处不在，每个行业都是如此。相信自己，没有做不到的，只有想不到的。祝大家2021年万事大吉。

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

13731598404)]

[外链图片转存中…(img-Cb9CVSCz-1713731598405)]

[外链图片转存中…(img-6zomAlD6-1713731598406)]

[外链图片转存中…(img-3fTpXTrF-1713731598407)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

[外链图片转存中…(img-BL8fe039-1713731598408)]

资源分享

[外链图片转存中…(img-U9RfNBXO-1713731598409)]

[外链图片转存中…(img-CCqqPiNH-1713731598410)]

[外链图片转存中…(img-YijrwZ8T-1713731598411)]

2020年虽然路途坎坷，都在说Android要没落，但是，不要慌，做自己的计划，学自己的习，竞争无处不在，每个行业都是如此。相信自己，没有做不到的，只有想不到的。祝大家2021年万事大吉。

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

2401_84121603

关注

27
点赞
踩
25

收藏

觉得还不错? 一键收藏
0
评论
Android 二次封装网络加载框架(2)

随着需求的变更或者时间的迁移，某些框架可能已经不能满足我们的需求，我们需要使用新的框架来代替。对第三方框架进行封装，是为了达到对模块项目的控制，已最小的代价替换框架，达到对项目的控制。或许你会认为对第三方框架再进行一次封装，没有必要。那是你没有尝试过一行行复制张贴代码，进行替换。有人可能会想， AS 不是有批量替换的功能吗，干嘛还要封装？首先，你能保证调用到的地方参数都一模一样吗？第二，能用更优雅的方式实现，为什么要用最粗暴的方式去替换。接下来我们先来看一下 okHttp 的使用。
复制链接

扫一扫