Android--OKGO使用
一、简介
该库是封装了okhttp的标准RESTful风格的网络框架，可以与RxJava完美结合，比Retrofit更简单易用。支持大文件上传下载，上传进度回调，下载进度回调，表单上传（多文件和多参数一起上传），链式调用，可以自定义返回对象，支持Https和自签名证书，支持超时自动重连，支持cookie与session的自动管理，支持四种缓存模式缓存网络数据，支持301、302重定向，扩展了统一的上传管理和下载管理功能。
github地址：https://github.com/jeasonlzy/okhttp-OkGo
官方文档：https://github.com/jeasonlzy/okhttp-OkGo/wiki
二、引入（添加依赖）
//OKGO
compile 'com.lzy.net:okgo:3.0.4'
compile 'com.lzy.net:okrx2:2.0.2'
compile 'com.lzy.net:okserver:2.0.5'三、初始化
//没有特殊需要的话,最简单的初始化就可以了
OkGO.getInstance()
.init(this); 自写配置文件：
import android.app.Application;
import android.content.Context;
import com.lzy.okgo.OkGo;
import com.lzy.okgo.cache.CacheEntity;
import com.lzy.okgo.cache.CacheMode;
import com.lzy.okgo.cookie.CookieJarImpl;
import com.lzy.okgo.cookie.store.DBCookieStore;
import com.lzy.okgo.interceptor.HttpLoggingInterceptor;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import okhttp3.OkHttpClient;
/**
* Created by Administrator on 2019/2/27 0027
*
* Desc:init okgo
*/
public class Myapplication extends Application {
//设置全局context
private static Context sContext;
@Override
public void onCreate() {
super.onCreate();
sContext = getApplicationContext();
initOkGo();
}
public static Context getContext(){
return sContext;
}
//初始化okgo
private void initOkGo() {
//---------这里给出的是示例代码,告诉你可以这么传,实际使用的时候,根据需要传,不需要就不传-------------//
// 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", "这里支持中文参数");
//----------------------------------------------------------------------------------------//
OkHttpClient.Builder builder = new OkHttpClient.Builder();
//log相关
HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor("OkGo");
loggingInterceptor.setPrintLevel(HttpLoggingInterceptor.Level.BODY); //log打印级别，决定了log显示的详细程度
loggingInterceptor.setColorLevel(Level.INFO); //log颜色级别，决定了log在控制台显示的颜色
builder.addInterceptor(loggingInterceptor); //添加OkGo默认debug日志
//第三方的开源库，使用通知显示当前请求的log，不过在做文件下载的时候，这个库好像有问题，对文件判断不准确
//builder.addInterceptor(new ChuckInterceptor(this));
//超时时间设置，默认60秒
builder.readTimeout(OkGo.DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); //全局的读取超时时间
builder.writeTimeout(OkGo.DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); //全局的写入超时时间
builder.connectTimeout(OkGo.DEFAULT_MILLISECONDS, TimeUnit.MILLISECONDS); //全局的连接超时时间
//自动管理cookie（或者叫session的保持），以下几种任选其一就行
//builder.cookieJar(new CookieJarImpl(new SPCookieStore(this))); //使用sp保持cookie，如果cookie不过期，则一直有效
builder.cookieJar(new CookieJarImpl(new DBCookieStore(this))); //使用数据库保持cookie，如果cookie不过期，则一直有效
//builder.cookieJar(new CookieJarImpl(new MemoryCookieStore())); //使用内存保持cookie，app退出后，cookie消失
//https相关设置，以下几种方案根据需要自己设置
//方法一：信任所有证书,不安全有风险
// 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());
// 其他统一的配置
// 详细说明看GitHub文档：https://github.com/jeasonlzy/
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); //全局公共参数
}
/**
* 这里只是我谁便写的认证规则，具体每个业务是否需要验证，以及验证规则是什么，请与服务端或者leader确定
* 以下代码不要直接使用
*/
// private class SafeTrustManager implements X509TrustManager {
// @Override
// public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {
// }
//
// @Override
// public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {
// try {
// for (X509Certificate certificate : chain) {
// certificate.checkValidity(); //检查证书是否过期，签名是否通过等
// }
// } catch (Exception e) {
// throw new CertificateException(e);
// }
// }
//
// @Override
// public X509Certificate[] getAcceptedIssuers() {
// return new X509Certificate[0];
// }
// }
/**
* 这里只是我谁便写的认证规则，具体每个业务是否需要验证，以及验证规则是什么，请与服务端或者leader确定
* 以下代码不要直接使用
*/
// private class SafeHostnameVerifier implements HostnameVerifier {
// @Override
// public boolean verify(String hostname, SSLSession session) {
// //验证主机名是否匹配
// //return hostname.equals("server.jeasonlzy.com");
// return true;
// }
// }
}
四、请求配置
1、请求所有配置
重要的事情说三遍
无论做什么请求，第一行的泛型一定要加！！！
无论做什么请求，第一行的泛型一定要加！！！
无论做什么请求，第一行的泛型一定要加！！！
注意以下几点：
- 这里演示的是一次普通请求所有能配置的参数，真实使用时不需要配置这么多，按自己的需要选择性的使用即可
- 第一行的泛型一定要特别注意，这个表示你请求网络的数据类型是什么，必须指定，否则无法解析网络数据。
.post(url)：这个表示当前请求是post请求，当然一共支持GET，HEAD，OPTIONS，POST，PUT，DELETE, PATCH, TRACE这8种请求方式，你只需要改改这个方法名就行了，很方便。.params()：添加参数的时候,最后一个isReplace为可选参数,默认为true，即代表相同key的时候，后添加的会覆盖先前添加的。.tag(this)：请求的tag，用于标识当前的请求，方便后续取消对应的请求，如果你不需要取消请求，也可以不用设置。.isMultipart()：该方法表示是否强制使用multipart/form-data表单上传，因为该框架在有文件的时候，无论你是否设置这个参数，默认都是multipart/form-data格式上传，但是如果参数中不包含文件，默认使用application/x-www-form-urlencoded格式上传，如果你的服务器要求无论是否有文件，都要使用表单上传，那么可以用这个参数设置为true。.isSpliceUrl()：该方法表示是否强制将params的参数拼接到url后面，默认false不拼接。一般来说，post、put等有请求体的方法应该把参数都放在请求体中，不应该放在url上，但是有的服务端可能不太规范，url和请求体都需要传递参数，那么这时候就使用该参数，他会将你所有使用.params()方法传递的参数，自动拼接在url后面。.retryCount()：该方法是配置超时重连次数，也可以在全局初始化的时候设置，默认使用全局的配置，即为3次，你也可以在这里为你的这个请求特殊配置一个，并不会影响全局其他请求的超时重连次数。.cacheKey() .cacheTime() .cacheMode()：这三个是缓存相关的配置，详细请看缓存介绍.headers()：该方法是传递服务端需要的请求头，如果你不知道什么是请求头，看wiki首页关于网络抓包中的http协议链接。.params()：该方法传递键值对参数，格式也是http协议中的格式，详细参考上面的http协议连接。.addUrlParams() .addFileParams() .addFileWrapperParams()：这里是支持一个key传递多个文本参数，也支持一个key传递多个文件参数，详细也看上面的http协议连接。
另外，每个请求都有一个.client()方法可以传递一个OkHttpClient对象，表示当前这个请求将使用外界传入的这个OkHttpClient对象，其他的请求还是使用全局的保持不变。那么至于这个OkHttpClient你想怎么配置，或者配置什么东西，那就随意了是不，改个超时时间，加个拦截器什么的统统都是可以的，看你心情喽。
特别注意： 如果你的当前请求使用的是你传递的OkHttpClient对象的话，那么当你调用OkGo.getInstance().cancelTag(tag)的时候，是取消不了这个请求的，因为OkGo只能取消使用全局配置的请求，不知道你这个请求是用你自己的OkHttpClient的，如果一定要取消，可以是使用OkGo提供的重载方法，详细看下方的取消请求的部分。
2、请求封装
import android.content.Context;
import android.util.Log;
import com.lzy.okgo.OkGo;
import com.lzy.okgo.cache.CacheMode;
import com.lzy.okgo.callback.AbsCallback;
import com.lzy.okgo.callback.FileCallback;
import com.lzy.okgo.callback.StringCallback;
import com.lzy.okgo.model.Progress;
import com.lzy.okgo.model.Response;
import com.lzy.okgo.request.base.Request;
import java.io.File;
/**
* Created by Administrator on 2019/2/27 0027
*
* Desc:down and upload
*/
public class httpUtils {
private static final String TAG = httpUtils.class.getName();
/**
* get请求获取数据
*
* @param url
*/
private void getByOkGo(String url) {
OkGo.get("url")//
.tag(this)
.params("adKind","1")//传入请求参数
.cacheKey("cachekey")//作为缓存的key
.cacheMode(CacheMode.NO_CACHE)//设置缓存模式
//StringCallback只返回成功
.execute(new StringCallback() {
@Override
public void onSuccess(Response response) {
}
@Override//适配器模式,可以不实现该方法
public void onError(Response response) {
}
});
}
/**
* post请求
* @param url
*/
private void postByOkGo(String url){
OkGo.post(url)
.tag(this)
.params("key", "v")
.execute(new AbsCallback() {
@Override
public void onSuccess(Response response) {
}
@Override
public String convertResponse(okhttp3.Response response) throws Throwable {
return null;
}
});
}
/**
* @param context 上下文
* @param fileUrl 下载完整url
* @param destFileDir SD路径
* @param destFileName 文件名
* @param mFileRelativeUrl 下载相对地址
* （我们从服务器端获取到的数据都是相对的地址）例如： "filepath": "/movie/20180511/1526028508.txt"
*/
private static String mBasePath; //本地文件存储的完整路径 /storage/emulated/0/book/a.txt
public static void downloadFile(Context context, String fileUrl, String destFileDir, String destFileName, String mFileRelativeUrl){
String mDestFileName =destFileName+mFileRelativeUrl.substring(mFileRelativeUrl.lastIndexOf("."),mFileRelativeUrl.length());
OkGo.get(fileUrl).tag(context).execute(new FileCallback(destFileDir,mDestFileName) { //文件下载时指定下载的路径以及下载的文件的名称
@Override
public void onStart(Request request) {
super.onStart(request);
Log.d(TAG,"开始下载文件");
}
@Override
public void onSuccess(com.lzy.okgo.model.Response response) {
Log.d(TAG,"下载文件成功:"+response.body().length());
mBasePath=response.body().getAbsolutePath();
}
@Override
public void onFinish() {
super.onFinish();
Log.d(TAG,"下载文件完成");
}
@Override
public void onError(com.lzy.okgo.model.Response response) {
super.onError(response);
Log.e(TAG,"下载文件出错:"+response.message());
}
@Override
public void downloadProgress(Progress progress) {
super.downloadProgress(progress);
float dLProgress= progress.fraction;
Log.d(TAG,"文件下载的进度:"+dLProgress);
}
});
}
}