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);
            }
        });
    }
 
}