android OkHttp学习以及使用例子

最新推荐文章于 2023-08-18 21:44:45 发布
最新推荐文章于 2023-08-18 21:44:45 发布
阅读量161 收藏
点赞数
分类专栏： android 文章标签： 移动开发 java ui
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lan12334321234/article/details/84749690
版权
[color=red][b]OKHttp是一款高效的HTTP客户端，[/b][/color][color=blue][b]支持连接同一地址的链接共享同一个socket，通过连接池来减小响应延迟，还有透明的GZIP压缩，请求缓存等优势。[/b][/color]

[size=medium][color=red][b]1. GET [/b][/color][/size]
在OKHttp，每次网络请求就是一个Request，[color=blue]我们在Request里填写我们需要的url，header等其他参数，再通过Request构造出Call，Call内部去请求参数，得到回复[/color]，并将结果告诉调用者。 


package com.jackchan.test.okhttptest;

import android.os.Bundle;
import android.support.v7.app.ActionBarActivity;
import android.util.Log;

import com.squareup.okhttp.Cache;
import com.squareup.okhttp.Callback;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.Response;

import java.io.File;
import java.io.IOException;


public class TestActivity extends ActionBarActivity {

    private final static String TAG = "TestActivity";

    private final OkHttpClient client = new OkHttpClient();

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test);
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    execute();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }).start();
    }

    public void execute() throws Exception {
        Request request = new Request.Builder()
                .url("http://publicobject.com/helloworld.txt")
                .build();
        Response response = client.newCall(request).execute();
        if(response.isSuccessful()){
            System.out.println(response.code());
            System.out.println(response.body().string());
        }
    }
}


我们通过[color=red]Request.Builder传入url，然后直接execute执行得到Response，通过Response可以得到code,message等信息。[/color]

这个是通过同步的方式去操作网络请求，[color=blue]而android本身是不允许在UI线程做网络请求操作[/color]的，因此我们需要自己开启一个线程。

当然，[b][color=red]OKHttp也支持异步线程并且有回调返回[/color][/b]，有了上面同步的基础，异步只要稍加改动即可。 


private void enqueue(){
        Request request = new Request.Builder()
                .url("http://publicobject.com/helloworld.txt")
                .build();
        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Request request, IOException e) {

            }
            // 成功时响应的回调函数
            @Override
            public void onResponse(Response response) throws IOException {
                //NOT UI Thread
                if(response.isSuccessful()){
                    System.out.println(response.code());
                    System.out.println(response.body().string());
                }
            }
        });
    }

就是[b][color=red]在同步的基础上讲execute改成enqueue[/color][/b]，并且传入回调接口，但接口回调回来的代码是在非UI线程的，[color=blue][b]因此如果有更新UI的操作记得用Handler或者其他方式。[/b][/color]

[size=medium][color=red][b]2、POST[/b][/color][/size]

说完GET该介绍些如何使用POST，[b]POST情况下我们一般需要传入参数，甚至一些header，传入参数或者header[/b]

[color=red]比如传入header [/color] 
Request request = new Request.Builder() 
.url("https://api.github.com/repos/square/okhttp/issues") 
.header("User-Agent", "OkHttp Headers.java") 
.addHeader("Accept", "application/json; q=0.5") 
.addHeader("Accept", "application/vnd.github.v3+json") 
.build();

传入POST参数 


RequestBody formBody = new FormEncodingBuilder()
    .add("platform", "android")
    .add("name", "bug")
    .add("subject", "XXXXXXXXXXXXXXX")
    .build();

    Request request = new Request.Builder()
      .url(url)
      .post(body)
      .build();


可以看出来，[b][color=red]传入header或者post参数都是传到Request里面[/color][/b]，因此最后的调用方式也和GET方式一样 


Response response = client.newCall(request).execute();
    if (response.isSuccessful()) {
        return response.body().string();
    } else {
        throw new IOException("Unexpected code " + response);
    }

这个代码是同步网络请求，[size=medium][color=red][b]异步就改成enqueue就行了。[/b][/color][/size]

[size=large][color=red][b]请求缓存[/b][/color][/size]

在网络请求中，[b][color=red]缓存技术是一项应用比较广泛的技术，需要对请求过的网络资源进行缓存，而okhttp也支持这一技术[/color][/b]，也使用十分方便，前文中经常出现的[b][color=blue]OkHttpClient[/color][/b]这个时候就要派送用场了。看下面代码 


