对 okhttp 网络框架的封装 easy-okhttp

Apache
Java 查看源码»
跨平台
2016-12-21
mzllon

# easy-okhttp

Maven CentralLicense

easy-okhttp是对okhttp3上层封装的网络框架,支持文件上传和下载表单提交(文件和一个参数对应多值),链式调用,并且默认整合Gson,对返回结果多种转换,同时还支持HTTPS单向认证和双向认证等特性。

okhttp3网络框架的流行始于Android,但是在Java后端仍然是Apache HttpClient网络框架,这个框架的缺点在于设计非常的复杂,而且Jar包比较大。因此封装easy-okhttp网络框架是降低对网络操作的难度,更是希望弃用Apache HttpClient,其次也是为了帮助 okhttp3 的推广。

框架特性

  • 仅支持GET和POST两种方式,其他如PUT等不太常用,就暂不支持
  • 基于POST的大文本数据、二进制文件上传,即通过Http Body提交
  • 表单提交,带有文件的表单提交和表单提交支持参数名重复,在后台接收到的是数组或集合
  • 支持session保持
  • 对HTTPS支持单向认证和双向认证
  • 支持同步请求和异步请求,统一的数据处理接口
  • 开箱即用,默认的配置基本上满足需求

框架引入

Maven之下

<dependency>
    <groupId>com.mzlion</groupId>
    <artifactId>easy-okhttp</artifactId>
    <version>1.0.0-Final</version>
</dependency>

Gradle之下

compile 'com.mzlion:easy-okhttp:1.0.7-beta'

用法示例

1.普通的GET请求无参数

 String responseData = HttpClient
                .get("http://localhost:8080/okhttp-server-test/userInfo/pageSelect") 
                // 请求方式和请求url .execute()
                .asString();

2.普通的GET请求带参数

String responseData = HttpClient
                .get("http://localhost:8080/okhttp-server-test/userInfo/pageSelect") 
                //请求方式和请求url 
               .queryString("username","mzlion")   //设置请求参数
                .execute()
                .asString();

3.POST普通表单提交

String responseData = HttpClient
                .post("http://localhost:8080/okhttp-server-test/userInfo/create")
                //请求方式和请求url
                .param("username","mzlion")  // 表单参数
                .param("userPwd", "123")     // 表单参数
                //queryString("queryTime","20160530") //url参数
                .execute()
                .asString();
                //formParam()重载方法还支持`Map`

4.POST提交String

String responseData = HttpClient
                .textBody("http://localhost:8080/okhttp-server-test/userInfo/create")
                 // 请求方式和请求url
                .json("{\"username\":\"mzlion\",\"userPwd\":\"123\"}")
                // post提交json
                //.xml("") 
                //post提交xml
                //.html("function fun(){}")
                //post提交html
                //.charset("utf-8")
                //设置编码
                .execute()
                .asString();

5.POST提交二进制文件

 String responseData = HttpClient
                .binaryBody("http://localhost:8080/okhttp-server-test/userInfo/avatar")
                 // 请求方式和请求url
                .stream(this.getClass().getClassLoader().getResourceAsStream("andy-bao.jpg"))
                // post提交流
                //.file(new File("d:/andy-bao.jpg")) //post提交文件
                .contentType(ContentType.IMAGE_JPG)
                //设置请求内容类型
                .execute()
                .asString();
                //ContentType内置常见的MIME类型,基本上不用自己创建了

6.POST表单提交含文件上传

String responseData = HttpClient
                .formDataPost("http://localhost:8080/okhttp-server-test/userInfo/createWithFile")
                //请求方式和请求url
                .param("userName", "test")
                .param("userPwd", "123456")
                .param("nickName", "Test")
                .param("realName", "测试")
                .param("hobby", "测试,就爱测试")
                .param("avatarFile", this.getClass().getClassLoader().getResourceAsStream("andy-bao.jpg"), "andy-bao.jpg")
                //.formParam("avatarFile", this.getClass().getClassLoader().getResourceAsStream("andy-bao.jpg"), "andy-bao.jpg")
                .execute()
                .asString();
                //formParam()重载方法还支持`Map`

7.自定义签名网站https访问

