OkHttp3开发

最新推荐文章于 2024-05-22 10:42:27 发布
最新推荐文章于 2024-05-22 10:42:27 发布
阅读量7.5k 收藏 5
点赞数
分类专栏： Android 文章标签： 网络请求 Okhttp3.0

OkHttp3开发三部曲：

1、创建OkHttpClient，添加配置

2、创建请求

3、执行请求

下面分别来说说这三个步骤：

一、创建OkHttpClient

一个最简单的OkHttpClient

[java] view plain copy
  1. OkHttpClient okHttpClient=new OkHttpClient.Builder().build();  
一个复杂点的OkHttpClient配置
[java] view plain copy
  1. File cacheDir = new File(getCacheDir(), "okhttp_cache");  
  2. //File cacheDir = new File(getExternalCacheDir(), "okhttp");  
  3. Cache cache = new Cache(cacheDir, 10 * 1024 * 1024);  
  4.   
  5. okHttpClient = new OkHttpClient.Builder()  
  6.             .connectTimeout(5*1000, TimeUnit.MILLISECONDS) //链接超时  
  7.             .readTimeout(10*1000,TimeUnit.MILLISECONDS) //读取超时  
  8.             .writeTimeout(10*1000,TimeUnit.MILLISECONDS) //写入超时  
  9.             .addInterceptor(new HttpHeadInterceptor()) //应用拦截器：统一添加消息头  
  10.             .addNetworkInterceptor(new NetworkspaceInterceptor())//网络拦截器  
  11.             .addInterceptor(loggingInterceptor)//应用拦截器：打印日志  
  12.             .cache(cache)  //设置缓存  
  13.             .build();  
具体可配置参数见OkHttpClient.Builder类,几点注意事项：
1、拦截器

两种拦截器：Interceptor(应用拦截器)、NetworkInterceptor(网络拦截器)

两种拦截器的区别

1）Interceptor比NetworkInterceptor先执行
2）同一种Interceptor倒序返回
A(start)----B(start)----B(end)----A(end)

因此上面配置的Interceptor执行顺序如下
HttpHeadInterceptor start----LoggingInterceptor start----LoggingInterceptor end---HttpHeadInterceptor end

3）日志拦截器

自定义日志拦截器

[java] view plain copy
  1. public class LoggingInterceptor implements Interceptor {  
  2.   private static final String TAG="Okhttp";  
  3.   @Override public Response intercept(Interceptor.Chain chain) throws IOException {  
  4.     Request request = chain.request();  
  5.   
  6.     long t1 = System.nanoTime();  
  7.     Log.d(TAG,String.format("Sending request %s on %s%n%s",  
  8.         request.url(), chain.connection(), request.headers()));  
  9.   
  10.     Response response = chain.proceed(request);  
  11.     long t2 = System.nanoTime();  
  12.     Log.d(TAG,String.format("Received response for %s in %.1fms%n%s",  
  13.         response.request().url(), (t2 - t1) / 1e6d, response.headers()));  
  14.   
  15.     MediaType mediaType = response.body().contentType();  
  16.     String content = response.body().string();  
  17.     Log.d(TAG,content);  
  18.   
  19.     response=response.newBuilder()  
  20.                     .body(ResponseBody.create(mediaType,content))  
  21.                     .build();  
  22.     return response;  
  23.   }  
  24. }  
官方提供的Logging Interceptor

地址：https://github.com/victorfan336/okhttp-logging-interceptor
gradle.build中添加依赖：
compile 'com.squareup.okhttp3:logging-interceptor:3.1.2'

使用

[java] view plain copy
  1. HttpLoggingInterceptor logging = new HttpLoggingInterceptor();  
  2. logging.setLevel(Level.BODY);//日志级别，Body级别打印的信息最全面  
  3. OkHttpClient client = new OkHttpClient.Builder()  
  4.   .addInterceptor(logging)  
  5.   .build();  
2、开发中应该只维护一个OkHttpClient实例，这样可以复用连接池、线程池等，避免性能开销
如果想修改参数，可通过
okHttpClient.newBuilder()修改，这样可以复用okHttpClient之前的所有配置，
比如想针对某个请求修改链接超时。
[java] view plain copy
  1. OkHttpClient newClient=okHttpClient.newBuilder()  
  2.        .connectTimeout(10*1000,TimeUnit.MILLISECONDS)  
  3.        .build();  
  4. newClient.newCall(req);   

二、创建请求

通过Request.Builder创建请求，默认是Get请求

[java] view plain copy
  1. Request req = new Request.Builder().url(url).build();  
  2. Call call=okHttpClient.newCall(req);  