package com.jackchan.test.okhttptest;

import android.os.Bundle;
import android.support.v7.app.ActionBarActivity;
import android.util.Log;

import com.squareup.okhttp.Cache;
import com.squareup.okhttp.CacheControl;
import com.squareup.okhttp.Call;
import com.squareup.okhttp.Callback;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.Response;

import java.io.File;
import java.io.IOException;


public class TestActivity extends ActionBarActivity {

    private final static String TAG = "TestActivity";
    // 请求资源客户端
    private final OkHttpClient client = new OkHttpClient();

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test);
        File sdcache = getExternalCacheDir();
        int cacheSize = 10 * 1024 * 1024; // 10 MiB
        // 对资源进行缓存
        client.setCache(new Cache(sdcache.getAbsoluteFile(), cacheSize));
        // 开启一个线程
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    execute();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }).start();
    }

    public void execute() throws Exception {
        Request request = new Request.Builder()
                .url("http://publicobject.com/helloworld.txt")
                .build();

        Response response1 = client.newCall(request).execute();
        if (!response1.isSuccessful()) throw new IOException("Unexpected code " + response1);

        String response1Body = response1.body().string();
        System.out.println("Response 1 response:          " + response1);
        System.out.println("Response 1 cache response:    " + response1.cacheResponse());
        System.out.println("Response 1 network response:  " + response1.networkResponse());

        Response response2 = client.newCall(request).execute();
        if (!response2.isSuccessful()) throw new IOException("Unexpected code " + response2);

        String response2Body = response2.body().string();
        System.out.println("Response 2 response:          " + response2);
        System.out.println("Response 2 cache response:    " + response2.cacheResponse());
        System.out.println("Response 2 network response:  " + response2.networkResponse());

        System.out.println("Response 2 equals Response 1? " + response1Body.equals(response2Body));

    }
}


okhttpclient有点像Application的概念，统筹着整个okhttp的大功能，通过它设置缓存目录。

response1 的结果在networkresponse，代表是从网络请求加载过来的，而response2的networkresponse 就为null，而cacheresponse有数据，因为我设置了缓存因此第二次请求时发现缓存里有就不再去走网络请求了。
[color=red]但有时候即使在有缓存的情况下我们依然需要去后台请求最新的资源[/color]（比如资源更新了）这个时候可以使用强制走网络来要求必须请求网络数据 


public void execute() throws Exception {
        Request request = new Request.Builder()
                .url("http://publicobject.com/helloworld.txt")
                .build();

        Response response1 = client.newCall(request).execute();
        if (!response1.isSuccessful()) throw new IOException("Unexpected code " + response1);

        String response1Body = response1.body().string();
        System.out.println("Response 1 response:          " + response1);
        System.out.println("Response 1 cache response:    " + response1.cacheResponse());
        System.out.println("Response 1 network response:  " + response1.networkResponse());

        request = request.newBuilder().cacheControl(CacheControl.FORCE_NETWORK).build();
        Response response2 = client.newCall(request).execute();
        if (!response2.isSuccessful()) throw new IOException("Unexpected code " + response2);

        String response2Body = response2.body().string();
        System.out.println("Response 2 response:          " + response2);
        System.out.println("Response 2 cache response:    " + response2.cacheResponse());
        System.out.println("Response 2 network response:  " + response2.networkResponse());

        System.out.println("Response 2 equals Response 1? " + response1Body.equals(response2Body));

    }


上面的代码中
response2对应的request变成 


request = request.newBuilder().cacheControl(CacheControl.FORCE_NETWORK).build();


[size=medium][color=red][b]取消操作[/b][/color][/size]

网络操作中，经常会使用到对请求的cancel操作，[b]okhttp的也提供了这方面的接口[/b]，call的cancel操作。[color=red]使用Call.cancel()可以立即停止掉一个正在执行的call。[/color]如果一个线程正在写请求或者读响应，将会引发IOException，同时可以通过Request.Builder.tag(Object tag)给请求设置一个标签，并使用OkHttpClient.cancel(Object tag)来取消所有带有这个tag的call。[color=red]但如果该请求已经在做读写操作的时候，cancel是无法成功的[/color]，会抛出IOException异常。 


