https://github.com/troyzhxu/okhttps
如艺术一般优雅，像 1、2、3 一样简单，前后端通用，轻量却强大的 HTTP 客户端（同时支持 WebSocket 与 Stomp 协议）
https://github.com/troyzhxu/okhttps
android download download-manager httputils okhttp okhttp3 okhttp3-util okhttps-okhttp3 okhttputils upload
Last synced: 6 months ago
JSON representation
如艺术一般优雅，像 1、2、3 一样简单，前后端通用，轻量却强大的 HTTP 客户端（同时支持 WebSocket 与 Stomp 协议）
- Host: GitHub
- URL: https://github.com/troyzhxu/okhttps
- Owner: troyzhxu
- License: apache-2.0
- Created: 2020-03-31T08:22:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T10:14:21.000Z (7 months ago)
- Last Synced: 2025-04-02T10:08:24.661Z (6 months ago)
- Topics: android, download, download-manager, httputils, okhttp, okhttp3, okhttp3-util, okhttps-okhttp3, okhttputils, upload
- Language: Java
- Homepage: https://ok.zhxu.cn
- Size: 1.64 MB
- Stars: 504
- Watchers: 11
- Forks: 76
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## 文档
网址：https://ok.zhxu.cn
## 为什么用
OkHttps 是近期开源的对 OkHttp3 轻量封装的框架，它独创的异步预处理器，特色的标签，灵活的上传下载进度监听与过程控制功能，在轻松解决很多问题的同时，设计上也力求纯粹与优雅。
* 超级优雅的 API 设计，且链式调用，让你顺滑到底！
* BaseURL、URL占位符、HTTP 同步 异步、WebSocket，让你想干啥就干啥！
* JSON、Xml 等自动封装与解析，且支持与任意格式的数据解析框架集成，想用啥就用啥！
* 同步拦截器、异步预处理器、回调执行器、全局监听、回调阻断 等等，让你扩展无限功能！
* 文件上传下载（过程控制、进度监听），上传下载如此简单！
* 单方法回调，充分利用 Lambda 表达式，让你代码超级简洁！
* 超级轻量，但性能卓越！
* **阿里云最低 1 折**：https://www.aliyun.com/minisite/goods?userCode=zugtbi5w
## 如何使用
### 如艺术一般优雅，像 1、2、3 一样简单
```java
// 同步 HTTP
List users = OkHttps.sync("/users")
.get() // GET请求
.getBody() // 响应报文体
.toList(User.class); // 自动反序列化 List
// 异步 HTTP
OkHttps.async("/users/1")
.setOnResponse(res -> {
// 自动反序列化 Bean
User user = res.getBody().toBean(User.class);
})
.get(); // GET请求
// WebSocket
OkHttps.webSocket("/chat")
.setOnMessage((WebSocket ws, Message msg) -> {
// 从服务器接收消息
Chat chat = msg.toBean(Chat.class);
// 向服务器发送消息
ws.send(chat);
})
.listen(); // 启动监听
```
### 请求三部曲
#### 第一步、确定请求方式
* 同步 HTTP - `sync` 方法
* 异步 HTTP - `async` 方法
* WebSocket - `webSocket` 方法
#### 第二步、构建请求任务
* `addXxxPara` - 添加请求参数
* `setOnXxxx` - 设置回调函数
* `tag` - 添加标签
* ...
#### 第三步、调用请求方法
HTTP 请求方法：
* `get()` - GET 请求
* `post()` - POST 请求
* `put()` - PUT 请求
* `delete()` - DELETE 请求
* ...
Websocket 方法：
* `listen()` - 启动监听
#### 任意网络请求，都遵循请求三部曲！
## 相关项目
项目 | 最新版本 | 描述
-|-|-
[okhttps](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps) | 4.1.0 | OkHttps 核心模块
[okhttps-fastjson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-fastjson) | 4.1.0 | 与 fastjson 集成
[okhttps-fastjson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-fastjson2) | 4.1.0 | 与 fastjson2 集成
[okhttps-fastjson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-fastjson2-jsonb) | 4.1.0 | 与 fastjson2-jsonb 集成
[okhttps-gson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-gson) | 4.1.0 | 与 gson 集成
[okhttps-jackson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-jackson) | 4.1.0 | 与 jackson 集成
[okhttps-jackson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-jackson-xml) | 4.1.0 | 与 jackson-xml 集成
[okhttps-jackson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-jackson-yaml) | 4.1.0 | 与 jackson-yaml 集成
[okhttps-jackson](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-snack3) | 4.1.0 | 与 jackson-yaml 集成
[okhttps-stomp](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-stomp) | 4.1.0 | 超级轻量的 Stomp 客户端
[okhttps-xml](https://gitee.com/troyzhxu/okhttps/tree/dev/okhttps-xml) | 3.5.3 | XML 解析扩展
## 超详细教程，请查看：https://ok.zhxu.cn
## 联系方式
* 微信：
* 由于近期交流群的二维码被爬，扫码入群方式已被关闭
库的使用上若有疑问，可先加微信【18556739726】（请备注 OkHttps）再入群交流
## 友情链接
[**[ Bean Searcher ]** 比 MyBatis 效率快 100 倍的条件检索引擎，天生支持联表，使一行代码实现复杂列表检索成为可能！](https://github.com/ejlchina/bean-searcher)
[**[ SA Token ]** 一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！](https://github.com/dromara/Sa-Token)
[**[ hrun4j ]** 接口自动化测试解决方案 --工具选得好，下班回家早；测试用得对，半夜安心睡 ](https://github.com/lematechvip/hrun4j)
[**[ Json Kit ]** 超轻量级 JSON 门面工具，用法简单，不依赖具体实现，让业务代码与 Jackson、Gson、Fastjson 等解耦！](https://gitee.com/troyzhxu/jsonkit)
## 参与贡献
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request