# 起步

OkHttps 是近期开源的对 OkHttp3 轻量封装的框架,它独创的异步预处理器,特色的标签,灵活的上传下载进度监听与过程控制功能,在轻松解决很多原本另人头疼问题的同时,设计上也力求纯粹与优雅。

  • 链式调用,一点到底
  • BaseURL、URL占位符、JSON自动封装与解析
  • 同步拦截器、异步预处理器、回调执行器、全局监听、回调阻断
  • 文件上传下载(过程控制、进度监听)
  • 单方法回调,充分利用 Lambda 表达式
  • TCP连接池、Http2

TIP

  • OkHttps 非常轻量(59Kb),仅是 Retrofit(124Kb)的一半,并且更加的开箱即用,API 也更加自然和语义化。
  • OkHttps 是一个纯粹的 Java 网络开发包,并不依赖 Android,这一点和 Retrofit 不同
  • OkHttps 用起来很优美,可以像 RxJava 那样链式用,却比 RxJava 更简单。

# 安装

# Maven

<dependency>
     <groupId>com.ejlchina</groupId>
     <artifactId>okhttps</artifactId>
     <version>1.0.5</version>
</dependency>
1
2
3
4
5

# Gradle

implementation 'com.ejlchina:okhttps:1.0.5'
1

安卓中使用需要把 JDK 版本调成 1.8,在 app 模块的 build.gradle 中加入以下配置即可:

android {
    // 省略其它配置..
    compileOptions {
        sourceCompatibility = 1.8
        targetCompatibility = 1.8
    }
}
1
2
3
4
5
6
7

# 使用

# 构建实例

HTTP http = HTTP.builder().build();
1

以上代码构建了一个最简单的HTTP实例,它拥有以下方法:

  • sync(String url) 开始一个同步请求
  • async(String url) 开始一个异步请求
  • cancel(String tag) 按标签取消请求
  • cancelAll() 取消所有HTTP任务,包括同步和异步
  • request(Request request) OkHttp 原生请求
  • webSocket(Request request, WebSocketListener listener) WebSocket通讯

为了使用方便,在构建的时候,我们更愿意指定一个BaseUrl(详见 设置 BaseUrl):

HTTP http = HTTP.builder()
        .baseUrl("http://api.demo.com")
        .build();
1
2
3

为了简化文档,下文中出现的http均是在构建时设置了BaseUrlHTTP实例。

# 同步请求

使用方法sync(String url)开始一个同步请求:

List<User> users = http.sync("/users") // http://api.demo.com/users
        .get()                         // GET请求
        .getBody()                     // 获取响应报文体
        .toList(User.class);           // 得到目标数据
1
2
3
4

方法sync返回一个同步HttpTask,可链式使用。

# 异步请求

使用方法async(String url)开始一个异步请求:

http.async("/users/1")                //  http://api.demo.com/users/1
        .setOnResponse((HttpResult result) -> {
            // 得到目标数据
            User user = result.getBody().toBean(User.class);
        })
        .get();                       // GET请求
1
2
3
4
5
6

方法async返回一个异步HttpTask,可链式使用。

至此,你已轻松学会了 OkHttps 95% 的常规用法!但别急,后面还有更精彩的。