1. 程式人生 > >Android Okhttp3瞭解及封裝類使用

Android Okhttp3瞭解及封裝類使用

<uses-permission android:name="android.permission.INTERNET"></uses-permission>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"></uses-permission>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"></uses-permission>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>

第二步匯入封裝好的4個工具

okhttp3utils(封裝網路請求類,doget,dopost)

import android.content.Context;
import android.content.Intent;
import android.net.Uri;
import android.os.Environment;
import android.os.Handler;
import android.util.Log;

import com.bwei.okhttpdemo.app.MyApp;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
import java.util.concurrent.TimeUnit;

import okhttp3.Cache;
import okhttp3.CacheControl;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.FormBody;
import okhttp3.Interceptor;
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
import okhttp3.logging.HttpLoggingInterceptor;

/**
 * 1. 類的用途 封裝OkHttp3的工具類 用單例設計模式
 * 2. @author forever
 * 3. @date 2017/9/6 09:19
 */

public class OkHttp3Utils {
    /**
     * 懶漢 安全 加同步
     * 私有的靜態成員變數 只宣告不建立
     * 私有的構造方法
     * 提供返回例項的靜態方法
     */

    private static OkHttp3Utils okHttp3Utils = null;

    private OkHttp3Utils() {
    }

    public static OkHttp3Utils getInstance() {
        if (okHttp3Utils == null) {
            //加同步安全
            synchronized (OkHttp3Utils.class) {
                if (okHttp3Utils == null) {
                    okHttp3Utils = new OkHttp3Utils();
                }
            }

        }

        return okHttp3Utils;
    }

    private static OkHttpClient okHttpClient = null;

