OkGo使用分享
OkGo这个框架可能很多人听过，但是okHttp开发安卓的人士一定听过，可能还在使用。现在最火的两个框架一个是OkHttp另一个是Retrofit，Retrofit用过一次感觉不太好，主要是我同学没有封装好用起来一点都不顺，所以对Retrofit就没啥好感了。
闲话不多说我们进入正题
OkGo使用步骤：
一、导包
github项目：https://github.com/jeasonlzy/okhttp-OkGo
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'
Eclipse的用户(赶紧换AS吧)，可以选择添加本项目根目录中/jar目录下的jar包:
一般来说，至少需要okhttp、okio、okgo三个jar包，其余的三个扩展jar包根据自己的需要选择添加！！！
必须使用
以下三个选择添加，okrx和okrx2不能同时使用
二、初始化
在自己的Application的onCreate方法里面初始化（上面的设置自己想要啥设置啥）
public class GAppextends Application {@Override public void onCreate() {super.onCreate(); initOkGo(); }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确定 * 这里只是我谁便写的认证规则，具体每个业务是否需要验证，以及验证规则是什么，请与服务端或者leader确定 * 这里只是我谁便写的认证规则，具体每个业务是否需要验证，以及验证规则是什么，请与服务端或者leader确定 * 重要的事情说三遍，以下代码不要直接使用 */ private class SafeTrustManagerimplements 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确定 * 这里只是我谁便写的认证规则，具体每个业务是否需要验证，以及验证规则是什么，请与服务端或者leader确定 * 这里只是我谁便写的认证规则，具体每个业务是否需要验证，以及验证规则是什么，请与服务端或者leader确定 * 重要的事情说三遍，以下代码不要直接使用 */ private class SafeHostnameVerifierimplements HostnameVerifier {@Override public boolean verify(String hostname, SSLSession session) {//验证主机名是否匹配 //return hostname.equals("server.jeasonlzy.com"); return true; } }}
三、请求网络数据 (这里要注意了params（）这个方法可以传递map集合 如果你使用这样穿第参数的话会接收不到返回结果 你可以用HttpParams（）对象包一层就好了)
Get方式:
OkGo.get(Urls.URL_METHOD)// .tag(this)// .headers("header1", "headerValue1")// .params("param1", "paramValue1")// .execute(new StringCallback() {@Override public void onSuccess(Response response) {//注意这里已经是在主线程了 String data = response.body();//这个就是返回来的结果 }@Override public void onError(Response response) {super.onError(response); } });
post方式:(这里要注意了params（）这个方法可以传递map集合 如果你使用这样穿第参数的话会接收不到返回结果 你可以用HttpParams（）对象包一层就好了)
OkGo.post("http://gprs.syxzlg.com/Device/getdeviceList.html")// .tag(this)// .headers("header1", "headerValue1")// .params("uid", "paramValue1")// .isMultipart(true)//强制使用 multipart/form-data 表单上传（只是演示，不需要的话不要设置。默认就是false） .execute(new StringCallback() {@Override public void onSuccess(Response response) {//注意这里已经是在主线程了 String data = response.body();//这个就是返回来的结果 }@Override public void onError(Response response) {super.onError(response); } });
注意：上面有一setTag()方法看起来没啥用 其实他是用来取消网络请求用的 ，传递的参数就是这次网络的标识。那如何中
断此次请求呢
OkGo.cancelTag(OkGo.getInstance().getOkHttpClient(),tag);
四、文件上传(这里要注意了params（）这个方法可以传递map集合 如果你使用这样穿第参数的话会接收不到返回结果 你可以用HttpParams（）对象包一层就好了)
//拼接参数 OkGo.post("http://gprs.syxzlg.com/User/uploadImage")// .tag(this)// .headers("header1", "headerValue1")// .headers("header2", "headerValue2")// .params("param1", "paramValue1")// .params("param2", "paramValue2")//// .params("file1",new File("文件路径")) //这种方式为一个key，对应一个文件// .params("file2",new File("文件路径"))// .params("file3",new File("文件路径")) .addFileParams("filename", files)// 这种方式为同一个key，上传多个文件 .execute(new JsonCallback() {@Override public void onStart(Request request) {btnFormUpload.setText("正在上传中..."); }@Override public void onSuccess(Response response) {btnFormUpload.setText("上传完成"+response.body()); }@Override public void onError(Response response) {btnFormUpload.setText("上传出错"); }@Override public void uploadProgress(Progress progress) { System.out.println("uploadProgress: " + progress); } });
五、文件下载(这里要注意了params（）这个方法可以传递map集合 如果你使用这样穿第参数的话会接收不到返回结果 你可以用HttpParams（）对象包一层就好了)
OkGo.get(Urls.URL_DOWNLOAD)// .tag(this)// .headers("header1", "headerValue1")// .params("param1", "paramValue1")// .execute(new FileCallback("OkGo.apk") {@Override public void onStart(Request request) {btnFileDownload.setText("正在下载中"); }@Override public void onSuccess(Response response) {btnFileDownload.setText("下载完成"+response.body()); }@Override public void onError(Response response) {btnFileDownload.setText("下载出错"); }@Override public void downloadProgress(Progress progress) { System.out.println(progress); } });
网友评论