Android(安卓)Okhttp3了解及封装类使用

1.为什么要使用okhttp？

使用范围 OkHttp支持Android 2.3及其以上版本。对于java JDK1.7以上。官方英文网站 https://github.com/square/okhttp/wiki/Recipes 中文社区 http://www.cnblogs.com/ct2011/p/3997368.html Android系统提供了两种HTTP通信类，HttpURLConnection和HttpClient。关于HttpURLConnection和HttpClient的选择>>官方博客尽管Google在大部分安卓版本中推荐使用HttpURLConnection，但是这个类相比HttpClient实在是太难用，太弱爆了。 OkHttp是一个相对成熟的解决方案，据说Android4.4的源码中可以看到HttpURLConnection已经替换成OkHttp实现了。所以我们更有理由相信OkHttp的强大。

okhttp的优点和不足

1、优点

支持SPDY, 可以合并多个到同一个主机的请，使用连接池技术减少请求的延迟(如果SPDY是可用的

话) ，

SPDY协议是Google提出的基于传输控制协议(TCP)的应用层协议，通过压缩、多路复用和优先级来缩短加载时间。该协议是一种更加快速的内容传输协议。

使用GZIP压缩减少传输的数据量，缓存响应避免重复的网络请求、拦截器等等。

2、缺点

第一缺点是消息回来需要切到主线程，主线程要自己去写，第二传入调用比较复杂。

okhttp 的机制原理

OKHttp是一款高效的HTTP客户端，支持连接同一地址的链接共享同一个socket，通过连接池来减小响应延迟，

还有透明的GZIP压缩，请求缓存等优势，其核心主要有路由、连接协议、拦截器、代理、安全性认证、连接池以

及网络适配，拦截器主要是指添加，移除或者转换请求或者回应的头部信息，总流程图如下：

简单的使用

第1步导入依赖添加权限

  compile 'com.squareup.okio:okio:1.5.0'    compile 'com.squareup.okhttp3:okhttp:3.2.0'    compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'    compile 'com.google.code.gson:gson:2.8.2'

设置权限

第二步导入封装好的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 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 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 cls = null;        Class clz = this.getClass();        ParameterizedType type = (ParameterizedType) clz.getGenericSuperclass();        Type[] types = type.getActualTypeArguments();        cls = (Class) 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 implements Callback {    private Handler handler = OkHttp3Utils.getInstance().getHandler();    //主线程处理    public abstract void onUi(List 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 mList = new ArrayList();        String json = response.body().string();        JsonArray array = new JsonParser().parse(json).getAsJsonArray();        Gson gson = new Gson();        Class cls = null;        Class clz = this.getClass();        ParameterizedType type = (ParameterizedType) clz.getGenericSuperclass();        Type[] types = type.getActualTypeArguments();        cls = (Class) 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() {            //主线程处理            @Override            public void onUi(NewsBean newsBean) {                List newslist = newsBean.getNewslist();                mtextview.setText(newslist.get(0).getTitle());                Log.d("main",newslist.toString());            }            //请求失败            @Override            public void onFailed(Call call, IOException e) {            }        });    }}