Http请求框架 okHttp 简单使用介绍

最新推荐文章于 2024-05-14 14:29:46 发布
最新推荐文章于 2024-05-14 14:29:46 发布
阅读量5.9k 收藏 3
点赞数
分类专栏： android

（今天接触了Http请求框架，搜索了一篇关于okHttp框架的博文，在此备份。）


okHttp: OKHttp是Android版Http客户端。非常高效，支持SPDY、连接池、GZIP和 HTTP 缓存。默认情况下，OKHttp会自动处理常见的网络问题，像二次连接、SSL的握手问题。如果你的应用程序中集成了OKHttp，Retrofit默认会使用OKHttp处理其他网络层请求。

An HTTP & SPDY client for Android and Java applications  从Android4.4开始HttpURLConnection的底层实现采用的是okHttp.

使用要求:对于Android：2.3以上，对于Java:java7以上 两个模块： okhttp-urlconnection实现.HttpURLConnection API； okhttp-apache实现Apache HttpClient API. 

依赖：okio(https://github.com/square/okio): Okio, which OkHttp uses for fast I/O and resizable buffers.

安装：okHttp

maven:（没有试过）
?
1
2
3
4
5
<dependency>
   <groupid>com.squareup.okhttp</groupid>
   okhttp</artifactid>
   <version> 2.3 . 0 </version>
</dependency>
Gradle:
?
1
compile 'com.squareup.okhttp:okhttp:2.3.0'

（在gradle配置文件中附上这一句后点击Sync project with gradle files按钮，如下图。gradle会自动下载并安装相应jar包）


GET A URL

同步GET:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
private final OkHttpClient client = new OkHttpClient();
 
public void run() throws Exception {
   Request request = new Request.Builder()
       .url(http: //publicobject.com/helloworld.txt)
       .build();
 
   Response response = client.newCall(request).execute();
   if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
   Headers responseHeaders = response.headers();
   for ( int i = 0 ; i < responseHeaders.size(); i++) {
     System.out.println(responseHeaders.name(i) + :  + responseHeaders.value(i));
   }
 
   System.out.println(response.body().string());
}

异步GET:

在一个工作线程中 下载 文件，当响应可读时回调Callback接口。读取响应时会阻塞当前线程。OkHttp现阶段不提供异步api来接收响应体。
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
private final OkHttpClient client = new OkHttpClient();
 
public void run() throws Exception {
   Request request = new Request.Builder()
       .url(http: //publicobject.com/helloworld.txt)
       .build();
 
   client.newCall(request).enqueue( new Callback() {
     @Override public void onFailure(Request request, Throwable throwable) {
       throwable.printStackTrace();
     }
 
     @Override public void onResponse(Response response) throws IOException {
       if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
       Headers responseHeaders = response.headers();
       for ( int i = 0 ; i < responseHeaders.size(); i++) {
         System.out.println(responseHeaders.name(i) + :  + responseHeaders.value(i));
       }
 
       System.out.println(response.body().string());
     }
   });
}

访问Header:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
private final OkHttpClient client = new OkHttpClient();
 
public void run() throws Exception {
   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();
 
   Response response = client.newCall(request).execute();
   if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
   System.out.println(Server:  + response.header(Server));
   System.out.println(Date:  + response.header(Date));
   System.out.println(Vary:  + response.headers(Vary));
}

POST TO A SERVER

Posting a String:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
public static final MediaType jsonReq
     = MediaType.parse(application/json; charset=utf- 8 );
 
OkHttpClient client = new OkHttpClient();
 
String post(String url, String json) throws IOException {
   RequestBody body = RequestBody.create(jsonReq, json);
   Request request = new Request.Builder()
       .url(url)
       .post(body)
       .build();
   Response response = client.newCall(request).execute();
   return response.body().string();
}

Posting Streaming:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
public static final MediaType MEDIA_TYPE_MARKDOWN
       = MediaType.parse(text/x-markdown; charset=utf- 8 );
 
   private final OkHttpClient client = new OkHttpClient();
 
   public void run() throws Exception {
     RequestBody requestBody = new RequestBody() {
       @Override public MediaType contentType() {
         return MEDIA_TYPE_MARKDOWN;
       }
 
       @Override public void writeTo(BufferedSink sink) throws IOException {
         sink.writeUtf8(Numbers
);
         sink.writeUtf8(-------
);
         for ( int i = 2 ; i <= 997 ; i++) {
           sink.writeUtf8(String.format( * %s = %s
, i, factor(i)));
         }
       }
 
       private String factor( int n) {
         for ( int i = 2 ; i < n; i++) {
           int x = n / i;
           if (x * i == n) return factor(x) +  ×  + i;
         }
         return Integer.toString(n);
       }
     };
 
     Request request = new Request.Builder()
         .url(https: //api.github.com/markdown/raw)
         .post(requestBody)
         .build();
 
     Response response = client.newCall(request).execute();
     if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
     System.out.println(response.body().string());
   }

Posting a File:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public static final MediaType MEDIA_TYPE_MARKDOWN
      = MediaType.parse(text/x-markdown; charset=utf- 8 );
 
  private final OkHttpClient client = new OkHttpClient();
 
  public void run() throws Exception {
    File file = new File(README.md);
 
    Request request = new Request.Builder()
        .url(https: //api.github.com/markdown/raw)
        .post(RequestBody.create(MEDIA_TYPE_MARKDOWN, file))
        .build();
 
    Response response = client.newCall(request).execute();
    if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
    System.out.println(response.body().string());
  }

Posting from parameters:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
private final OkHttpClient client = new OkHttpClient();
 
   public void run() throws Exception {
     RequestBody formBody = new FormEncodingBuilder()
         .add(search, Jurassic Park)
         .build();
     Request request = new Request.Builder()
         .url(https: //en.wikipedia.org/w/index.php)
         .post(formBody)
         .build();
 
     Response response = client.newCall(request).execute();
     if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
     System.out.println(response.body().string());
   }

Posting a multipart request:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
private static final String IMGUR_CLIENT_ID = ...;
  private static final MediaType MEDIA_TYPE_PNG = MediaType.parse(image/png);
 
  private final OkHttpClient client = new OkHttpClient();
 
  public void run() throws Exception {
    // Use the imgur image upload API as documented at https://api.imgur.com/endpoints/image
    RequestBody requestBody = new MultipartBuilder()
        .type(MultipartBuilder.FORM)
        .addPart(
            Headers.of(Content-Disposition, form-data; name=    itle),
            RequestBody.create( null , Square Logo))
        .addPart(
            Headers.of(Content-Disposition, form-data; name=image),
            RequestBody.create(MEDIA_TYPE_PNG, new File(website/ static /logo-square.png)))
        .build();
 
    Request request = new Request.Builder()
        .header(Authorization, Client-ID  + IMGUR_CLIENT_ID)
        .url(https: //api.imgur.com/3/image)
        .post(requestBody)
        .build();
 
    Response response = client.newCall(request).execute();
    if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
    System.out.println(response.body().string());
  }

Posing Json with Gson

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
private final OkHttpClient client = new OkHttpClient();
  private final Gson gson = new Gson();
 
  public void run() throws Exception {
    Request request = new Request.Builder()
        .url(https: //api.github.com/gists/c2a7c39532239ff261be)
        .build();
    Response response = client.newCall(request).execute();
    if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
    Gist gist = gson.fromJson(response.body().charStream(), Gist. class );
    for (Map.Entry<string, gistfile= "" > entry : gist.files.entrySet()) {
      System.out.println(entry.getKey());
      System.out.println(entry.getValue().content);
    }
  }
 
  static class Gist {
    Map<string, gistfile= "" > files;
  }
 
  static class GistFile {
    String content;
  }</string,></string,>

Response Caching：

为了缓存响应，你需要一个你可以读写的缓存目录，和缓存大小的限制。这个缓存目录应该是私有的，不信任的程序应不能读取缓存内容。
一个缓存目录同时拥有多个缓存访问是错误的。大多数程序只需要调用一次 new OkHttp() ，在第一次调用时配置好缓存，然后其他地方只需要调用这个实例就可以了。否则两个缓存示例互相干扰，破坏响应缓存，而且有可能会导致程序崩溃。
响应缓存使用HTTP头作为配置。你可以在请求头中添加 Cache-Control: max-stale=3600 ,OkHttp缓存会支持。你的服务通过响应头确定响应缓存多长时间，例如使用 Cache-Control: max-age=9600 。
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
private final OkHttpClient client;
 
   public CacheResponse(File cacheDirectory) throws Exception {
     int cacheSize = 10 * 1024 * 1024 ; // 10 MiB
     Cache cache = new Cache(cacheDirectory, cacheSize);
 
     client = new OkHttpClient();
     client.setCache(cache);
   }
 
   public void run() 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());
   }

Canceling a Call

?
1
2
final Call call = client.newCall(request);
     call.cancel();

Timeouts:

?
1
2
3
4
5
6
7
8
private final OkHttpClient client;
 
   public ConfigureTimeouts() throws Exception {
     client = new OkHttpClient();
     client.setConnectTimeout( 10 , TimeUnit.SECONDS);
     client.setWriteTimeout( 10 , TimeUnit.SECONDS);
     client.setReadTimeout( 30 , TimeUnit.SECONDS);
   }

Handling Authentication:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
private final OkHttpClient client = new OkHttpClient();
 
   public void run() throws Exception {
     client.setAuthenticator( new Authenticator() {
       @Override public Request authenticate(Proxy proxy, Response response) {
         System.out.println(Authenticating for response:  + response);
         System.out.println(Challenges:  + response.challenges());
         String credential = Credentials.basic(jesse, password1);
         return response.request().newBuilder()
             .header(Authorization, credential)
             .build();
       }
 
       @Override public Request authenticateProxy(Proxy proxy, Response response) {
         return null ; // Null indicates no attempt to authenticate.
       }
     });
 
     Request request = new Request.Builder()
         .url(http: //publicobject.com/secrets/hellosecret.txt)
         .build();
 
     Response response = client.newCall(request).execute();
     if (!response.isSuccessful()) throw new IOException(Unexpected code  + response);
 
     System.out.println(response.body().string());
   }
为避免当验证失败时多次重试，我们可以通过返回null来放弃验证：
?
1
2
3
4
5
6
7
8
9
10
11
if (responseCount(response) >= 3 ) {
     return null ; // If we've failed 3 times, give up.
   }
//添加以下方法
private int responseCount(Response response) {
     int result = 1 ;
     while ((response = response.priorResponse()) != null ) {
       result++;
     }
     return result;
   }

Interceptors

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
class LoggingInterceptor implements Interceptor {
   @Override public Response intercept(Chain chain) throws IOException {
     Request request = chain.request();
 
     long t1 = System.nanoTime();
     logger.info(String.format(Sending request %s on %s%n%s,
         request.url(), chain.connection(), request.headers()));
 
     Response response = chain.proceed(request);
 
     long t2 = System.nanoTime();
     logger.info(String.format(Received response for %s in %.1fms%n%s,
         response.request().url(), (t2 - t1) / 1e6d, response.headers()));
 
     return response;
   }
}

Application Interceptors：

?
1
2
OkHttpClient client = new OkHttpClient();
client.interceptors().add( new LoggingInterceptor());

Network Interceptors

?
1
2
OkHttpClient client = new OkHttpClient();
client.networkInterceptors().add( new LoggingInterceptor());
思念叨火车
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
OkHttp基本使用教程（安卓端http请求框架）
01-20
OkHttp基本使用教程（安卓端流行的http请求框架） 简介 android网络请求框架之OkHttp，一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里...
android okhttp网络请求框架
08-08
**Android OkHttp 网络请求框架** OkHttp 是由 Square 公司开发的一个高效的网络请求库，广泛应用于 Android 开发中。它以其强大的性能、简单易用的 API 和丰富的特性，深受开发者喜爱。OkHttp 的核心设计理念是...
okhttp原理详解
idaretobe的专栏
12-29 2790
okhttp原理详解
一招搞定外部请求，这款 HTTP 客户端框架真的很强大！
Java知音
07-08 1160
一、Forest1.1 业务需求一般情况下是后端提供接口，前端调用，解决需求，但是有的时候为了方便，复用别人的接口（网上的，公共的第三方接口（短信、天气等）），就出现了后端调用后端接口的情况。此外，因为业务关系，要和许多不同第三方公司进行对接。这些服务商都提供基于http的api，但是每家公司提供api具体细节差别很大。有的基于RESTFUL规范，有的基于传统的http规范；有的需要在header...
2024年Android最新okhttp网络框架源码解析，2024年最新android开发基础在线学习网站
最新发布
2401_84545171的博客
05-14 806
我们都知道Get请求url结合提交参数是唯一标示，而Post请求的参数是在http的body体里面，是可变的，无法成为唯一的标示。所以面试没有其他的诀窍，只看你对这些知识点准备的充分程度。只要是程序员，不管是Java还是Android，如果不去阅读源码，只看API文档，那就只是停留于皮毛，这对我们知识体系的建立和完备以及实战技术的提升都是不利的。只要是程序员，不管是Java还是Android，如果不去阅读源码，只看API文档，那就只是停留于皮毛，这对我们知识体系的建立和完备以及实战技术的提升都是不利的。
OkHttp原理详解
z_ssyy的博客
04-23 491
总结下流程：首先通过OkHttpClient对象调用newCall方法得到RealCall实例，再通过调用RealCall的execute方法或enqueue方法，这两个方法最终都会调用到getResponseWithInterceptorChain方法，运用责任链模式，开始一层层传入各个拦截器，每个拦截器都有着自己都职责，最终在CallServerInterceptor发出请求并获取响应，然后层层返回响应。异步请求流程大致和同步请求相似，但是最后的执行方法是enqueue，并传入回调对象。
Android-详解网络请求框架-OkHttp（源码）
q1210249579的博客
12-06 1561
前言 1.OkHttp的优点 网络方面 （1）它支持http2.0，在网络请求响应方面使用了多路复用； （2）内置连接池，减少连接开销，复用连接； （3）内有Response缓存，缓存响应，避免重复的请求； （4）对响应体支持gzip压缩,使得传输数据更为轻量； （5）支持SPDY,允许连接同一主机的所有请求分享一个socket； 拓展方面 （1）支持重定向，重试请求，重写编码拦截器； （2）支持头部信息拦截，自带CookieJar方法； （3）支持网络数据传输时的监听； （4）通过需求能自定义拦截器进行处
Java：OkHttp基本使用发起HTTP网络请求
彭世瑜的博客
08-27 7775
文档：https://square.github.io/okhttp/ 依赖 <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>4.8.1</version> </dependency> <dependency> <group
EasyHttp_OkHttp网络请求框架_EasyHttp_
09-30
EasyHttp是一个基于OkHttp的网络请求框架，专为简化Android应用中的网络操作而设计。OkHttp作为现代HTTP客户端，以其高效、稳定和易用性在Android开发者中广受欢迎。EasyHttp将OkHttp的功能进一步封装，提供了更加...
okhttp框架封装
04-10
在移动应用开发中，网络请求是必不可少的部分，OkHttp作为一个高效的HTTP客户端，被广泛用于Android和Java项目中。它的优势在于其性能优化、连接池管理以及强大的缓存机制。本篇文章将深入探讨如何对OkHttp进行封装...
Okhttp+Retrofit2+RxJava1.0.0 网络请求框架
08-13
【Okhttp+Retrofit2+RxJava1.0.0 网络请求框架】是Android开发中一种高效、易用的网络请求解决方案，结合了三个强大的库：Okhttp作为网络底层通信，Retrofit作为接口调用的封装，以及RxJava用于异步处理和流式数据...
http框架--OkHttp 4 架构与源码分析
penriver的博客
06-30 1261
1. OkHttp 1.1. 概述 OkHttp现在应该算是最火的Http第三方库，Retrofit底层也是使用OkHttp OkHttp官网地址：http://square.github.io/okhttp/ OkHttp GitHub地址：https://github.com/square/okhttp 1.3. 出现背景 网络访问的高效性要求，可以说是为高效而生 1.3. 特性 提供了对 HTTP/2 的支持，对同一个主机发出的所有请求都可以共享相同的套接字连接 如果HTTP/2 不可用，使用连接池
okhttp框架的基本使用（实用）
mm731296278的博客
11-30 1035
okhttp的Get同步请求，Get异步请求，Post同步请求，Post异步请求
okhttp网络框架的使用
Zuo_XP的博客
10-10 2159
OKhttp使用的步骤： 1.在build中加入okhttp，Gson的架包，还有修改build中的picasso：compile 'com.squareup.picasso:picasso:2.5.2',因为版本过低会出现问题 2.在修改仓库的地址，因为翻墙比较慢，即修改工程另一个build(可以不修改仓库，因为修改了运行不成功) 3.在类中编写okhttp代码，（获取的json数据，直接
http网络请求框架
pcy15637130099的博客
06-15 2166
一.开发初衷：最近项目中需要用到版本升级这一块，需要用到一些基本的数据请求与文件下载功能。之前做项目都是用别人的网络框架，类似retrofit 、 okhttp、 fresco等框架，用的多了，发现这几个网络请求框架，无非都是 按解决以下几个问题为导向的： 1.怎么发请求？ 2.Cookie的问题。 3.如何停止请求（好像上面提到的几个框架没有停止请求的概念，因为停止请...
基于OkHttp3封装网络请求框架
乔布奇的博客
12-14 1万+
前言 网络请求可以说是开发一款移动APP最核心的基础功能了，通过实际工作中以及浏览了许多网络框架之后，本篇在这里分享慕课一位老师基于OkHttp封装的一个轻量的网络框架，至于为什么说它轻量，因为代码少啊！在这里会实现基本的get/post请求，并且支持https加密请求，通过封装方便使用的API，来简化我们的调用方式，对于文件的上传和下载在后续的功能中我会补上这一部分，因为时间关系，前...
java使用OkHttp
文盲青年的博客
01-07 1万+
在做网络编程时，很多程序猿都会使用Apache的HttpClient，也有很多大佬自己封装HttpURLConnection，但是笔者认为最强的，还是大名鼎鼎的OkHttp。 源码地址：https://github.com/square/okhttp 使用方法：参照这位老铁的博客，写的非常详细。 https://blog.csdn.net/tanga842428/article/details/7...
Android 网络请求框架 OkHttp 的使用
热门推荐
baipenggui_bo
03-04 1万+
一.OkHttp的历史和意义一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司贡献(该公司还贡献了Picasso)用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里已移除HttpClient,现在已经打不出来)。尽管Google在大部分安卓版本中推荐使用HttpURLConnection，但是这个类相...
主流网络框架OkHttp简介与基本用法
weixin_38196407的博客
05-01 2487
主流网络框架OkHttp简介与基本用法 一、OkHttp简介 OkHttp是Square公司开源的针对Java和Android程序，封装的一个高性能http请求库。 相比于volley、retrofit、android-async-http封装了具体的请求，线程的切换以及数据转换，OkHttp是基于http协议封装的一套请求客户端，虽然其同样可以开线程，但是根本上它更偏向真正的请求，跟HttpCl...
5、Android客户端访问网络发送HTTP请求可以使用OkHttp开源框架。
06-12
正确。OkHttp是一个开源的HTTP客户端，由Square公司开发，可在Android和Java应用程序中使用，用于发送和接收HTTP请求和响应。OkHttp具有简单易用的API、高效的连接管理、支持SPDY、HTTP/2协议等特点。在Android客户端中，使用OkHttp可以方便地进行网络请求的发送和处理。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值