超简单的okhttp封装工具类（上）

最新推荐文章于 2022-11-03 11:02:09 发布
最新推荐文章于 2022-11-03 11:02:09 发布
阅读量2k 收藏 17
点赞数 6
文章标签： 网络
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/piaomiao8179/article/details/70811973
版权

前言：

提及访问网络，很自然的会用到okHttp，虽然okhttp已经封装的比较完善，
调用也比较方便，但对于向我这样比较懒的人，okhttp的调用还是略显复杂，
每次都要写同样重复的代码，简直不能忍受，那就封装以下一句话调用完毕，岂不快哉。。。
废话不多说，请抓稳扶好，老司机，走起。。。

重要的事情提一提：看不懂的文章最后有完整代码，看看完整版应该就没问题了。

okHttp使用流程

没有什么是一张图说不清的，走起

这里写图片描述

高逼格的封装开始

网络访问框架一般都需要单例模式（singleton），首先我们也进行单利模式。
1 首先私有化构造器，让别人不能new出其它实例。
2 声明该类的一个静态成员变量实例，本篇为instance
3 声明一个公有的方法getInstance提供给调用者本类实例。

 /**
 * 网络访问要求singleton
 */
private static OkHttpUtils instance;

// 必须要用的okhttpclient实例,在构造器中实例化保证单一实例
private OkHttpClient mOkHttpClient;
private OkHttpUtils() {
    /**
     * okHttp3中超时方法移植到Builder中
     */
    mOkHttpClient = (new OkHttpClient()).newBuilder()
                .connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(10, TimeUnit.SECONDS)
                .writeTimeout(30, TimeUnit.SECONDS)
                .build();


}

public static OkHttpUtils getInstance() {
    if (instance == null) {
        synchronized (OkHttpUtils.class) {
            if (instance == null) {
                instance = new OkHttpUtils();
            }
        }
    }

    return instance;
}

上面代码在构造器中实例化出了okHttpClient的实例，既然我们这个帮助类是单例的，那么构造器中的okHttpClient也只会走一次，必定也是单实例的。

提供GET和POST两种访问方式的方法

既然是工具类，肯定要更加简单，此处我们需要提供针对GET和POST两种方式的访问方法。
1.工具类为GET访问方式提供的方法
 /**
 * 对外提供的Get方法访问
 * @param url
 * @param callBack
 */
public void Get(String url, MyCallBack callBack) {
    /**
     * 通过url和GET方式构建Request
     */
    Request request = bulidRequestForGet(url);
    /**
     * 请求网络的逻辑
     */
    requestNetWork(request, callBack);
}
2.工具类为POST访问方式提供的方法（表单数据）
/**
 * 对外提供的Post方法访问
 * @param url
 * @param parms: 提交内容为表单数据
 * @param callBack
 */
public void PostWithFormData(String url, Map<String, String> parms, MyCallBack callBack) {
    /**
     * 通过url和POST方式构建Request
     */
    Request request = bulidRequestForPostByForm(url, parms);
    /**
     * 请求网络的逻辑
     */
    requestNetWork(request, callBack);

}
3.工具类为POST访问提供方法（JSON数据）
 /**
 * 对外提供的Post方法访问
 * @param url
 * @param json: 提交内容为json数据
 * @param callBack
 */
public void PostWithJson(String url, String json, MyCallBack callBack) {
    /**
     * 通过url和POST方式构建Request
     */
    Request request = bulidRequestForPostByJson(url, json);
    /**
     * 请求网络的逻辑
     */
    requestNetWork(request, callBack);

}

从这两个方法，我们能看到我们需要构建GET和POST访问方式对应的Request对象和我们自定义的MycallBack接口，下面先来看一下构建Request对象。

构建Request对象

