okgo学习笔记(一):全局配置

亡梦爱人 提交于 2019-11-27 02:25:00

#okgo学习笔记(一):全局配置

作用:笔记使用。原始详细开发文档地址:https://github.com/jeasonlzy/okhttp-OkGo/wiki/Init

初始化办法

一般在Aplication,或者基类中配置,只需要调用一次即可

  • 可以配置log开关
  • 全局的超时时间
  • 全局cookie管理策略
  • Https配置
  • 超时重连次数
  • 公共的请求头和请求参数等信息

1. 最简单的配置

OkGo.getInstance().init(this);

这样写是使用OkGO内部默认初始化的OkHttpClient来进行网络请求,包含了基本的log打印,超时时间和https相关的配置,但是建议还是自己配置好OkHttpClient传给OkGo比较好,详细自定义OkHttpClient的方法就是配置原生的okhttp的方法,建议的一些配置如下,都是可选的,如果需要你就加,不需要就别加了。

2. 构建OkHttpClient.Builder

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

3. 配置log

可以使用OkGo内置的log拦截器打印log,如果你觉得不好用,也可以自己写个,这个没有限制。

HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor("OkGo");
//log打印级别,决定了log显示的详细程度 
loggingInterceptor.setPrintLevel(HttpLoggingInterceptor.Level.BODY);
//log颜色级别,决定了log在控制台显示的颜色
loggingInterceptor.setColorLevel(Level.INFO);
builder.addInterceptor(loggingInterceptor);

4. 配置超时时间

默认使用的超时时间就是60秒

//全局的读取超时时间
builder.readTimeout(OkGo.DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); 
//全局的写入超时时间
builder.writeTimeout(OkGo.DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS);    
//全局的连接超时时间
builder.connectTimeout(OkGo.DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); 

5. 配置Cookie,以下几种任选其一就行

如果你用到了Cookie的持久化或者叫Session的保持,那么建议配置一个Cookie,这个也是可以自定义的,不一定非要用OkGo自己的,以下三个是OkGo默认提供的三种方式,可以选择添加,也可以自己实现CookieJar的接口,自己管理cookie。

//使用sp保持cookie,如果cookie不过期,则一直有效
builder.cookieJar(new CookieJarImpl(new SPCookieStore(this)));  
//使用数据库保持cookie,如果cookie不过期,则一直有效
builder.cookieJar(new CookieJarImpl(new DBCookieStore(this)));
//使用内存保持cookie,app退出后,cookie消失
builder.cookieJar(new CookieJarImpl(new MemoryCookieStore())); 

6. Https配置,以下几种方案根据需要自己设置

这个也是可以自定义的,HttpsUtils只是框架内部提供的方便管理Https的一个工具类,你也可以自己实现,最好只要给OkHttpClient.Builder传递一个sslSocketFactory就行.

//方法一:信任所有证书,不安全有风险
HttpsUtils.SSLParams sslParams1 = HttpsUtils.getSslSocketFactory();
//方法二:自定义信任规则,校验服务端证书
HttpsUtils.SSLParams sslParams2 = HttpsUtils.getSslSocketFactory(new SafeTrustManager());
//方法三:使用预埋证书,校验服务端证书(自签名证书)
HttpsUtils.SSLParams sslParams3 = HttpsUtils.getSslSocketFactory(getAssets().open("srca.cer"));
//方法四:使用bks证书和密码管理客户端证书(双向认证),使用预埋证书,校验服务端证书(自签名证书)
HttpsUtils.SSLParams sslParams4 = HttpsUtils.getSslSocketFactory(getAssets().open("xxx.bks"), "123456", getAssets().open("yyy.cer"));
builder.sslSocketFactory(sslParams1.sSLSocketFactory, sslParams1.trustManager);
//配置https的域名匹配规则,详细看demo的初始化介绍,不需要就不要加入,使用不当会导致https握手失败
builder.hostnameVerifier(new SafeHostnameVerifier());

7. 配置OkGo

//---------这里给出的是示例代码,告诉你可以这么传,实际使用的时候,根据需要传,不需要就不传-------------//
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.getInstance().init(this)                       //必须调用初始化
    .setOkHttpClient(builder.build())               //建议设置OkHttpClient,不设置将使用默认的
    .setCacheMode(CacheMode.NO_CACHE)               //全局统一缓存模式,默认不使用缓存,可以不传
    .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE)   //全局统一缓存时间,默认永不过期,可以不传
    .setRetryCount(3)                               //全局统一超时重连次数,默认为三次,那么最差的情况会请求4次(一次原始请求,三次重连请求),不需要可以设置为0
    .addCommonHeaders(headers)                      //全局公共头
    .addCommonParams(params);                       //全局公共参数
标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!