android 简单网络请求okgo
github地址：https://github.com/jeasonlzy/okhttp-OkGo
官方文档：https://github.com/jeasonlzy/okhttp-OkGo/wiki
implementation 'com.lzy.net:okgo:3.0.4' implementation 'com.lzy.net:okrx2:2.0.2' implementation 'com.lzy.net:okserver:2.0.5'
import android.app.Application; import com.lzy.okgo.OkGo; public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); OkGo.getInstance().init(this); } }
选配
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; /** * <p> * 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; // } // } }
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; /** * <p> * Desc:down and upload */ public class httpUtils { private static final String TAG = httpUtils.class.getName(); /** * get请求获取数据 * * @param url */ private void getByOkGo(String url) { OkGo.<String>get("url")// .tag(this) .params("adKind","1")//传入请求参数 .cacheKey("cachekey")//作为缓存的key .cacheMode(CacheMode.NO_CACHE)//设置缓存模式 //StringCallback只返回成功 .execute(new StringCallback() { @Override public void onSuccess(Response<String> response) { } @Override//适配器模式,可以不实现该方法 public void onError(Response<String> response) { } }); } /** * post请求 * @param url */ private void postByOkGo(String url){ OkGo.<String>post(url) .tag(this) .params("key", "v") .execute(new AbsCallback<String>() { @Override public void onSuccess(Response<String> 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.<File>get(fileUrl).tag(context).execute(new FileCallback(destFileDir,mDestFileName) { //文件下载时指定下载的路径以及下载的文件的名称 @Override public void onStart(Request<File, ? extends Request> request) { super.onStart(request); Log.d(TAG,"开始下载文件"); } @Override public void onSuccess(com.lzy.okgo.model.Response<File> 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<File> 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); } }); } }