为了大家更好的理解封装流程，首先请大家回顾一下okhttp的使用流程：
mOkHttpClient.newCall(request).enqueue(new Callback() {}）

1.首先我们来看构建GET需要的Request对象，这个也是最简单的。

  /**
 * GET方式构建Request
 * @param url
 * @return
 */
private Request bulidRequestForGet(String url) {

    return new Request.Builder()
            .url(url)
            .get()
            .build();
}

2.构建提交表单数据的Request对象

/**
 * POST方式构建Request {Form}
 * @param url
 * @param parms
 * @return
 */
private Request bulidRequestForPostByForm(String url, Map<String, String> parms) {

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

    if (parms != null) {
        for (Map.Entry<String, String> entry :
                parms.entrySet()) {
            builder.add(entry.getKey(), entry.getValue());
        }

    }
    FormBody body = builder.build();


    return new Request.Builder()
            .url(url)
            .post(body)
            .build();
}

3.构建提交json数据的Request对象

 /**
 * POST方式构建Request {json}
 * @param url
 * @param json
 * @return
 */
private Request bulidRequestForPostByJson(String url, String json) {
    RequestBody body = RequestBody.create(JSON, json);

    return new Request.Builder()
            .url(url)
            .post(body)
            .build();
}
开始处理联网逻辑
上述代码及分析基本上把简单封装的东西讲完了，有了okhttpclient和request对象我们需要处理联网逻辑了，也就是上述的 requestNetWork方法。

 private void requestNetWork(Request request, MyCallBack callBack) {

    /**
     * 处理连网逻辑，此处只处理异步操作enqueue
     */
    callBack.onLoadingBefore(request);

    mOkHttpClient.newCall(request).enqueue(new Callback() {
        @Override
        public void onFailure(Call call, IOException e) {
            callBack.onFailure(request, e);
        }

        @Override
        public void onResponse(Call call, Response response) throws IOException {
            if (response.isSuccessful()) {
                callBack.onSuccess(response);
            } else {
                callBack.onError(response);
            }
        }
    });


}
MyCallBack对象分析
看到此处，估计有人会一脸懵逼，这个MyCallBack是个什么鬼。
其实这是我定义的一个接口，那么为什么要定义她呢。因为我们在使用我们的工具类的时候，访问网络成功后肯定会有数据返回，我们怎么处理呢，okhttp内部通过一个callBack把数据回调回来，那么我们自己封装的工具类不妨仿照他的做法  定义一个接口回调Response的内容。贴一下接口的内容

interface MyCallBack {

void onLoadingBefore(Request request);

void onSuccess(Response response);

void onFailure(Request request, Exception e);

void onError(Response response);

}

封装进阶

看到此处，觉得封装已经完结了，不不不，还有一个重要的问题，不处理的话会导致崩溃的，这个问题就是，我们定义接口回调的地方是在子线程，而我们的Response很明显需要拿回到主线程进行UI的更新，所以访问网络的方法requestNetWork需要通过Handler把子线程的Resonse发送到主线程，请看详细实现。
private void requestNetWork(Request request, MyCallBack callBack) {

    /**
     * 处理连网逻辑，此处只处理异步操作enqueue
     */
    callBack.onLoadingBefore(request);

    mOkHttpClient.newCall(request).enqueue(new Callback() {
        @Override
        public void onFailure(Call call, IOException e) {
            mHandler.post(() -> callBack.onFailure(request, e));

        }

        @Override
        public void onResponse(Call call, Response response) throws IOException {
            if (response.isSuccessful()) {
                mHandler.post(() -> callBack.onSuccess(response));
            } else {
                mHandler.post(() -> callBack.onError(response));
            }
        }
    });


}
结束语
此工具类还没有完善，下篇文章继续完善，待完善内容：返回Resonpse直接解析成javaBean返回。
完整代码
public class OkHttpUtils {

    /**
     * 网络访问要求singleton
     */
    private static OkHttpUtils instance;

    // 必须要用的okhttpclient实例,在构造器中实例化保证单一实例
    private OkHttpClient mOkHttpClient;

    public static final MediaType JSON = MediaType.
            parse("application/json; charset=utf-8");

    private Handler mHandler;

    private OkHttpUtils() {
        /**
         * okHttp3中超时方法移植到Builder中
         */
        mOkHttpClient = (new OkHttpClient()).newBuilder()
                    .connectTimeout(10, TimeUnit.SECONDS)
                    .readTimeout(10, TimeUnit.SECONDS)
                    .writeTimeout(30, TimeUnit.SECONDS)
                    .build();

        mHandler = new Handler(Looper.getMainLooper());
    }

    public static OkHttpUtils getInstance() {
        if (instance == null) {
            synchronized (OkHttpUtils.class) {
                if (instance == null) {
                    instance = new OkHttpUtils();
                }
            }
        }

        return instance;
    }

    /**
     * 对外提供的Get方法访问
     * @param url
     * @param callBack
     */
    public void Get(String url, MyCallBack callBack) {
        /**
         * 通过url和GET方式构建Request
         */
        Request request = bulidRequestForGet(url);
        /**
         * 请求网络的逻辑
         */
        requestNetWork(request, callBack);
    }

    /**
     * 对外提供的Post方法访问
     * @param url
     * @param parms: 提交内容为表单数据
     * @param callBack
     */
    public void PostWithFormData(String url, Map<String, String> parms, MyCallBack callBack) {
        /**
         * 通过url和POST方式构建Request
         */
        Request request = bulidRequestForPostByForm(url, parms);
        /**
         * 请求网络的逻辑
         */
        requestNetWork(request, callBack);

    }

    /**
     * 对外提供的Post方法访问
     * @param url
     * @param json: 提交内容为json数据
     * @param callBack
     */
    public void PostWithJson(String url, String json, MyCallBack callBack) {
        /**
         * 通过url和POST方式构建Request
         */
        Request request = bulidRequestForPostByJson(url, json);
        /**
         * 请求网络的逻辑
         */
        requestNetWork(request, callBack);

    }

    /**
     * POST方式构建Request {json}
     * @param url
     * @param json
     * @return
     */
    private Request bulidRequestForPostByJson(String url, String json) {
        RequestBody body = RequestBody.create(JSON, json);

        return new Request.Builder()
                .url(url)
                .post(body)
                .build();
    }

    /**
     * POST方式构建Request {Form}
     * @param url
     * @param parms
     * @return
     */
    private Request bulidRequestForPostByForm(String url, Map<String, String> parms) {

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

        if (parms != null) {
            for (Map.Entry<String, String> entry :
                    parms.entrySet()) {
                builder.add(entry.getKey(), entry.getValue());
            }

        }
        FormBody body = builder.build();


        return new Request.Builder()
                .url(url)
                .post(body)
                .build();
    }


    /**
     * GET方式构建Request
     * @param url
     * @return
     */
    private Request bulidRequestForGet(String url) {

        return new Request.Builder()
                .url(url)
                .get()
                .build();
    }


    private void requestNetWork(Request request, MyCallBack callBack) {

        /**
         * 处理连网逻辑，此处只处理异步操作enqueue
         */
        callBack.onLoadingBefore(request);

        mOkHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                mHandler.post(() -> callBack.onFailure(request, e));

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                if (response.isSuccessful()) {
                    mHandler.post(() -> callBack.onSuccess(response));
                } else {
                    mHandler.post(() -> callBack.onError(response));
                }
            }
        });


    }


}

