Android网络编程Okhttp3用法详解

最新推荐文章于 2024-08-15 20:31:04 发布
最新推荐文章于 2024-08-15 20:31:04 发布
阅读量8.5k 收藏 12
点赞数 4
文章标签： Android okhttp 网络请求 网络编程
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/baidu_33634330/article/details/77680289
版权

   okHttp、volley、android-async-http对比：

  • volley是一个简单的异步http库，仅此而已。缺点是不支持同步，这点会限制开发模式；不能post大数据，所以不适合用来上传文件
  • android-async-http。与volley一样是异步网络库，但volley是封装的httpUrlConnection，它是封装的httpClient，而android平台不推荐用HttpClient了，所以这个库已经不适合android平台了。
  • okhttp是高性能的http库，支持同步、异步，而且实现了spdy、http2、websocket协议，api很简洁易用，和volley一样实现了http协议的缓存。

   okHttp介绍：

      通过上面的对比说明，让你不得不做出明智的选择，OkHttp是一个相对成熟的解决方案，据说Android4.4的源码中可以看到HttpURLConnection已经替换成OkHttp实现了，所以决定选择采用okhttp。

      官网地址：http://square.github.io/okhttp/

      官方API地址：http://m.blog.csdn.net/article/details?id=50747352

      github源码地址：https://github.com/square/okhttp

   okHttp主要类：

       1.)OkHttpClient.java

       2.)Request.java

       3.)Call.java

       4.)RequestBody.java

       5.)Response.java

 

OkHttp3使用：

1.在build.gradle中添加引用

 

    compile 'com.squareup.okhttp3:okhttp:3.2.0'
    compile 'com.squareup.okio:okio:1.7.0'

 

2.在manifest中添加网络权限

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

 

3.创建一个OkHttpManager类

   OkHttpManager.java 属性

private static final String TAG = OkHttpManager.class.getSimpleName();
    private static final MediaType MEDIA_TYPE_JSON = MediaType.parse("application/x-www-form-urlencoded; charset=utf-8");//mdiatype 这个需要和服务端保持一致
    //下面两个随便用哪个都可以
    //    private static final MediaType MEDIA_TYPE_FILE = MediaType.parse("application/octet-stream");
    private static final MediaType MEDIA_TYPE_FILE = MediaType.parse("image/jpg");
    private static volatile OkHttpManager mInstance;//单利引用
    private OkHttpClient mOkHttpClient;//okHttpClient 实例
    private Handler okHttpHandler;//全局处理子线程和M主线程通信

   OkhttpManager.java 构造函数

/** * 初始化OkHttpManager */ 
public OkHttpManager(Context context) { //初始化OkHttpClient 
mOkHttpClient = new OkHttpClient().newBuilder() 
.connectTimeout(10, TimeUnit.SECONDS)//设置超时时间 
.readTimeout(10, TimeUnit.SECONDS)//设置读取超时时间 
.writeTimeout(10, TimeUnit.SECONDS)//设置写入超时时间 
.build(); 
//初始化Handler 
okHttpHandler = new Handler(context.getMainLooper()); 
}

   OkHttpManager.java 获取单利引用 这里用到了双重检查锁实现单例

/** * 获取单例引用 * * @return */
 public static OkHttpManager getInstance(Context context) { 
    OkHttpManager inst = mInstance; 
        if (inst == null) { 
            synchronized (OkHttpManager.class) { 
            inst = mInstance; 
                if (inst == null) { 
                    inst = new OkHttpManager(context.getApplicationContext());
                     mInstance = inst; 
                }
         } 
    } 
    return inst; 
}

4.实现okHttp同步请求
   okHttp get同步请求

