前言:
OkGo —— OkHttpUtils-2.0.0升级后改名 OkGo,全新完美支持RxJava。
该库是封装了okhttp的网络框架,可以与RxJava完美结合,比Retrofit更简单易用。支持大文件上传下载,上传进度回调,下载进度回调,表单上传(多文件和多参数一起上传),链式调用,可以自定义返回对象,支持Https和自签名证书,支持超时自动重连,支持cookie自动管理,支持四种缓存模式缓存网络数据,支持301、302重定向,扩展了统一的上传管理和下载管理功能
声明:本人才疏学浅,只能大致的分析下大神封装的东西。
使用:
public class GApp extends Application { @Override public void onCreate() { super.onCreate(); //---------这里给出的是示例代码,告诉你可以这么传,实际使用的时候,根据需要传,不需要就不传-------------// HttpHeaders headers = new HttpHeaders(); headers.put("commonHeaderKey1", "commonHeaderValue1"); //header不支持中文 headers.put("commonHeaderKey2", "commonHeaderValue2"); HttpParams params = new HttpParams(); params.put("commonParamsKey1", "commonParamsValue1"); //param支持中文,直接传,不要自己编码 params.put("commonParamsKey2", "这里支持中文参数"); //-----------------------------------------------------------------------------------// //必须调用初始化 OkGo.init(this); //以下设置的所有参数是全局参数,同样的参数可以在请求的时候再设置一遍,那么对于该请求来讲,请求中的参数会覆盖全局参数 //好处是全局参数统一,特定请求可以特别定制参数 try { //以下都不是必须的,根据需要自行选择,一般来说只需要 debug,缓存相关,cookie相关的 就可以了 OkGo.getInstance() //打开该调试开关,控制台会使用 红色error 级别打印log,并不是错误,是为了显眼,不需要就不要加入该行 .debug("OkGo") //如果使用默认的 60秒,以下三行也不需要传 .setConnectTimeout(OkGo.DEFAULT_MILLISECONDS) //全局的连接超时时间 .setReadTimeOut(OkGo.DEFAULT_MILLISECONDS) //全局的读取超时时间 .setWriteTimeOut(OkGo.DEFAULT_MILLISECONDS) //全局的写入超时时间 //可以全局统一设置缓存模式,默认是不使用缓存,可以不传,具体其他模式看 github 介绍 https://github.com/jeasonlzy0216/ .setCacheMode(CacheMode.NO_CACHE) //可以全局统一设置缓存时间,默认永不过期,具体使用方法看 github 介绍 .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE) //可以全局统一设置超时重连次数,默认为三次,那么最差的情况会请求4次(一次原始请求,三次重连请求),不需要可以设置为0 .setRetryCount(3) //如果不想让框架管理cookie,以下不需要 // .setCookieStore(new MemoryCookieStore()) //cookie使用内存缓存(app退出后,cookie消失) .setCookieStore(new PersistentCookieStore()) //cookie持久化存储,如果cookie不过期,则一直有效 //可以设置https的证书,以下几种方案根据需要自己设置 // .setCertificates() //方法一:信任所有证书(选一种即可) // .setCertificates(getAssets().open("srca.cer")) //方法二:也可以自己设置https证书(选一种即可) // .setCertificates(getAssets().open("aaaa.bks"), "123456", getAssets().open("srca.cer"))//方法三:传入bks证书,密码,和cer证书,支持双向加密 //可以添加全局拦截器,不会用的千万不要传,错误写法直接导致任何回调不执行 // .addInterceptor(new Interceptor() { // @Override // public Response intercept(Chain chain) throws IOException { // return chain.proceed(chain.request()); // } // }) //这两行同上,不需要就不要传 .addCommonHeaders(headers) //设置全局公共头 .addCommonParams(params); //设置全局公共参数 } catch (Exception e) { e.printStackTrace(); } } }
OkGo.java 的内部成员变量
public static final int DEFAULT_MILLISECONDS = 60000; //默认的超时时间 private Handler mDelivery; //用于在主线程执行的调度器 private OkHttpClient.Builder okHttpClientBuilder; //ok请求的客户端 private HttpParams mCommonParams; //全局公共请求参数 private HttpHeaders mCommonHeaders; //全局公共请求头 private CacheMode mCacheMode; //全局缓存模式 private int mRetryCount = 3; //全局超时重试次数 private long mCacheTime = CacheEntity.CACHE_NEVER_EXPIRE; //全局缓存过期时间,默认永不过期 private static Application context; //全局上下文 private CookieJarImpl cookieJar; //全局 Cookie 实例
使用了 静态内部类来对 OkGo对象的创建 ,并使用 静态方法获得 OkGo对象的实例
private OkGo() { okHttpClientBuilder = new OkHttpClient.Builder(); okHttpClientBuilder.hostnameVerifier(new DefaultHostnameVerifier()); //主机名校验 okHttpClientBuilder.connectTimeout(DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); okHttpClientBuilder.readTimeout(DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); okHttpClientBuilder.writeTimeout(DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); mDelivery = new Handler(Looper.getMainLooper()); // 使用handler——在主线程中执行的调度器 } public static OkGo getInstance() { return OkGoHolder.holder; } private static class OkGoHolder { private static OkGo holder = new OkGo(); }
/** 必须在全局Application先调用,获取context上下文,否则缓存无法使用 */ public static void init(Application app) { context = app; } /** 获取全局上下文 */ public static Context getContext() { if (context == null) throw new IllegalStateException("请先在全局Application中调用 OkGo.init() 初始化!"); return context; }
构建 :
okHttpClientBuilder
public Builder() { dispatcher =