定义的接口的完整代码

interface MyCallBack {

    void onLoadingBefore(Request request);

    void onSuccess(Response response);

    void onFailure(Request request, Exception e);

    void onError(Response response);

}
程序员指北
关注
  • 6
    点赞
  • 踩
  • 17
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java封装OkHttp3工具类
qq_40812553的博客
05-31 796
Java封装OkHttp3工具类比HttpClient3和4都香废话少说直接上代码 废话少说直接上代码 //引入maven <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.10.0</version> </dependency> <depen
OkHttp简单封装
工具类KING的博客
11-24 355
OkHttp简单封装。
手把手教你封装一个好用的okhttp请求框架
weixin_41802023的博客
02-27 708
手把手教你封装一个好用的okhttp请求框架前言OkHttpClient 客户端 前言 在Android开发中网络框架的使用是必不可少的，okhttp相信大家一定不陌生，本篇基于okhttp进行二次封装，实现简单快捷的okhttp封装。 阅读前提：知道okhttp的简单使用。 主要包括四个部分： 请求client 请求参数 Request封装 请求结果 & 错误解析 OkHttpCli...
OkHttpClient请求方式详解，及常用OkHttpUtils配置工具类
大数据开发、JAVA开发、人工智能AI
11-03 8501
OkHttpClient请求方式详解，及常用OkHttpUtils配置工具类
okhttp的使用与封装
heng615975867的专栏
04-02 884
一、介绍 1、特性 OkHttp是一个精巧的网络请求库，有如下特性: 
 支持http2，对一台机器的所有请求共享同一个socket 
 内置连接池，支持连接复用，减少延迟 
 支持透明的gzip压缩响应体 