    public synchronized static OkHttpClient getOkHttpClient() {
        if (okHttpClient == null) {
            //判空 為空建立例項
            // okHttpClient = new OkHttpClient();
/**
 * 和OkHttp2.x有區別的是不能通過OkHttpClient直接設定超時時間和快取了,而是通過OkHttpClient.Builder來設定,
 * 通過builder配置好OkHttpClient後用builder.build()來返回OkHttpClient,
 * 所以我們通常不會呼叫new OkHttpClient()來得到OkHttpClient,而是通過builder.build():
 */
            //  File sdcache = getExternalCacheDir();
            //快取目錄
            File sdcache = new File(Environment.getExternalStorageDirectory(), "cache");
            int cacheSize = 10 * 1024 * 1024;
            //OkHttp3攔截器
            HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
                @Override
                public void log(String message) {
                    Log.i("xxx", message.toString());
                }
            });
            //Okhttp3的攔截器日誌分類 4種
            httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);


            okHttpClient = new OkHttpClient.Builder().connectTimeout(15, TimeUnit.SECONDS)
                    //新增OkHttp3的攔截器
                    .addInterceptor(httpLoggingInterceptor)
                    .addNetworkInterceptor(new CacheInterceptor())
                    .writeTimeout(20, TimeUnit.SECONDS).readTimeout(20, TimeUnit.SECONDS)
                    .cache(new Cache(sdcache.getAbsoluteFile(), cacheSize))
                    .build();
        }
        return okHttpClient;
    }

    private static Handler mHandler = null;

    public synchronized static Handler getHandler() {
        if (mHandler == null) {
            mHandler = new Handler();
        }

        return mHandler;
    }

    /**
     * get請求
     * 引數1 url
     * 引數2 回撥Callback
     */

    public static void doGet(String url, Callback callback) {

        //建立OkHttpClient請求物件
        OkHttpClient okHttpClient = getOkHttpClient();
        //建立Request
        Request request = new Request.Builder().url(url).build();
        //得到Call物件
        Call call = okHttpClient.newCall(request);
        //執行非同步請求
        call.enqueue(callback);


    }

    /**
     * post請求
     * 引數1 url
     * 引數2 回撥Callback
     */

    public static void doPost(String url, Map<String, String> params, Callback callback) {

        //建立OkHttpClient請求物件
        OkHttpClient okHttpClient = getOkHttpClient();
        //3.x版本post請求換成FormBody 封裝鍵值對引數

        FormBody.Builder builder = new FormBody.Builder();
        //遍歷集合
        for (String key : params.keySet()) {
            builder.add(key, params.get(key));

        }


        //建立Request
        Request request = new Request.Builder().url(url).post(builder.build()).build();

        Call call = okHttpClient.newCall(request);
        call.enqueue(callback);

    }

    /**
     * post請求上傳檔案
     * 引數1 url
     * 引數2 回撥Callback
     */
    public static void uploadPic(String url, File file, String fileName) {
        //建立OkHttpClient請求物件
        OkHttpClient okHttpClient = getOkHttpClient();
        //建立RequestBody 封裝file引數
        RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);
        //建立RequestBody 設定型別等
        RequestBody requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM).addFormDataPart("file", fileName, fileBody).build();
        //建立Request
        Request request = new Request.Builder().url(url).post(requestBody).build();

        //得到Call
        Call call = okHttpClient.newCall(request);
        //執行請求
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                //上傳成功回撥 目前不需要處理
            }
        });

    }

    /**
     * Post請求傳送JSON資料
     * 引數一:請求Url
     * 引數二:請求的JSON
     * 引數三:請求回撥
     */
    public static void doPostJson(String url, String jsonParams, Callback callback) {
        RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), jsonParams);
        Request request = new Request.Builder().url(url).post(requestBody).build();
        Call call = getOkHttpClient().newCall(request);
        call.enqueue(callback);


    }

    /**
     * 下載檔案 以流的形式把apk寫入的指定檔案 得到file後進行安裝
     * 引數一:請求Url
     * 引數二:儲存檔案的路徑名
     * 引數三:儲存檔案的檔名
     */
    public static void download(final Context context, final String url, final String saveDir) {
        Request request = new Request.Builder().url(url).build();
        Call call = getOkHttpClient().newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                Log.i("xxx", e.toString());
            }

            @Override
            public void onResponse(Call call, final Response response) throws IOException {

                InputStream is = null;
                byte[] buf = new byte[2048];
                int len = 0;
                FileOutputStream fos = null;
                try {
                    is = response.body().byteStream();
                    //apk儲存路徑
                    final String fileDir = isExistDir(saveDir);
                    //檔案
                    File file = new File(fileDir, getNameFromUrl(url));
                    fos = new FileOutputStream(file);
                    while ((len = is.read(buf)) != -1) {
                        fos.write(buf, 0, len);
                    }
                    fos.flush();
                    //apk下載完成後 呼叫系統的安裝方法
                    Intent intent = new Intent(Intent.ACTION_VIEW);
                    intent.setDataAndType(Uri.fromFile(file), "application/vnd.android.package-archive");
                    context.startActivity(intent);
                } catch (IOException e) {
                    e.printStackTrace();
                } finally {
                    if (is != null) is.close();
                    if (fos != null) fos.close();


                }
            }
        });

    }

    /**
     * @param saveDir
     * @return
     * @throws IOException 判斷下載目錄是否存在
     */
    public static String isExistDir(String saveDir) throws IOException {
        // 下載位置
        if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {

            File downloadFile = new File(Environment.getExternalStorageDirectory(), saveDir);
            if (!downloadFile.mkdirs()) {
                downloadFile.createNewFile();
            }
            String savePath = downloadFile.getAbsolutePath();
            Log.e("savePath", savePath);
            return savePath;
        }
        return null;
    }

    /**
     * @param url
     * @return 從下載連線中解析出檔名
     */
    private static String getNameFromUrl(String url) {
        return url.substring(url.lastIndexOf("/") + 1);
    }

    /**
     * 為okhttp新增快取,這裡是考慮到伺服器不支援快取時,從而讓okhttp支援快取
     */
    private static class CacheInterceptor implements Interceptor {
        @Override
        public Response intercept(Chain chain) throws IOException {
            // 有網路時 設定快取超時時間1個小時
            int maxAge = 60 * 60;
            // 無網路時,設定超時為1天
            int maxStale = 60 * 60 * 24;
            Request request = chain.request();
            if (NetWorkUtils.isNetWorkAvailable(MyApp.getInstance())) {
                //有網路時只從網路獲取
                request = request.newBuilder().cacheControl(CacheControl.FORCE_NETWORK).build();
            } else {
                //無網路時只從快取中讀取
                request = request.newBuilder().cacheControl(CacheControl.FORCE_CACHE).build();
               /* Looper.prepare();
                Toast.makeText(MyApp.getInstance(), "走攔截器快取", Toast.LENGTH_SHORT).show();
                Looper.loop();*/
            }
            Response response = chain.proceed(request);
            if (NetWorkUtils.isNetWorkAvailable(MyApp.getInstance())) {
                response = response.newBuilder()
                        .removeHeader("Pragma")
                        .header("Cache-Control", "public, max-age=" + maxAge)
                        .build();
            } else {
                response = response.newBuilder()
                        .removeHeader("Pragma")
                        .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
                        .build();
            }
            return response;
        }
    }
}

封裝判斷網路

import android.content.Context;
import android.net.ConnectivityManager;
import android.net.NetworkInfo;

/**
 * 1. 類的用途 聯網判斷
 * 2. @author forever
 * 3. @date 2017/9/8 12:30
 */

public class NetWorkUtils {
    //判斷網路是否連線
    public static boolean isNetWorkAvailable(Context context) {
        //網路連線管理器
        ConnectivityManager connectivityManager = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
        //網路資訊
        NetworkInfo info = connectivityManager.getActiveNetworkInfo();
        if (info != null) {
            return true;
        }

        return false;
    }

}