/** * 1.1 okHttp get同步请求 * * @param actionUrl 接口地址 * @param paramsMap 请求参数 */ public void getBySyn(String actionUrl, Map<String, Object> paramsMap) { StringBuilder tempParams = new StringBuilder(); try { //处理参数 int pos = 0; for (String key : paramsMap.keySet()) { if (pos > 0) { tempParams.append("&"); } //对参数进行URLEncoder tempParams.append(String.format("%s=%s", key, URLEncoder.encode(paramsMap.get(key).toString(), "utf-8"))); pos++; } //补全请求地址 这里的Config.SERVER_ADDRESS改成自己的BaseUrl String requestUrl = String.format("%s%s?%s", Config.SERVER_ADDRESS, actionUrl, tempParams.toString()); //创建一个请求 Request request = addHeaders().url(requestUrl).build(); //创建一个Call final Call call = mOkHttpClient.newCall(request); //执行请求 final Response response = call.execute(); response.body().string(); } catch (Exception e) { Log.e(TAG, e.toString()); } }

   okHttp post同步请求

/** * 1.2 okHttp post同步请求 * * @param actionUrl 接口地址 * @param paramsMap 请求参数 */ public void postBySyn(String actionUrl, Map<String, Object> paramsMap) { try { //处理参数 StringBuilder tempParams = new StringBuilder(); int pos = 0; for (String key : paramsMap.keySet()) { if (pos > 0) { tempParams.append("&"); } tempParams.append(String.format("%s=%s", key, URLEncoder.encode(paramsMap.get(key).toString(), "utf-8"))); pos++; } //补全请求地址 String requestUrl = String.format("%s%s", Config.SERVER_ADDRESS, actionUrl); //生成参数 String params = tempParams.toString(); //创建一个请求实体对象 RequestBody RequestBody body = RequestBody.create(MEDIA_TYPE_JSON, params); //创建一个请求 final Request request = addHeaders().url(requestUrl).post(body).build(); //创建一个Call final Call call = mOkHttpClient.newCall(request); //执行请求 Response response = call.execute(); //请求执行成功 if (response.isSuccessful()) { //获取返回数据 可以是String，bytes ,byteStream Log.e(TAG, "response ----->" + response.body().string()); } } catch (Exception e) { Log.e(TAG, e.toString()); } }

  okHttp post同步请求表单提交

/** * 1.3 okHttp post同步请求表单提交 * * @param actionUrl 接口地址 * @param paramsMap 请求参数 */ private void postBySynWithForm(String actionUrl, Map<String, Object> paramsMap) { try { //创建一个FormBody.Builder FormBody.Builder builder = new FormBody.Builder(); for (String key : paramsMap.keySet()) { //追加表单信息 builder.add(key, paramsMap.get(key).toString()); } //生成表单实体对象 RequestBody formBody = builder.build(); //补全请求地址 String requestUrl = String.format("%s%s", Config.SERVER_ADDRESS, actionUrl); //创建一个请求 final Request request = addHeaders().url(requestUrl).post(formBody).build(); //创建一个Call final Call call = mOkHttpClient.newCall(request); //执行请求 Response response = call.execute(); if (response.isSuccessful()) { Log.e(TAG, "response ----->" + response.body().string()); } } catch (Exception e) { Log.e(TAG, e.toString()); } }

5.实现okHttp异步请求

  okHttp get异步请求

    /**
     * 2.1 okHttp get异步请求
     *
     * @param actionUrl 接口地址
     * @param paramsMap 请求参数
     * @param callBack  请求返回数据回调
     * @return
     */
    public void getByAsyn(String actionUrl, Map<String, Object> paramsMap, final OkHttpCallback callBack) {
        StringBuilder tempParams = new StringBuilder();
        try {
            int pos = 0;
            for (String key : paramsMap.keySet()) {
                if (pos > 0) {
                    tempParams.append("&");
                }
                tempParams.append(String.format("%s=%s", key, URLEncoder.encode(paramsMap.get(key).toString(), "utf-8")));
                pos++;
            }
            //http://117.78.49.154:18083/userproduct/api/4.0.0/config/getConfig
            String requestUrl = String.format("%s%s?%s", Config.SERVER_ADDRESS, actionUrl, tempParams.toString());
            Log.i(TAG, "requestUrl=" + requestUrl);
            final Request request = addHeaders().url(requestUrl).build();
            final Call call = mOkHttpClient.newCall(request);
            call.enqueue(new Callback() {
                @Override
                public void onFailure(Call call, IOException e) {
                    onFailedCallBack(e, callBack);
                }

                @Override
                public void onResponse(Call call, Response response) throws IOException {
                    if (response.isSuccessful()) {
                        try {
                            Log.i(TAG, "onResponse response=" + response);
                            String responseStr = response.body().string();
                            Log.i(TAG, "onResponse responseStr=" + responseStr);
                            JSONObject oriData = new JSONObject(responseStr.trim());
                            ServerResponse serverResponse = ServerResponse.parseFromResponse(oriData);
                            //回调
                            onSuccessCallBack(oriData, serverResponse, callBack);
                        } catch (Exception e) {
                            e.printStackTrace();
                        }
                    }
                }
            });
        } catch (Exception e) {
            Log.e(TAG, e.toString());
        }
    }

  okHttp post异步请求

/** * 2.2 okHttp post异步请求 * * @param actionUrl 接口地址 * @param paramsMap 请求参数 * @param callBack 请求返回数据回调 * @return */ public void postByAsyn(String actionUrl, Map<String, Object> paramsMap, final OkHttpCallback callBack) { try { StringBuilder tempParams = new StringBuilder(); int pos = 0; for (String key : paramsMap.keySet()) { if (pos > 0) { tempParams.append("&"); } tempParams.append(String.format("%s=%s", key, URLEncoder.encode(paramsMap.get(key).toString(), "utf-8"))); pos++; } String params = tempParams.toString(); RequestBody body = RequestBody.create(MEDIA_TYPE_JSON, params); String requestUrl = String.format("%s%s", Config.SERVER_ADDRESS, actionUrl); final Request request = addHeaders().url(requestUrl).post(body).build(); final Call call = mOkHttpClient.newCall(request); call.enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { onFailedCallBack(e, callBack); } @Override public void onResponse(Call call, Response response) throws IOException { if (response.isSuccessful()) { try { String responseStr = response.body().string(); Log.i(TAG, "onResponse responseStr=" + responseStr); JSONObject oriData = new JSONObject(responseStr.trim()); ServerResponse serverResponse = ServerResponse.parseFromResponse(oriData); onSuccessCallBack(oriData, serverResponse, callBack); } catch (Exception e) { e.printStackTrace(); } } } }); } catch (Exception e) { Log.e(TAG, e.toString()); } }

   okHttp post异步请求表单提交

/** * 2.3 okHttp post异步请求表单提交 * * @param actionUrl 接口地址 * @param paramsMap 请求参数 * @param callBack 请求返回数据回调 * @return */ public void postByAsynWithForm(String actionUrl, Map<String, Object> paramsMap, final OkHttpCallback callBack) { try { FormBody.Builder builder = new FormBody.Builder(); for (String key : paramsMap.keySet()) { builder.add(key, paramsMap.get(key).toString()); } RequestBody formBody = builder.build(); String requestUrl = String.format("%s%s", Config.SERVER_ADDRESS, actionUrl); final Request request = addHeaders().url(requestUrl).post(formBody).build(); final Call call = mOkHttpClient.newCall(request); call.enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { onFailedCallBack(e, callBack); } @Override public void onResponse(Call call, Response response) throws IOException { if (response.isSuccessful()) { try { String responseStr = response.body().string(); Log.i(TAG, "onResponse responseStr=" + responseStr); JSONObject oriData = new JSONObject(responseStr.trim()); ServerResponse serverResponse = ServerResponse.parseFromResponse(oriData); onSuccessCallBack(oriData, serverResponse, callBack); } catch (Exception e) { e.printStackTrace(); } } } }); } catch (Exception e) { Log.e(TAG, e.toString()); } }

   接口OkHttpCallback .java实现

public interface OkHttpCallback { /** * 响应成功 */ void onSuccess(JSONObject oriData, ServerResponse response); /** * 响应失败 */ void onFailure(IOException e); }

6.上传图片 带参数

public void postFiles(String actionUrl, Map<String, Object> paramsMap, Map<String, File> fileMap, final OkHttpCallback callBack) {
        MultipartBody.Builder requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM);

        //入参-字符串
        for (Map.Entry entry : paramsMap.entrySet()) {
            requestBody.addFormDataPart(entry.getKey().toString(), entry.getValue().toString());
        }
        //入参-文件
        for (Map.Entry entry : fileMap.entrySet()) {
            File file = (File) entry.getValue();
            RequestBody fileBody = RequestBody.create(MEDIA_TYPE_FILE, file);
            String fileName = file.getName();
            requestBody.addFormDataPart(entry.getKey().toString(), fileName, fileBody);
        }

        Request request = addHeaders().url(actionUrl).post(requestBody.build()).build();
        mOkHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                onFailedCallBack(e, callBack);
            }


            @Override
            public void onResponse(Call call, Response response) throws IOException {
                Log.i(TAG, "onResponse response=" + response);
                if (response.isSuccessful()) {
                    try {
                        String responseStr = response.body().string();
                        Log.i(TAG, "onResponse responseStr=" + responseStr);
                        JSONObject oriData = new JSONObject(responseStr.trim());
                        ServerResponse serverResponse = ServerResponse.parseFromResponse(oriData);

                        onSuccessCallBack(oriData, serverResponse, callBack);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }
        });
    }