通过缓存避免重复的请求 
请求失败时自动重试主机的其他ip，自动重定向 
好用的API 其本身就是一个很强大的库，再加上Retrofit2、Picasso的这一套组合拳，使...
OkHttp请求完美封装（并带工具类）
03-16
MD5、RSA、Base64Utils、DialogUtil、ZXingUtils、GlideUtil、、、工具类 自己总结了一些必备的工具类，可直接放入工程，简单调用 对OkHttp进行了封装，简单调用，便于操作 进行了post、get、文件上传等进行封装
okhttp封装上传工具类
06-07
android okhttp封装工具类，实现多张上传图片，多参数上传
封装好的okhttp的工具类
11-15
使用时，直接调用OkhttpUtil类里的相应的方法，调用相应的接口，注释比较全，可以自己看
OKHttpUtils:OkHttp封装后的工具类
05-03
OKHttpUtilsOkHttp封装后的工具类
Java http请求封装工具类代码实例
08-19
Java HTTP 请求封装工具类代码实例 本文主要介绍了 Java HTTP 请求封装工具类代码实例，通过示例代码详细介绍了 HTTP 请求封装工具类的实现过程，对大家的学习或者工作具有一定的参考学习价值。下面是关于 Java ...
OkHttpUtils工具类.java
12-02
通过封装的okthps，就能轻松实现客户端与服务端的
okhttp关于https封装的几个工具类
12-28
工具lib类库是根据鸿杨项目修改的eclipse的lib类库，以及其中没有包含的OkHttpClientManager类
OkHttp的封装和使用详解
YuKuoYuan的博客
03-17 3339
其实一直想写这篇文章的,为什么不写呢?因为不想写,不要咬我.我要开始装逼了.接触okhttp是在2015年6月份左右,这已经过去了几年了,但是我对于它的爱犹如滔滔江水,连绵不绝,现在介绍一下,几年前我自己封装的okhttp工具类,拢共就几个类.不会对于造成学习的困扰.开始喽… 因为我已经把它封装为一个工具类,并上传到jcenter仓库,所以大家使用的话,直接gradle应用即可Github地址com
OkHttp使用及工具类封装
peixiaopao的博客
09-05 4325
今天主要跟大家说一下这个网络请求框架OKHttp 首先给大家推荐两个很好的博客（掘金）： http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/0106/2275.html（掘金） http://blog.csdn.net/lmj623565791/article/details/47911083（张鸿洋博客） 有其他需要了解
okHttp工具类
拒绝熬夜啊的博客
10-11 634
okHttp工具类
OKHttp的简单封装类
A WAY
10-09 429
网上关于OKHttp的教程很多，不再一一赘述。最近在自己写一点小的APP，也用不到太深的内容，所以就简单写了一个类来封装一下（或许连封装都称不上）import java.util.HashMap; import java.util.Iterator; import java.util.Map;import okhttp3.Call; import okhttp3.Callback; import o
okhttp 工具类_OkHttp透明压缩，收获性能10倍，外加故障一枚
weixin_39866265的博客
11-30 155
原创：小姐姐味道（微信公众号ID：xjjdog），欢迎分享，转载请保留出处。要使用OkHttp，一定要知道它的透明压缩，否则死都不知道怎么死的；或者活也不知道为什么活的不舒坦。反正不是好事。什么叫透明压缩呢？OkHttp在发送请求的时候，会自动加入gzip请求头Accept-Encoding:gzip。所以，当返回的数据带有gzip响应头时Content-Encoding=gzip，OkHttp会...
写一个springboot 用的 okhttp 封装工具类
最新发布
06-06
好的，以下是一个简单的封装 OkHttp 的工具类： ```java import okhttp3.*; import org.springframework.stereotype.Component; import java.io.IOException; import java.util.Map; @Component public class ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值