GET请求
[java] view plain copy
  1. Request req = new Request.Builder().url(url).build();  
  2. okHttpClient.newCall(req);  
POST请求

主要是构建RequestBody，并设置Content-Type消息头。

1、普通Post请求

比如json请求

[java] view plain copy
  1. RequestBody requestBody = RequestBody.create(MediaType.parse("application/json"), jsonObject.toString());  
  2. Request req = new Request.Builder().url(url)  
  3.         .post(requestBody)  
  4.         .build();  
  5. okHttpClient.newCall(req);  
2、表单POST请求
Content-Type: application/x-www-form-urlencoded
比如：
[java] view plain copy
  1. RequestBody requestBody =  
  2.             new FormBody.Builder()  
  3.                     .add("username", "zhangsan")  
  4.                     .add("password", "1111111")  
  5.                     .build();  
  6. Request req = new Request.Builder().url(url).post(uploadBody).build();  
  7. okHttpClient.newCall(req);  
3、表单上传文件
Content-Type: multipart/form-data
比如：
[java] view plain copy
  1. RequestBody uploadImg = RequestBody.create(MediaType.parse("image/jpeg"), file);  
  2. MultipartBody uploadBody = new MultipartBody.Builder()  
  3.         .setType(MultipartBody.FORM)  
  4.         .addFormDataPart("username", "zhangsan")  
  5.         .addFormDataPart("password", "11111")  
  6.         .addFormDataPart("img", fileName, uploadImg)  
  7.         .build();  
  8. Request req = new Request.Builder().url(url).post(uploadBody).build();  
  9. okHttpClient.newCall(req);  

三、执行请求

1、同步执行

[java] view plain copy
  1. Response response = call.execute();  
由于android强制要求网络请求在线程中执行，所以无法使用execute

2、异步执行

[java] view plain copy
  1. call.enqueue(new Callback() {  
  2.     @Override  
  3.     public void onFailure(Call call, IOException e) {  
  4.         //失败回调  
  5.     }  
  6.   
  7.     @Override  
  8.     public void onResponse(Call call, Response response) throws IOException {  
  9.          //成功回调，当前线程为子线程，如果需要更新UI，需要post到主线程中  
  10.        
  11.         boolean successful = response.isSuccessful();  
  12.         //响应消息头  
  13.         Headers headers = response.headers();  
  14.         //响应消息体  
  15.         ResponseBody body = response.body();  
  16.         String content=response.body().string());  
  17.         //缓存控制  
  18.         CacheControl cacheControl = response.cacheControl();  
  19.           
  20.     }  
  21. });  
1）Response:封装了网络响应消息，比如响应消息头、缓存控制、响应消息体等。
String content=response.body().string(); //获取字符串
InputStream inputStream = response.body().byteStream();//获取字节流(比如下载文件)
2）Callback回调是在子线程中执行的，如果要更新UI，请post到主线程中。
Okhttp使用上的一些缺点
1、对于Get请求，如果请求参数较多，自己拼接Url较为麻烦

比如

[java] view plain copy
  1. HttpUrl httpUrl = new HttpUrl.Builder()  
  2.                .scheme("http")  
  3.                .host("www.baidu.com")  
  4.                .addPathSegment("user")  
  5.                .addPathSegment("login")  
  6.                .addQueryParameter("username", "zhangsan")  
  7.                .addQueryParameter("password","123456")  
  8.                .build();  
拼接结果：http://www.baidu.com/user/login/username=zhangsan&password=123456

如果能做一些封装，直接addParam(key,value)的形式则会简单很多。

2、Callback在子线程中回调，大部分时候，我们都是需要更新UI的，还需自己post到主线程中处理。
3、构建请求步骤比较多
因此，Square提供了针对OkHttp的封装库Retrofit，另外Github上也有很多第三方的封装库,比如OkGo。

参考文档
https://github.com/square/okhttp/wiki
https://github.com/victorfan336/okhttp-logging-interceptor

http://www.jianshu.com/p/2710ed1e6b48


基于okhttp3的工具类HttpUtils


import com.alibaba.fastjson.JSON;
import lombok.Builder;
import lombok.ToString;
import okhttp3.*;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.ws.rs.NotSupportedException;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;

/**
 * Created by admin on 2016/12/6.
 */
public class HttpUtils {

    private final static Logger log = LoggerFactory.getLogger(HttpUtils.class);

    public final static String GET = "GET";
    public final static String POST = "POST";
    public final static String PUT = "PUT";
    public final static String DELETE = "DELETE";
    public final static String PATCH = "PATCH";

