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

最新推荐文章于 2024-07-27 04:13:50 发布
最新推荐文章于 2024-07-27 04:13:50 发布
阅读量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());
思念叨火车
关注
专栏目录
网络请求框架OkHttp4的使用与原理解析01：任务调度与拦截器分析
老蒋也疯狂
04-21 1191
OkHttp任务调度流程： 1. OkHttpClient构建过程分析 案例： OkHttpClient client = new OkHttpClient.Builder() .addInterceptor(new CustomInterceptor()) .cache(new Cache(cacheDir, cacheSize)) .readTimeout(1000, TimeUnit.MILLISECONDS) .writeTimeout(1000,
android okhttp网络请求框架
08-08
**Android OkHttp 网络请求框架** OkHttp 是由 Square 公司开发的一个高效的网络请求库，广泛应用于 Android 开发中。它以其强大的性能、简单易用的 API 和丰富的特性，深受开发者喜爱。OkHttp 的核心设计理念是...
HTTP网络请求框架
08-14
简介: 本框架是在Netroid的基础之上进行了封装,节省了其中配置的过程和一些不必要的操作 主要进行文本请求和图片请求,图片请求都进行了缓存(内存缓存和sd卡缓存)的封装,sd卡缓存时间可自行更改. 文本请求可传入解析的泛型clazz,即可返回解析后的clazz对象进行数据 操作,如果不需要进行数据解析,可通过另一种方式获取原生的string; 单图请求,单图请求可执行对本地asset文件夹,sd卡,http三种请求模式.只需传入相应的路径即可; 多图请求,多图请求主要是针对listview这种图文混排模式而生,能快速加载图片并实现缓存,不需要考虑 图片错位问题.只需传入相应的url即可完成全部功能. 使用说明: 1:在新创建的Manifest.xml中application中申明: <application android:allowBackup="true" android:icon="@drawable/ic_launcher" android:label="@string/app_name" android:theme="@style/AppTheme" android:name="com.aqs.application.UApplication" > 并初始化Const.init();此处的初始化主要是对内存缓存,SD卡缓存大小,缓存时间等进行设置,如果不初始化,则按使用默认配置; 2:依赖HttpAqs-library或者jar包 3:通过公有方法进行网络请求,示例如下: >文本请求: >解析后的文本请求: HttpRequest.reqquest(int,String,Parse,Class){....}; >原生string文本请求: HttpRequest.getString(String,AqsString){...} >单张图片请求: HttpRequest.setImage(ImageView,String,int,int){...} >多张图片请求: 可使用AQSImageView控件来加载图片;特别是针对listview图文混排 实现方法: >在布局中添加 >在代码中 av.setImageUrl(url);
RxHttp 让你眼前一亮的Http请求框架
ZyClient的博客
01-09 1713
1 前言 RxHttp在今年4月份一经推出，就受到了广大Android 开发者的喜爱，截止本文发表在github上已有800+star，为此，我自己也建个RxHttp&RxLife 的群（群号：290611780） 目前群里也有将近120号人，里面有不少小伙伴提了很多有价值的创意，才使得RxHttp一直坚持走到了现在，在此，感谢大家的喜爱。 这期间，一...
高性能网络请求框架OKHTTP
最新发布
weixin_40527484的博客
07-27 43
OkHttp是一个开源的HTTP客户端库，用于在Java和Kotlin应用程序中进行网络请求和处理响应。它由Square开发，提供了简单、高效且易于使用的API。支持HTTP/2和SPDY：OkHttp支持最新的HTTP协议版本，包括HTTP/2和SPDY，以提供更快速和高效的网络通信。连接池和请求重用：OkHttp自动管...
http网络请求框架
pcy15637130099的博客
06-15 2176
一.开发初衷：最近项目中需要用到版本升级这一块，需要用到一些基本的数据请求与文件下载功能。之前做项目都是用别人的网络框架，类似retrofit 、 okhttp、 fresco等框架，用的多了，发现这几个网络请求框架，无非都是 按解决以下几个问题为导向的： 1.怎么发请求？ 2.Cookie的问题。 3.如何停止请求（好像上面提到的几个框架没有停止请求的概念，因为停止请...
迄今最好的Http请求框架
chengjiaoli0417的博客
07-28 132
本文原创，转载请注明链接http://blog.kymjs.com/ KJFrameForAndroid下载地址：https://github.com/kymjs/KJFrameForAndroid 基础功能 KJHttp是专为解决Android中Http通信而产生的，它在请求...
OkHttp基本使用教程（安卓端http请求框架）
01-20
OkHttp基本使用教程（安卓端流行的http请求框架） 简介 android网络请求框架之OkHttp，一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里...
EasyHttp_OkHttp网络请求框架_EasyHttp_
09-30
EasyHttp是一个基于OkHttp的网络请求框架，专为简化Android应用中的网络操作而设计。OkHttp作为现代HTTP客户端，以其高效、稳定和易用性在Android开发者中广受欢迎。EasyHttp将OkHttp的功能进一步封装，提供了更加...
http请求框架，初学者简单易用，VvHttp更新
06-13
超简单http请求，http,post,图片请求
Okhttp框架
04-12
网络技术框架okhttp
HTTP网络框架
02-26
这是一个多线程支持高并发的HTTP 服务器 框架，可以直接编译使用。业务逻辑都可以模块化，非常简便好用。
OkHttp框架
耳语心声
03-22 2246
简介：一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司贡献，用于替代HttpUrlConnection和Apache HttpClient。OkHttp可以支持安卓2.3及以上版本，需要jdk1.7及以上；OkHttp有2.x和OkHttp3.x版本之间的部分方法的使用有一点的差异。优点（百度百科）：1、允许连接到同一个主机地址的所有请求,提高请求效率2、共享So...
okhttp网络请求框架
莎木吉尔
06-28 724
* okhttp是非常高效的网络请求,它是基于http/http2。 * * 1、允许同一主机的所有请求共享一个socket * 2、减少网络请求时间Connection pooling reduces request latency (if HTTP/2 isn’t available). * 3、使用gzip压缩，缩小下载大小。 * 4、响应缓存避免了网络重复请求 * 5、断线重连，多地址请
小型Http服务器
weixin_30716725的博客
07-24 366
　　HTTP又叫做超文本传输协议，现如今用的最多的版本是1.1版本。HTTP有如下的特点： 　　　　支持客户/服务器模式（C/S或B/S） 　　　　简单快速：基于请求和响应，请求只需传送请求方法和请求路径 　　　　灵活：HTTP允许传送人任意类型的数据对象。 　　　　无连接：这个无连接说的是应用层，应用层无连接，下层使用TCP依然是面向连接的，无连接的含义是限制在每一次连接只处理一个请求，...
再见，HttpClient！再见，Okhttp！
weixin_44421461的博客
03-07 309
点击上方“Java基基”，选择“设为星标”做积极的人，而不是积极废人！源码精品专栏原创 | Java 2020超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网...
开原框架OKHTTP
l18320786461的博客
04-09 1419
由Square公司贡献的一个处理网络请求的开源项目，是目前Android使用最广泛的网络框架。从Android4.4开始 HttpURLConnection的底层实现采用的是OkHttp。 特点： 1、支持HTPP/2并允许对同一主机的所有请求共享套接字 2、如果非HTTP/2，则通过连接池减少请求延迟 3、默认请求GZip压缩数据 4、响应缓存，避免了重复请求的网络 使用方法： private static void get(String url,OkHttpClient client)
Okhttp：Android主流网络请求框架，替代HttpUrlConnection与Apache HttpClient
Okhttp网络请求框架是当前安卓移动应用开发中广泛采用的一种高效且功能强大的网络请求库，由知名软件开发公司Square设计并维护。它旨在替代旧版的HttpUrlConnection和Apache HttpClient，这两个在Android早期版本中...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值