7.添加请求头

private Request.Builder addHeaders() { Request.Builder builder = new Request.Builder() //addHeader，可添加多个请求头 header，唯一，会覆盖 .addHeader("Connection", "keep-alive") .addHeader("platform", "2") .addHeader("phoneModel", Build.MODEL) .addHeader("systemVersion", Build.VERSION.RELEASE) .addHeader("appVersion", "3.2.0") .header("sid", "eyJhZGRDaGFubmVsIjoiYXBwIiwiYWRkUHJvZHVjdCI6InFia3BsdXMiLCJhZGRUaW1lIjoxNTAzOTk1NDQxOTEzLCJyb2xlIjoiUk9MRV9VU0VSIiwidXBkYXRlVGltZSI6MTUwMzk5NTQ0MTkxMywidXNlcklkIjoxNjQxMTQ3fQ==.b0e5fd6266ab475919ee810a82028c0ddce3f5a0e1faf5b5e423fb2aaf05ffbf"); return builder; }

8.成功与失败回调处理

    成功回调处理

private void onSuccessCallBack(final JSONObject oriData, final ServerResponse response, final OkHttpCallback callBack) { //因为okhttp3 UI的处理不能在子线程中，要在主线程中，所以要这样写 okHttpHandler.post(new Runnable() { @Override public void run() { if (null != callBack) { callBack.onSuccess(oriData, response); } } }); }

   失败回调处理

private void onFailedCallBack(final IOException e, final OkHttpCallback callBack) { okHttpHandler.post(new Runnable() { @Override public void run() { if (null != callBack) { callBack.onFailure(e); } } }); }
小摩托_yb
关注
Android okhttp使用
qinxuexiang_blog的博客
05-03 855
简介 OKHttp是一个十分常用的网络请求框架了，用于android中请求网络。 除了OKHttp，如今Android中主流的网络请求框架有： Android-Async-Http Volley OkHttp Retrofit 依赖库导入 在build.gradle添加如下依赖 implementation 'com.squareup.okhttp3:okhttp:4.9.0' 添加网络权限 <uses-permission android:name="android.per.
Android Okhttp
qq_36523667的博客
07-12 239
分为 1.入口的队列、线程池处理 2.若干拦截器 3.连接池 4.Okio   Okio 流 在BIO眼中，有字符流，字节流 字符流：sofjasiofj你好*……*&amp;%&amp;* 字节流：0101010101 BIO、NIO、Okio BIO本质是操作数组，所以我们一般都是新建一个byte[]来作为缓冲区的。 NIO引入buffer、channel、selec...
Android的OkHttp使用和原理
最新发布
qq_44016573的博客
08-15 1239
OkHttp的出现代替了HttpUrlConnection，被谷歌官方收纳为底层的网络框架。当网络出现问题时，OkHttp会静默重新恢复连接，因为是静默的，所以用户无感知。
android之okhttp
Developer_Tyro的博客
08-11 441
先添加okhttp库的依赖 在build.gradle文件的dependences加入 compile ‘com.squareup.okhttp3:okhttp:3.4.1’发起“GET” OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder()
Android OKhttp网络请求①
叫我匪爷吧
08-02 203
public void getOkhttp() { OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url(str_log)//str_log：服务器地址 .build(); ...
Android 使用Okhttp3
2401_84149814的博客
04-14 935
下面我们就开始学习怎么使用okhttp吧。
Android网络框架OKhttp3的demo
08-14
**Android网络框架OKHttp3详解** 在Android应用开发中，网络通信是不可或缺的一部分，而OKHttp3作为一款高效、易用的网络请求框架，被广大开发者广泛应用。它由Square公司开发，提供了强大的性能优化和丰富的功能...
Android开发使用HttpURLConnection进行网络编程详解【附源码下载】
08-28
本文将详细介绍如何在Android中使用HttpURLConnection进行网络编程，包括设置请求方法、获取响应码、处理GET和POST请求以及实现多线程下载，并涉及权限控制和布局文件的使用。 首先，设置请求方法是通过`...
Android开发使用URLConnection进行网络编程详解
01-20
总的来说，Android开发中使用URLConnection进行网络编程涉及URL对象的创建、连接配置、数据发送与接收等多个步骤，开发者需要理解每个步骤的作用和顺序，以便在实际项目中灵活运用。同时，遵循Android的网络访问规则...
android4.0网络编程详解——源码
07-17
在Android 4.0(Ice Cream Sandwich)系统中，网络编程是实现应用程序与远程服务器交互的重要部分。本章将深入探讨如何在Android平台上进行网络操作，包括基础的HTTP请求、数据传输、网络状态监听以及更高级的Socket...
Android:使用 OkHttp 访问网络
大模型训练
05-05 1718
本文使用登录场景来简单介绍 Android 应用中使用 OkHttp 访问网络的用法。 * 数据交换协议 HTTP * 数据交换格式 JSON * HTTP 请求方法 Post
android开发——okhttp的使用（封装为工具类）
river66的博客
01-21 2771
使用功能强大，可以传参（包括json）、传header信息，Cookie的处理，回调函数处理等。先看下调用的代码： private static final String CONTENT_TYPE = "application/json; charset=utf-8"; public static void login() { HashMap&lt;String, String&gt;...
Android okhttp网络框架
qq_32136827的博客
12-08 352
import android.os.Environment; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.Map; import java.util.concurrent.TimeUni...
android使用Okhttp3网络通信
letterss的博客
05-23 642
1.在build.gradle引入okhttp3依赖 compile 'com.squareup.okhttp3:okhttp:3.9.0' compile 'com.squareup.okio:okio:1.13.0' 2.在AndroidMainifest.xml加入网络请求权限 <uses-permission android:name="android.permission.INTERNET" /> 创建Okhttp3工具类 import okhttp3.C
android中引入okhttp
Alex的博客
07-10 4675
选择在低版本中运行的，android 7 代码通过学习 https://square.github.io/okhttp/ 中的 sAndroidManifest.xml 中新增权限 <uses-permission android:name="android.permission.INTERNET"></uses-permission> 引入 okIo和okhttp包 搜所okio import androi...
Android Okhttp3《一》
qq_31469589的博客
07-06 224
前言 OkHttp 就不做多余的介绍了，可说说是目前使用最广泛的网络请求框架，在很多的其他第三方框架中也是用了改网络请求框架例如Retrofit，这里主要想说一些问什么使用okhttp。 一、为什么使用版OKHttp 1.1 Socket 如果我们需要从服务器获取一个资源，那么就一定需要访问网络，访问网络就一定需要使用到Socket，我想大家在学习Java的网络编程的时候也就是Socket 编程的时候一定写过客户端与服务端，客户端法一个消息然后服务端返回一个消息，就是一个极为简单的聊天软件，理论上我们可以通
android OkHttp 详解
weixin_42754390的博客
02-21 4032
在Android Studio项目中，使用okHttp时要添加： compile 'com.squareup.okhttp:okhttp:2.4.0' OkHttp的使用教程： OkHttpClient mOkHttpClient = new OkHttpClient(); //创建okHttpClient对象 final Request request = new Request.Builder().url("https://baidu.com").build() //创建一个Request对象，设
Android学习之okhttp
colorful的博客
10-11 232
OKHTTP 整体流程 同步请求 OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url(url) .build(); Response response = client.newCall(request).execute(); return response.body().string(); 首先实例化一个OkHttpClient OkHttpClient实例的newC
Android 使用Okhttp3(1)
2401_84149802的博客
04-14 1020
都说三年是程序员的一个坎，能否晋升或者提高自己的核心竞争力，这几年就十分关键。技术发展的这么快，从哪些方面开始学习，才能达到高级工程师水平，最后进阶到Android架构师/技术专家？我总结了这 5大块；我搜集整理过这几年阿里，以及腾讯，字节跳动，华为，小米等公司的面试题，把面试的要求和技术点梳理成一份大而全的“ Android架构师”面试 PDF（实际上比预期多花了不少精力），包含知识脉络 + 分支细节。Java语言与原理；大厂，小厂。Android面试先看你熟不熟悉Java语言高级UI与自定义view。
Android网络编程接口详解
"Android网络开发详解，涵盖Android平台上网络编程的各种接口和使用方法，包括标准Java接口、HttpClient、OkHttp以及 Volley等库的使用，并强调了网络请求的异步处理和性能优化策略。" 在Android应用开发中，网络...
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值