    private final static String UTF8 = "UTF-8";
    private final static String GBK = "GBK";

    private final static String DEFAULT_CHARSET = UTF8;
    private final static String DEFAULT_METHOD = GET;
    private final static String DEFAULT_MEDIA_TYPE = javax.ws.rs.core.MediaType.APPLICATION_JSON;
    private final static boolean DEFAULT_LOG = false;

    private final static OkHttpClient client = new OkHttpClient.Builder()
            .connectionPool(new ConnectionPool(20, 5, TimeUnit.MINUTES))
            .readTimeout(20, TimeUnit.SECONDS)
            .connectTimeout(20, TimeUnit.SECONDS).build();

    public static void main(String[] args){
        Map<String, String> map = new HashMap<>();
        map.put("k", "v");
        execute(OkHttp.builder().url("http://httpbin.org/get?k1=v1").method(GET).headerMap(map).queryMap(map).requestLog(true).responseLog(true).build());
        execute(OkHttp.builder().url("http://httpbin.org/post?k1=v1").method(POST).data("{\"id\":\"1\"}").mediaType(javax.ws.rs.core.MediaType.APPLICATION_JSON).headerMap(map).queryMap(map).requestLog(true).responseLog(true).build());
        execute(OkHttp.builder().url("http://httpbin.org/put?k1=v1").method(PUT).data("{\"id\":\"1\"}").mediaType(javax.ws.rs.core.MediaType.APPLICATION_JSON).headerMap(map).queryMap(map).requestLog(true).responseLog(true).build());
        execute(OkHttp.builder().url("http://httpbin.org/delete?k1=v1").method(DELETE).data("{\"id\":\"1\"}").mediaType(javax.ws.rs.core.MediaType.APPLICATION_JSON).headerMap(map).queryMap(map).requestLog(true).responseLog(true).build());
        execute(OkHttp.builder().url("http://httpbin.org/patch?k1=v1").method(PATCH).data("{\"id\":\"1\"}").mediaType(javax.ws.rs.core.MediaType.APPLICATION_JSON).headerMap(map).queryMap(map).requestLog(true).responseLog(true).build());
    }

    /**
     * GET请求
     * @param url
     * URL地址
     * @return
     */
    public static String get(String url){
        return execute(OkHttp.builder().url(url).build());
    }
    /**
     * GET请求
     * @param url
     * URL地址
     * @return
     */
    public static String get(String url, String charset){
        return execute(OkHttp.builder().url(url).responseCharset(charset).build());
    }

    /**
     * 带查询参数的GET查询
     * @param url
     * URL地址
     * @param queryMap
     * 查询参数
     * @return
     */
    public static String get(String url,  Map<String, String> queryMap){
        return execute(OkHttp.builder().url(url).queryMap(queryMap).build());
    }

    /**
     * 带查询参数的GET查询
     * @param url
     * URL地址
     * @param queryMap
     * 查询参数
     * @return
     */
    public static String get(String url,  Map<String, String> queryMap, String charset){
        return execute(OkHttp.builder().url(url).queryMap(queryMap).responseCharset(charset).build());
    }

    /**
     * POST
     * application/json
     * @param url
     * @param obj
     * @return
     */
    public static String postJson(String url, Object obj){
        return execute(OkHttp.builder().url(url).method(POST).data(JSON.toJSONString(obj)).mediaType(javax.ws.rs.core.MediaType.APPLICATION_JSON).build());
    }

    /**
     * POST
     * application/x-www-form-urlencoded
     * @param url
     * @param formMap
     * @return
     */
    public static String postForm(String url, Map<String, String> formMap){
        String data = "";
        if(MapUtils.isNotEmpty(formMap)){
            data = formMap.entrySet().stream().map(entry->String.format("%s=%s", entry.getKey(), entry.getValue())).collect(Collectors
                    .joining("&"));
        }
        return execute(OkHttp.builder().url(url).method(POST).data(data).mediaType(javax.ws.rs.core.MediaType.APPLICATION_FORM_URLENCODED).build());
    }

    private static String post(String url, String data, String mediaType, String charset){
        return execute(OkHttp.builder().url(url).method(POST).data(data).mediaType(mediaType).responseCharset(charset).build());
    }