GsonobjectCallbak封裝主執行緒ul更新並且解析物件json串
import android.os.Handler;

import com.google.gson.Gson;

import java.io.IOException;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.Response;

/**
 * 1. 類的用途 如果要將得到的json直接轉化為集合 建議使用該類
 * 該類的onUi() onFailed()方法執行在主執行緒
 * 2. @author forever
 * 3. @date 2017/9/24 18:47
 */

public abstract class GsonObjectCallback<T> implements Callback {
    private Handler handler = OkHttp3Utils.getInstance().getHandler();



    //主執行緒處理
    public abstract void onUi(T t);

    //主執行緒處理
    public abstract void onFailed(Call call, IOException e);

    //請求失敗
    @Override
    public void onFailure(final Call call, final IOException e) {
        handler.post(new Runnable() {
            @Override
            public void run() {
                onFailed(call, e);
            }
        });
    }

    //請求json 並直接返回泛型的物件 主執行緒處理
    @Override
    public void onResponse(Call call, Response response) throws IOException {
        String json = response.body().string();
        Class<T> cls = null;

        Class clz = this.getClass();
        ParameterizedType type = (ParameterizedType) clz.getGenericSuperclass();
        Type[] types = type.getActualTypeArguments();
        cls = (Class<T>) types[0];
        Gson gson = new Gson();
        final T t = gson.fromJson(json, cls);
        handler.post(new Runnable() {
            @Override
            public void run() {
            onUi(t);
            }
        });
    }
}

GsonoArrayCallbak封裝主執行緒ul更新並且解析Arrayjson字串

import android.os.Handler;

import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;

import java.io.IOException;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.Response;

/**
 * 1. 類的用途 如果要將得到的json直接轉化為集合 建議使用該類
 * 該類的onUi() onFailed()方法執行在主執行緒
 * 2. @author forever
 * 3. @date 2017/9/24 18:47
 */

public abstract class GsonArrayCallback<T> implements Callback {
    private Handler handler = OkHttp3Utils.getInstance().getHandler();

    //主執行緒處理
    public abstract void onUi(List<T> list);

    //主執行緒處理
    public abstract void onFailed(Call call, IOException e);

    //請求失敗
    @Override
    public void onFailure(final Call call, final IOException e) {
        handler.post(new Runnable() {
            @Override
            public void run() {
                onFailed(call, e);
            }
        });
    }

    //請求json 並直接返回集合 主執行緒處理
    @Override
    public void onResponse(Call call, Response response) throws IOException {
        final List<T> mList = new ArrayList<T>();

        String json = response.body().string();
        JsonArray array = new JsonParser().parse(json).getAsJsonArray();

        Gson gson = new Gson();

        Class<T> cls = null;
        Class clz = this.getClass();
        ParameterizedType type = (ParameterizedType) clz.getGenericSuperclass();
        Type[] types = type.getActualTypeArguments();
        cls = (Class<T>) types[0];

        for(final JsonElement elem : array){
            //迴圈遍歷把物件新增到集合
            mList.add((T) gson.fromJson(elem, cls));
        }

            handler.post(new Runnable() {
                @Override
                public void run() {
                    onUi(mList);



                }
            });


    }
}
初始化

在AndroidManifest.xml 裡application 配置

android:name=".app.MyApp"

import android.app.Application;

/**
 * 1. 類的用途
 * 2. @author forever
 * 3. @date 2017/9/8 12:33
 */

public class MyApp extends Application {
    public static MyApp mInstance;
    @Override
    public void onCreate() {
        super.onCreate();
        mInstance = this;

    }
    public static MyApp getInstance() {
        return mInstance;
    }
}
上面完事之後就可以使用請求資料了
public class MainActivity extends AppCompatActivity {

    TextView mtextview;

    String url="http://api.tianapi.com/social/?key=71e58b5b2f930eaf1f937407acde08fe&num=20";
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mtextview=(TextView) findViewById(R.id.text);


        /*判斷網路是否連線*/
        boolean netWorkAvailable = NetWorkUtils.isNetWorkAvailable(this);
        if(!netWorkAvailable){

            Toast.makeText(this, "連網:"+netWorkAvailable, Toast.LENGTH_SHORT).show();
        }

        getData();

    }

    private void getData() {

        /**
         * get請求
         * 引數1 url
         * 引數2 回撥Callback
         */
        OkHttp3Utils.getInstance().doGet(url, new GsonObjectCallback<NewsBean>() {

            //主執行緒處理
            @Override
            public void onUi(NewsBean newsBean) {
                List<NewsBean.NewslistBean> newslist = newsBean.getNewslist();
                mtextview.setText(newslist.get(0).getTitle());
                Log.d("main",newslist.toString());
            }

            //請求失敗
            @Override
            public void onFailed(Call call, IOException e) {

            }
        });

    }


}