>自签名网站htts访问处理方式非常简单,首先拿到客户端的签名证书,一般通过浏览器就可以导出xxx.cer证书了。然后将拿到的证书文件拷贝到自己的项目中,然后按照如下方式调用或设置。

 String responseData = HttpClient.get()    
 	        //设置请求方式
                .url("https://kyfw.12306.cn/otn/")
                //设置请求地址
                .readTimeout(30000)     //覆盖设置,读取超时时间
                .https(this.getClass().getClassLoader().getResourceAsStream("SRCA.cer"))
                .execute()            //执行
                .asString();
的码云指数为
超过 的项目
加载中

评论(7)

_笔记本_
_笔记本_
如何更改okhttp默认连接池的连接数量呢
Fover
Fover
看了各种封装自己还是选择retrofit 省的折腾,文档和资料也比较多。
loyal
loyal
更是希望启用Apache HttpClient 你的意思是 启用=弃用吧?
大賢者
大賢者
以为是服务端,结果是HttpClient。。。
老中士
没有演示异步方式 只有post和get太局限了
公孙二狗
公孙二狗
好用
xiaolei123
xiaolei123
这样子会不会阻塞线程呢?

easy-okhttp v1.1.0 新版发布

年后第一个版本维护更新,一直忙于微信会员卡和支付宝会员卡的事情,所以就耽搁到现在才发布新版本。 v1.1.0版本发布更新: 更新默认超时时间单位为秒; 增加超时设置方法,支持自定义时间单位...

2017/03/21 23:41

easy-okhttp 1.0.10-Final 发布

easy-okhttp 1.0.10-Final 发布了,easy-okhttp是一个基于okhtp3的网络工具,目的为了简化okhttp3的使用,解放使用apache-httpclient的同学们,因为apache-httpclient还是蛮复杂的。 更新内容...

2017/01/04 11:21

没有更多内容

加载失败,请刷新页面

没有更多内容

暂无问答

feign和okhttp的结合

背景 使用feign可以很方便的调用各种http接口 http请求神器之Feign 那么feign是如何做到的呢? 分析 本质上默认场景feign仍然是使用httpClient进行调用的。 通过声明式的RequestMapping等注解...

2018/07/11 18:49
454
0
OkHttp 2.0

转载自:https://publicobject.com/2014/05/24/okhttp-2-0-rc1/ Adrian, Jake and I have been working on OkHttp 2.0 quite actively for nearly a year, and we're finally ready to share...

2015/04/11 21:09
243
1
Android 网络请求方面的资料

### 1.[Okhttp使用注意事项](http://www.jacpy.com/2017/09/28/okhttp-used-attentions.html) ### 2.[OKHttp使用详解](https://blog.csdn.net/fightingXia/article/details/70947701) ### 3...

2018/05/31 10:03
14
0
spring传统xml配置okhttp3

# 问题 后端服务需要使用http客户端请求其他服务支持,项目中需要将HttpClient换成OKhttp,为啥要换OKhttp?这里不讨论这两者之间的优缺点。这篇文章主要关注与Spring传统xml配置方式集成Okh...

2018/06/12 15:55
20
0
OkHttp的使用

在安卓中大家使用HTTP工具去获取网络数据时,会感觉比较麻烦,这里,用okhttp的网络框架去做的话,会简单很多,这里用一个简单的例子来讲一下okhttp的使用吧 首先,在androidStudio的项目中,...

2018/05/15 21:05
43
0
Eclipse:Unsupported major.minor version 51.0 error

最近在做项目的时候,由于我们提供的 sdk 里面有依赖 OkHttp 和 OkIO,好像从 v2.0 开始,OkHttp 要求 Jdk 1.7。导致 sdk 不能在 JDK 1.6 环境里面运行,为了兼容,我找到了这两个 repo: ht...

2015/08/05 22:18
147
0
feign使用okhttp做拦截器

背景 feign和okhttp的结合 用的Okhttp场景下我们会使用OkHttp的拦截器 /** * Observes, modifies, and potentially short-circuits requests going out and the corresponding * responses ...

2018/07/16 12:46
177
0
自定义OkHttp的UA

背景 上次的问题很明显 由于我们的ua清一色OkHttp导致快速定位到内部应用。 既然如此我们是否考虑可以在UA上做点手脚。 自定义我们的UA呢??? 分析 首先UA在 均为okhttp/3.2.0 大概率是由于...

2018/07/16 12:47
115
0
OkHttp

OkHttp

2015/11/19 19:36
185
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部