    /**
     * 通用执行方法
     */
    private static String execute(OkHttp okHttp){
        if(StringUtils.isBlank(okHttp.requestCharset)){
            okHttp.requestCharset = DEFAULT_CHARSET;
        }
        if(StringUtils.isBlank(okHttp.responseCharset)){
            okHttp.responseCharset = DEFAULT_CHARSET;
        }
        if(StringUtils.isBlank(okHttp.method)){
            okHttp.method = DEFAULT_METHOD;
        }
        if(StringUtils.isBlank(okHttp.mediaType)){
            okHttp.mediaType = DEFAULT_MEDIA_TYPE;
        }
        if(okHttp.requestLog){//记录请求日志
            log.info(okHttp.toString());
        }

        String url =okHttp.url;

        Request.Builder builder = new Request.Builder();

        if(MapUtils.isNotEmpty(okHttp.queryMap)){
            String queryParams = okHttp.queryMap.entrySet().stream()
                                     .map(entry -> String.format("%s=%s", entry.getKey(), entry.getValue()))
                                     .collect(Collectors.joining("&"));
            url = String.format("%s%s%s", url, url.contains("?")?"&":"?", queryParams);
        }
        builder.url(url);

        if(MapUtils.isNotEmpty(okHttp.headerMap)){
            okHttp.headerMap.forEach(builder::addHeader);
        }

        String method = okHttp.method.toUpperCase();
        String mediaType = String.format("%s;charset=%s", okHttp.mediaType, okHttp.requestCharset);

        if(StringUtils.equals(method, GET)){
            builder.get();
        }else if(ArrayUtils.contains(new String[]{POST, PUT, DELETE, PATCH}, method)){
            RequestBody requestBody = RequestBody.create(MediaType.parse(mediaType), okHttp.data);
            builder.method(method, requestBody);
        }else{
            throw new NotSupportedException(String.format("http method:%s not support!", method));
        }

        String result = "";
        try {
            Response response = client.newCall(builder.build()).execute();
            byte[] bytes = response.body().bytes();
            result = new String(bytes, okHttp.responseCharset);
            if (okHttp.responseLog){//记录返回日志
                log.info(String.format("Got response->%s",result));
            }
        }catch (Exception e){
            log.error(okHttp.toString(), e);
        }
        return result;
    }

    @Builder
    @ToString(exclude = {"requestCharset", "responseCharset", "requestLog", "responseLog" })
    static class OkHttp{
        private String url;
        private String method = DEFAULT_METHOD;
        private String data;
        private String mediaType = DEFAULT_MEDIA_TYPE;
        private Map<String, String> queryMap;
        private Map<String, String> headerMap;
        private String requestCharset = DEFAULT_CHARSET;
        private boolean requestLog = DEFAULT_LOG;

        private String responseCharset = DEFAULT_CHARSET;
        private boolean responseLog = DEFAULT_LOG;
    }
}