public void canceltest() throws Exception {
        Request request = new Request.Builder()
                .url("http://httpbin.org/delay/2") // This URL is served with a 2 second delay.
                .build();

        final long startNanos = System.nanoTime();
        final Call call = client.newCall(request);

        // Schedule a job to cancel the call in 1 second.
        executor.schedule(new Runnable() {
            @Override
            public void run() {
                System.out.printf("%.2f Canceling call.%n", (System.nanoTime() - startNanos) / 1e9f);
                call.cancel();
                System.out.printf("%.2f Canceled call.%n", (System.nanoTime() - startNanos) / 1e9f);
            }
        }, 1, TimeUnit.SECONDS);

        try {
            System.out.printf("%.2f Executing call.%n", (System.nanoTime() - startNanos) / 1e9f);
            Response response = call.execute();
            System.out.printf("call is cancel:" + call.isCanceled() + "%n");
            System.out.printf("%.2f Call was expected to fail, but completed: %s%n",
                    (System.nanoTime() - startNanos) / 1e9f, response);
        } catch (IOException e) {
            System.out.printf("%.2f Call failed as expected: %s%n",
                    (System.nanoTime() - startNanos) / 1e9f, e);
        }
    }


转自：[url]http://blog.csdn.net/chenzujie/article/details/46994073[/url] 


package com.test.okhttp;

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

import org.apache.http.client.utils.URLEncodedUtils;
import org.apache.http.message.BasicNameValuePair;

import com.squareup.okhttp.Call;
import com.squareup.okhttp.Callback;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.Response;

public class OkHttpClientManager {

	private static final OkHttpClient mOkHttpClient = new OkHttpClient();

	static {

		mOkHttpClient.setConnectTimeout(30, TimeUnit.SECONDS);

	}

	/**
	 * 
	 * 该方法不会开启异步线程。
	 * 
	 * @param request
	 * 
	 * @return
	 * 
	 * @throws IOException
	 */

	public static Response execute(Request request) throws IOException {

		return mOkHttpClient.newCall(request).execute();

	}

	/**
	 * 
	 * 开启异步线程访问网络
	 * 
	 * @param request
	 * 
	 * @param responseCallback
	 */

	public static void enqueue(Request request, Callback responseCallback) {

		mOkHttpClient.newCall(request).enqueue(responseCallback);

	}

	/**
	 * 
	 * 开启异步线程访问网络, 且不在意返回结果（实现空callback）
	 * 
	 * @param request
	 */

	public static void enqueue(Request request) {

		mOkHttpClient.newCall(request).enqueue(new Callback() {

			@Override
			public void onResponse(Response arg0) throws IOException {

			}

			@Override
			public void onFailure(Request arg0, IOException arg1) {

			}

		});

	}

	public static String getStringFromServer(String url) throws IOException {

		Request request = new Request.Builder().url(url).build();

		Response response = execute(request);

		if (response.isSuccessful()) {

			String responseUrl = response.body().string();

			return responseUrl;

		} else {

			throw new IOException("Unexpected code " + response);

		}

	}

	private static final String CHARSET_NAME = "UTF-8";

	/**
	 * 
	 * 这里使用了HttpClinet的API。只是为了方便
	 * 
	 * @param params
	 * 
	 * @return
	 */

	public static String formatParams(List<BasicNameValuePair> params) {

		return URLEncodedUtils.format(params, CHARSET_NAME);
	}

	/**
	 * 
	 * 为HttpGet 的 url 方便的添加多个name value 参数。
	 * 
	 * @param url
	 * 
	 * @param params
	 * 
	 * @return
	 */

	public static String attachHttpGetParams(String url,
			List<BasicNameValuePair> params) {
		return url + "?" + formatParams(params);
	}

	/**
	 * 
	 * 为HttpGet 的 url 方便的添加1个name value 参数。
	 * 
	 * @param url
	 * 
	 * @param name
	 * 
	 * @param value
	 * 
	 * @return
	 */

	public static String attachHttpGetParam(String url, String name,
			String value) {
		return url + "?" + name + "=" + value;
	}
	/**
	 * 下载内容
	 * @param url
	 * @param destFileDir
	 */
	public static void downloadAsyn(final String url, final String destFileDir) {
		final Request request = new Request.Builder().url(url).build();
		final Call call = mOkHttpClient.newCall(request);
		call.enqueue(new Callback() {
			@Override
			public void onFailure(final Request request, final IOException e) {

			}

			@Override
			public void onResponse(Response response) {
				System.out.println("Download..........");
				InputStream is = null;
				byte[] buf = new byte[2048];
				int len = 0;
				FileOutputStream fos = null;
				try {
					is = response.body().byteStream();
					File file = new File(destFileDir, getFileName(url));
					fos = new FileOutputStream(file);
					while ((len = is.read(buf)) != -1) {
						fos.write(buf, 0, len);
					}
					fos.flush();
				} catch (IOException e) {
				} finally {
					try {
						if (is != null)
							is.close();
					} catch (IOException e) {
					}
					try {
						if (fos != null)
							fos.close();
					} catch (IOException e) {
					}
				}

			}
		});
	}

