android -------- OkGo (让网络请求更简单的框架)

Posted 2021-02-06 切切歆语

 

项目地址：https://github.com/jeasonlzy

该库是封装了okhttp的网络框架，可以与RxJava完美结合，比Retrofit更简单易用。支持大文件上传下载，上传进度回调，下载进度回调，表单上传（多文件和多参数一起上传），链式调用，可以自定义返回对象，支持Https和自签名证书，支持cookie自动管理，支持四种缓存模式缓存网络数据，支持301、302重定向，扩展了统一的上传管理和下载管理功能

 

其中Demo中用到的图片选择是我的另一个开源项目，完全仿微信的图片选择库，自带 矩形图片裁剪 和 圆形图片裁剪 功能，有需要的可以去下载使用，附上地址：https://github.com/jeasonlzy/ImagePicker

 

 

其中的九宫格控件也是我的开源项目,类似QQ空间，微信朋友圈，微博主页等，展示图片的九宫格控件，自动根据图片的数量确定图片大小和控件大小，使用Adapter模式设置图片，对外提供接口回调，使用接口加载图片,支持任意的图片加载框架,如 Glide,ImageLoader,Fresco,xUtils3,Picasso 等，支持点击图片全屏预览大图。附上地址：https://github.com/jeasonlzy/NineGridView

演示

 

android Studio用户

般来说，只需要添加第一个okgo的核心包即可，其余的三个库根据自己的需要选择添加！！！

//必须使用
compile ‘com.lzy.net:okgo:3.0.4‘

//以下三个选择添加，okrx和okrx2不能同时使用
compile ‘com.lzy.net:okrx:1.0.2‘
compile ‘com.lzy.net:okrx2:2.0.2‘  
compile ‘com.lzy.net:okserver:2.0.5‘

 

OkGo主要功能

• 基本的get、post、put、delete、head、options、trace、patch八种请求
• 支持upString，upJson，upBytes，upFile等up类方法上传特定数据
• 支持一个key上传一个文件，也可以一个key上传多个文件，也可以多文件和多参数一起上传
• 大文件下载和下载进度回调
• 大文件上传和上传进度回调
• 支持cookie的自动管理，并可自定义cookie管理策略
• 支持缓存模式，不仅支持http缓存协议，也支持自定义缓存策略
• 支持重定向
• 支持自定义超时自动重连次数
• 支持链式调用
• 支持https访问，支持双向认证
• 支持根据tag取消请求，也可全部取消
• 支持自定义Callback，自动解析网络数据

举例 get请求

OkGo.<String>get("https://api.github.com/repos/square/retrofit/contributors")                            // 请求方式和请求url
                .tag(this)                       // 请求的 tag, 主要用于取消对应的请求
                .cacheKey("cacheKey")            // 设置当前请求的缓存key,建议每个不同功能的请求设置一个
                .cacheMode(CacheMode.NO_CACHE)    // 缓存模式，详细请看缓存介绍
              //  .cacheTime(3000)//缓存时间
                .execute(new StringCallback() {

                    @Override
                    public void onSuccess(Response<String> response) {
                        Log.i("get",response.body());
                        tvText.setText(response.body());
                       
                    }

                     @Override
                     public void onError(Response<String> response) {
                         super.onError(response);
                     }
                });

 

post请求

 OkGo.<String>post("url")
                 .tag(this)
                .cacheKey("cachePostKey")
                .cacheMode(CacheMode.NO_CACHE)
                .params("shopperId", "9356")
                .params("machineId", "5117")
                .params("orderType", "2")
                .params("orderId", "108")
                .execute(new StringCallback() {
                    @Override
                    public void onSuccess(Response<String> response) {
                        Log.i("aaa",response.body());
                        Log.i("time2",System.currentTimeMillis()+"s");
                        BorrowRecordInfo borrowRecordInfo = JSON.parseObject(response.body(),BorrowRecordInfo.class);
                        if (borrowRecordInfo != null){
                            tvText.setText(response.body());
                            Toast.makeText(Demo1.this,borrowRecordInfo.getOrder().getNickName(),Toast.LENGTH_LONG).show();
                        }

                    }

                    @Override
                    public void onError(Response<String> response) {
                        super.onError(response);
                    }
                });

 

post请求查看Header

头多了一个字段叫Content-Type:application/x-www-form-urlencoded，这个表示当前请求是http普通的表单请求，并且请求的参数经过了URL编码。这个请求头不要尝试自己修改，也不支持修改，就算你修改了，也不会生效

 

OkGo的优势

• 优势一：性能高，专注于简单易用的网络请求，使用主流的okhttp进行封装，对于okhttp大家都知道，在Android4.4的源码中可以看到HttpURLConnection已经替换成OkHttp实现了，并且支持HTTP2/SPDY黑科技，支持socket自动选择最好路线，并支持自动重连，拥有自动维护的socket连接池，减少握手次数，拥有队列线程池，轻松写并发。
• 优势二：特有的网络缓存模式，是大多数网络框架所不具备的，说一个应用场景，老板说我们的app不仅需要在有网的情况下展示最新的网络数据，还要在没网的情况下使用缓存数据，这时候是不是项目中出现了大量的代码判断当前网络状况，根据不同的状态保存不同的数据，然后决定是否使用缓存。细想一下，这是个通用的写法，于是OkGo提供了五种缓存模式，让你不用关心缓存的实现，而专注于数据的处理。（具体缓存的使用方法请看最后第四章节）。
• 优势三：方便易用的扩展接口，可以添加全局的公共参数，全局拦截器，全局超时时间，更可以对单个请求定制拦截器，超时时间，请求参数修改等等，在使用上更是方便，原生支持的链式调用让你的请求更加清晰。
• 优势四：强大的Cookie保持策略，我们知道在客户端对cookie的获取是个不太简单的事情，特别是还要处理cookie的过期时间，持久化策略等等，OkGo帮你彻底解决Cookie的难题，默认拥有内存存储和持久化存储两种实现，cookie全程自动管理，并且提供了额外的addCookie方式，允许介入到自动管理的过程中，添加你想创建的任何cookie。

 

所以就说这么多啦，选最适合项目的，选大多数人选择的，选简单易用的，选择使用流行技术的，就这么个标准，而OkGo正是在这种情况下诞生啦！！

OkGo详细文档

https://github.com/jeasonlzy/okhttp-OkGo/wiki/OkGo

常见问题

https://github.com/jeasonlzy/okhttp-OkGo/wiki/%E4%BC%A0%E5%8F%82%E4%B8%8E%E6%8A%93%E5%8C%85%EF%BC%88%E5%BF%85%E7%9C%8B%EF%BC%89#1-%E4%B8%8A%E4%BC%A0%E8%AF%B7%E6%B1%82%E5%A4%B4

参考文章

https://www.jianshu.com/p/6aa5cb272514