Android小码农
关注
  • 0
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
深入了解OkHttp3之Interceptors
08-26
OkHttp3中的Interceptors是其核心特性之一，它允许开发者在HTTP请求被发送到服务器以及响应返回给应用程序之前，对请求和响应进行拦截、修改或处理。这些拦截器提供了强大的功能，例如添加自定义请求头、重试失败的...
OKhttpUtils OKHttp3封装
02-24
OKHttp3封装,上传次工具类方便以后开发时便捷使用
okhttp大概流程
zouwei_199388的博客
06-10 191
OkHttp网络请求流程浅析，纯个人学习记录。如有错误，希望大家指正。 实例化OkHttpClient 使用okhttp请求网络，首先得实例化一个OkHtppClient对象。 OkHttpClient对象是通过OkHttpClient中的构造器对象Builder创建。所以先实例化OkHttpClient中的Builder类。 OkHttpClient client; OkHttp...
带你学开源项目：OkHttp-- 自己动手实现 okhttp
liujian8654562的博客
04-10 505
私以为，阅读开源项目是与世界级技术大牛直接对话的最好方式。此次来分享下 OkHttp 源码的分析。 一、开源项目 OkHttp在 Android、Java 开发领域中，相信大家都听过或者在使用 Square 家大名鼎鼎的网络请求库——OkHttp——https://github.com/square/okhttp ，当前多数著名的开源项目如 Fresco、Glide、 Picasso、 Retrof
OkHttp：简单高效的 HTTP 客户端框架的使用
最新发布
mobi的博客
05-22 667
OkHttp 是一个开源的 HTTP 客户端库,由 Square 公司开发并维护。
okhttp builder_Okhttp请求流程梳理
weixin_39860349的博客
11-27 259
最近在看 Okhttp 的源码。不得不说源码设计的很巧妙，从中能学到很多。其实网上关于 Okhttp 的文章已经很多了，自己也看了很多。但是俗话说得好，好记性不如烂笔头，当你动手的时候，你会发现你在看的时候没有注意到的很多细节。本次要分析的 Okhttp 版本是 3.8.1，在 gradle 中引用如下:之所以选择分析3.8.1，是因为最新版是采用 Kotlin 写的，因为本人 Kotlin 实力...
OkHttp用法详解
liuqinhou的博客
02-26 4062
okhttp
OkHttpClient常见方法和使用
架构师之路。。
01-11 2430
OkHttpClient是一个开源的HTTP客户端，用于发送和接收HTTP请求。它是Square公司开发的，用于Android和Java应用程序的网络库。OkHttpClient内置了很多功能，包括连接池、请求和响应拦截器、TLS握手、请求重试等。它易于使用，具有简洁的API，同时还提供了丰富的配置选项，以适应不同的网络需求。使用OkHttpClient，开发人员可以轻松地创建和发送GET、POST、PUT、DELETE等类型的HTTP请求，并处理响应。
android移动开发，okHttp请求.zip
03-16
android移动开发，okHttp请求.zip
Android中okhttp3使用详解
08-29
OkHttp3 是一个流行的基于 HTTP/2 的网络请求库，由 Square 公司开发，广泛应用于 Android 和 Java 项目中。OkHttp3 提供了强大的网络请求功能，支持同步和异步请求，能够满足大多数的网络请求需求。 一、引入 ...
OkHttp3Demo
04-30
OkHttp3Demo ；OKhttp3是一个非常强大的Android网络框架，它是由Square公司开发并开源的，很大Android开发者都会使用到，下载几种的demo跟大家分享一下。
okhttp之OkHttpClient
103style
09-23 3705
转载请以链接形式标明出处： 本文出自:103style的博客 base on 3.12.0 简介 OkHttpClient是通过 builder 模式来为http请求设置相关配置。 创建单个OkHttpClient实例并将其用于所有HTTP调用时，OkHttp的性能最佳。 这是因为每个OkHttpClient都拥有自己的连接池和线程池。 重用连接和线程可减少延迟并节省内存。 相反，为每个...
OkHttpClient使用和封装
qq_25081445的博客
09-29 8268
安卓关于自定义dialog用法总结（仿iOS中ActionSheet） 最近的项目用到了底部弹窗的效果，网上百度了很多类似写好的控件，其中也不乏好的实现。但是为了方便以后扩展，总结了一下前人的经验自己写了实现了一个类： 实现方法 加粗 Ctrl + B 斜体 Ctrl + I 引用 Ctrl + Q 插入链接 Ctrl + L 插入代码 Ctrl +
okhttp篇1: OkhttpClient
yolan6824的博客
05-15 634
对于第一点OkhttpClient，先从OkHttpClient的属性开始。接下来的Okhttp学习就围绕这3点慢慢讲了。后面学习完之后，上面的选项会逐渐补充完整。下一篇，先讲Dispatcher。
Java请求Http接口-OkHttp(超详细-附带工具类)
苍煜
08-17 9422
简介：OkHttp是一个默认有效的HTTP客户端，有效地执行HTTP可以加快您的负载并节省带宽，如果您的服务有多个IP地址，如果第一次连接失败，OkHttp将尝试备用地址。这对于IPv4 + IPv6和冗余数据中心中托管的服务是必需的。OkHttp启动具有现代TLS功能（SNI，ALPN）的新连接，并在握手失败时回退到TLS 1.0，OkHttp支持Android 2.3及更高版本。对于Java，最低要求是1.7。
OkHttpClient设置请求响应时长和请求重试次数
hkm的博客
04-06 8628
依赖jar包 <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.6.0</version> </dependency> 代码 import okhttp3.Interceptor; import okhttp3.OkHttpClient; im
【OkHttp】OkHttp 源码分析 ( OkHttpClient.Builder 构造器源码分析 )
让 学习 成为一种 习惯 ( 韩曙亮 の 技术博客 )
06-24 1908
OkHttp 系列文章目录、 一、OkHttpClient.Builder 各个字段作用、 二、OkHttpClient.Builder 涉及到的相关源码、 三、博客资源、
OkHttp原理解析
lcj908692的博客
05-31 4272
okhttp分析
okhttp和okhttp3
09-29
okhttp和okhttp3是由Square公司开发的网络请求框架。okhttp是okhttp3的前身，okhttp3是对okhttp进行了重构和改进。okhttp3相对于okhttp具有更好的性能和更丰富的功能。okhttp3支持HTTP/2协议，可以进行同步和异步...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值