	private static String getFileName(String path) {
		int separatorIndex = path.lastIndexOf("/");
		return (separatorIndex < 0) ? path : path.substring(separatorIndex + 1,
				path.length());
	}
}


参考：[url]http://blog.csdn.net/lmj623565791/article/details/47911083[/url]
艾伦蓝
关注
专栏目录
Android开发实例——Okhttp使用
weijun的博客
03-17 4645
在Android开发网络编程中，Okhttp已然成为了最火热的轻量级框架。本篇文章主要介绍Okhttp框架中的get和post方法使用。 1. 什么是Okhttp Okhttp是由移动支付Square公司贡献，用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里已移除HttpClient)的网络框架。先来到Okhttp官网看看官方文档...
okhttp 示例_OkHttp Android示例教程
从零开始的教程世界
07-13 841
okhttp 示例OkHttp is a third party library that was introduced by Square in 2013 for sending and receive HTTP-based network requests. OkHttp是Square在2013年引入的第三方库，用于发送和接收基于HTTP的网络请求。 OkHttp Android (OkH...
android第三方代码,Android--第三方控件--okHttp(示例代码)
weixin_42101164的博客
05-27 565
Android中有很多的第三方控件，其中OkHttp是一个很强大的用于网络加载的第三方控件，当然了，它的内部也是使用原生的代码封装好的。今天我们就来看一下OkHttp的简单用法：说到网络请求，肯定就分get和post两种了，这里我们说一下get和post的简单实用：首先我们需要先在我们的项目中引入OkHttp的依赖，在你的项目的gradle下面的dependencies下添加依赖：1 compil...
Android-详解网络请求框架-OkHttp（源码）
q1210249579的博客
12-06 1641
前言 1.OkHttp的优点 网络方面 （1）它支持http2.0，在网络请求响应方面使用了多路复用； （2）内置连接池，减少连接开销，复用连接； （3）内有Response缓存，缓存响应，避免重复的请求； （4）对响应体支持gzip压缩,使得传输数据更为轻量； （5）支持SPDY,允许连接同一主机的所有请求分享一个socket； 拓展方面 （1）支持重定向，重试请求，重写编码拦截器； （2）支持头部信息拦截，自带CookieJar方法； （3）支持网络数据传输时的监听； （4）通过需求能自定义拦截器进行处
Android网络请求框架OKHttp的使用详解
最新发布
TechBurst的博客
08-18 1090
本文通过简单明了的示例介绍了如何在Android项目中使用OKHttp进行网络请求。以上代码中，我们在onResponse方法中处理了请求成功的响应数据，在onFailure方法中处理了请求失败的情况。除了发送基本的GET和POST请求，OKHttp还提供了许多其他功能，包括文件上传、文件下载、连接超时设置等。首先，在你的Android项目中的build.gradle文件中添加OKHttp的依赖项。以上代码中，我们使用FormBody.Builder来构建表单数据，并将其作为POST请求的请求体。
android okhttp的基础使用【入门推荐】
08-31
【OkHttp基础使用详解】 OkHttp是Android平台上广泛使用的HTTP客户端库，由Square公司开发，以其...在后续的学习中，深入理解OkHttp的拦截器机制、缓存机制以及网络连接池等功能，将有助于你更好地优化网络请求性能。
android okHttp的简单使用
08-09
本教程将详细介绍如何在Android应用中使用OkHttp进行GET、POST请求，以及如何实现图片下载和文件上传。 首先，我们需要在项目中添加OkHttp的依赖。在`build.gradle`文件中引入库： ```groovy dependencies { ...
android中okhttp实现断点上传示例
01-05
于是网上搜索，发现市面上很少有断点上传的案例，有找到一个案例也是采用SOCKET作为上传方式（大文件上传，不适合使用POST,GET形式）。由于大文件夹不适合http上传的方式，所以就想能不能把大文件切割成n块小文件，...
Android实战——okhttp3的使用和封装
05-22
本文将深入探讨OkHttp3的使用和封装，旨在帮助开发者更好地理解和掌握这一强大的网络请求工具。 首先，让我们了解OkHttp的基本概念。OkHttp是由Square公司开发的，它提供了一个高效的HTTP客户端接口，具有缓存、...
android okhttp实例
05-11
这是一个用okhttp进行网络请求的例子，例子包括 - okhttp get请求 - okhttp post请求 - okhttp 提取响应头 - okhttp 解析json - okhttp 提交表单 - okhttp 提交文件 - okhttp 下载文件 - okhttp https请求相关 尽量用简单易懂的编码方式，来实现一些常用的网络请求，分享出来希望对大家有帮助。
Okhttp使用实例
08-18
一个具体使用Okhttp的实例，保证同一时刻只有一个http的请求。
OkHttp使用案例
12-07
Android网络请求框架OkHttp使用案例Demo测试代码，没一个案例都单独测试，内容详细简单
Android网络通讯之OkHttp
不积跬步无以至千里，不积小流无以成江海。一个喜欢学习分享的程序员
11-09 7237
OkHttp是安卓上常用的网络请求框架，不止可以发送http请求，还可以发送socket请求等。官网地址：https://square.github.io/okhttp/
Android Studio 基础 之 使用 okhttp 长连接，流式获取数据的方法简单整理了
热门推荐
仙魁XAN
05-17 1万+
Android 开发中的一些基础操作，使用整理，便于后期使用。本节介绍，浏览器向服务器发送一个HTTP请求，保持长连接，服务器不断单向地向浏览器推送“信息”（message），这么做是为了节约网络资源，不用一直发请求，建立新连接。这里使用 okhttp 获取长连接的流数据，并且边获取边展示，方法不唯一，仅供参考。在post请求使用方法中讲了一种传递参数的方法，就是创建表单请求体对象，然后把表单请求体对象作为post方法的参数。post请求传递参数的方法还有很多种，但都是通过post方法传递的。
Android进阶之路 - OkHttp的入门使用
Android、前端、小程序、后端
04-28 1985
因前一篇并没有把具体的效果图展现，故本篇讲解的同样是okHttp下的Get请求与Post请求，不包含文件与图片的上传与下载（之后可能在中级使用中讲到）前提 (使用了三方平台的接口) :Effect ：还有一些主要注意，可通过上一篇okHttp查看，链接地址如下：http://blog.csdn.net/qq_20451879/article/details/55001505MainActivity
[Android]网络框架之OkHttp(详细)（kotlin）
weixin_63357306的博客
02-08 8896
由Square公司贡献的一个处理网络请求的开源项目，是目前Android使用最广泛的网络框架。从Android4.0开始HttpURLConnection的底层实现采用的是OkHttp。OkHttp的介绍，添加依赖，OkHttp的使用get的同步与异步请求post的同步与异步请求POST请求的数据格式POST请求上传文件POST请求上传json对象POST请求上传多个数据OkHttp的配置1.Builder构建器2.自定义拦截器3.自定义缓存4. 自定义Cookie
Android:使用 OkHttp 访问网络
大模型训练
05-05 1761
本文使用登录场景来简单介绍 Android 应用中使用 OkHttp 访问网络的用法。 * 数据交换协议 HTTP * 数据交换格式 JSON * HTTP 请求方法 Post
Android网络开发（二、okhttp&retrofit）
BC时间
03-09 1575
  在Android开发中，一般很少直接使用HttpURLConnection / HttpsURLConnection，比较常用的开源网络库有okhttp、retrofit等。  okhttp支持异步网络请求/同步网络请求，它默认支持:（1）HTTP/2 相同域名下的请求共用一个socket；（2）通过连接池减少请求时延(如果HTTP/2不可用)；（3）支持GZIP压缩；（4）支持Response缓存。  在build.gradle中添加okhttp依赖如下： 2.2 接收数据   OKhttp使用Cal
Android应用开发：深入解析okhttp3的使用
以下内容将详细介绍如何引入okhttp3依赖，以及同步和异步GET请求的基本使用方法。 一、引入okhttp3依赖 要在Android项目中使用okhttp3，首先需要在模块级的build.gradle文件中添加依赖项： ```groovy dependencies...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值