OkHttp使用篇-01-介绍及基本使用

4,287 阅读6分钟

介绍

OkHttpsquare开源的Java(Kotlin)编写的网络库,是JavaAndroid开发人员使用最广泛的网络库之一。

OkHttp有以下优点

  1. HTTP/2支持同一host的多次请求复用一个socket
  2. 使用连接池减少了请求延迟
  3. 透明的GZIP压缩方式减少了下载流量
  4. 响应缓存避免了重复的请求占用网络资源

OkHttp流行得益于它的良好的架构设计,强大的拦截器(intercepts)使得操纵网络十分方便;也得益于强大的生态,大量的流行库都以OkHttp作为底层网络框架或提供支持,譬如RetrofitGlideFrescoMoshiPicasso等。

版本选择

3.12.x vs 3.13+

关键变更

3.12.x版本支持Android 2.3+(API level 9+)以及Java 7+

低版本的平台缺乏对TLSv1.2的支持。TLSv1TLSv1.1及更低版本有已知的安全隐患,不建议使用。主流的Web浏览器都宣布将于2020年早期放弃对低版本的TLS的支持,只提供对TLSv1.2及更高版本的支持。

因此OkHttp官方宣布对3.12.x版本只提供关键bug修复,而且这种支持将截止到2020年12月31日为止。

3.13+支持Android 5.0+(API level 21+)以及Java 8+TLSv1TLSv1.1默认不再启用。

因此建议升级到3.13+及更高版本(当前2019.11.20最新版本为3.14.4),毕竟更低版本的平台的使用量已经非常少了,而且未来也缺乏支持。

升级

Android中将OkHttp3.12.x升级到3.13+版本,首先确认minSdkVersion至少为21Gradle Plugin版本至少为3.2

增加依赖:

dependencies {  
  implementation "com.squareup.okhttp3:okhttp:3.14.4"  
  ...  
}

设置Java版本为1.8以上:

compileJava {
  sourceCompatibility = JavaVersion.VERSION_1_8
  targetCompatibility = JavaVersion.VERSION_1_8
}

android {
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
  ...  
}

兼容TLSv1TLSv1.1

如果希望能享受最新版本的优化及改进,而服务端还没有提供TLSv1.2及更高版本的支持,可以使用如下方法以开启兼容:

val client = OkHttpClient.Builder()
    .connectionSpecs(Arrays.asList(ConnectionSpec.COMPATIBLE_TLS))
    .build();

3.x vs 4.x

目前市面上用的最多的是3.x系列,相关的文章、博客等大多以这个系列为基础来介绍OkHttp的。

github上面的release记录可以追踪到,3.x系列的第一个正式版本3.0.0从2016年1月正式发布,到目前为止(2019.11.20)最新版本为3.14.4

4.x系列的第一个正式版本4.0.0从2019年6月正式发布,到目前为止(2019.11.20)最新版本为4.2.2,算是比较新了。

关键变更

4.x系列相对于3.x系列,最大的变更是将实现语言从Java变更到了KotlinKotlin相对于Java来说有很多优点,具体这里就不展开了。

OkHttp团队在实现4.x版本的时候,从以下三方面去努力保持和3.x版本的兼容性:

  1. 二进制兼容性:使用OkHttp 3.x编译的程序使用OkHttp 4.x来运行的能力
  2. Java 源码兼容性:使用OkHttp 3.x编写的Java代码升级到OkHttp 4.x而不用修改Java代码的能力
  3. Kotlin 源码兼容性:使用OkHttp 3.x编译的Kotlin程序使用OkHttp 4.x而不用修改Kotlin代码的能力

OkHttp对前两种兼容性,除了细微的变更,都实现了兼容;而对第三种却没有实现兼容,但是通过Kotlin语言强大的deprecation特性能很容易的实现升级。

不兼容的变更

  1. OkHttpClient中的final方法
    OkHttpClient中的26个访问器方法从3.x中的非final变更为final。如果测试框架需要mock,可以使用Call.Factory
  2. 内部API变更
    okhttp3.internal包下的内容用于内部实现,会频繁发生变更,并不建议直接使用。官方也会保持一定的向后兼容性,但后续仍然有变更的可能。
  3. Credentials.basic()
    3.xbasic方法的参数usernamepassword如果为null,则会转成字符串"null",而4.x中这两个参数为非空字符串。
  4. HttpUrl.queryParameterValues()
    HttpUrl.queryParameterValues()方法的返回类型为List<String?>

新增的@Deprecated方法

4.x版本中为了向后兼容便于迁移,很多方法仍然保留了下来,但是增加了@Deprecated标记,这是因为Kotlin语言提供了更加便利的方法。这些方法未来会被移除。

譬如3.xOkHttpClient中有方法:

public Authenticator authenticator() {
    return authenticator;
}

4.x中有同样的方法:

@JvmName("-deprecated_authenticator")
@Deprecated(
  message = "moved to val",
  replaceWith = ReplaceWith(expression = "authenticator"),
  level = DeprecationLevel.ERROR)
fun authenticator(): Authenticator = authenticator

方法标记为@Deprecated,建议直接使用val变量。这些方法可以使用Intellij IDEAAndroid Studio提供的Code Cleanup工具自动替换为建议的方法,工具路径为菜单项:Analyze -> Code Cleanup

扩展函数

4.x中将很多静态函数变更为扩展函数,充分利用了Kotlin语言的特性。譬如Handshake.get(SSLSession)变更为SSLSession.handshake()等,可以查看源代码或者看官方文档

SAM转换

接口中如果只定义了一个抽象方法,这个方法就叫做单抽象方法(Single Abstract Method, SAM)

譬如,Runnable接口的run方法就是最常见的SAM

package java.lang;
public interface Runnable {

    public abstract void run();
}

Kotlin中调用Java接口中定义的SAM时,可以像使用lambda方法一样。但是同样的使用方式却不适用于Kotlin中定义的SAM

Kotlin调用OkHttp 3.x:

val client = OkHttpClient.Builder()
    .dns { hostname -> InetAddress.getAllByName(hostname).toList() }
    .build()

OkHttp升级到4.x后,在Kotlin中调用就需要修改为:

val client = OkHttpClient.Builder()
    .dns(object : Dns {
      override fun lookup(hostname: String) =
          InetAddress.getAllByName(hostname).toList()
    })
    .build()

OkHttp中还有很多地方会遇到这个问题,Jetbrain官方正在努力实现Kotlin接口的SAM转换,不过目前的版本还不支持。

Companion的导入

Java的静态方法在Kotlin中的等效实现就是Companion对象方法,它们的字节码是一样的,但是导入的时候写法有区别。

譬如OkHttp 3.x中有:

import okhttp3.CipherSuite.forJavaName

那么升级到OkHttp 4.x中,就要修改为:

import okhttp3.CipherSuite.Companion.forJavaName

使用

GET请求

同步请求

示例如下,这个是官方的示例代码的Kotlin版:

val client = OkHttpClient()

fun run(url: String): String? {
    val request: Request = Request.Builder()
        .url(url)
        .build()
    client.newCall(request).execute().use { response -> return response.body?.string() }
}

发送同步GET请求很简单:

  1. 创建OkHttpClient实例client
  2. 通过Request.Builder构建一个Request请求实例request
  3. 通过client.newCall(request)创建一个Call的实例
  4. Call的实例调用execute方法发送同步请求
  5. 请求返回的response转换为String类型返回

异步请求

val client = OkHttpClient()

fun run(url: String) {
    val request: Request = Request.Builder()
        .url(url)
        .build()
    client.newCall(request).enqueue(object : Callback {
        override fun onResponse(call: Call, response: Response) {
            println("onResponse: ${response.body.toString()}")
        }

        override fun onFailure(call: Call, e: IOException) {
            println("onFailure: ${e.message}")
        }
    })
}

步骤和同步请求类似,只是调用了Callenqueue方法异步请求,结果通过回调CallbackonResponse方法及onFailure方法处理。

POST请求

同步请求

下面也是官方示例的Kotlin版:

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody

val JSON: MediaType = "application/json; charset=utf-8".toMediaType()
val client = OkHttpClient()

fun post(url: String, json: String): String? {
    val body: RequestBody = json.toRequestBody(JSON)
    val request: Request = Request.Builder()
        .url(url)
        .post(body)
        .build()
    client.newCall(request).execute().use { response -> return response.body?.string() }
}

GET同步请求类似,只是创建Request时通过Request.Builder.post()方法设置请求类型为POST请求并设置了请求体。

异步请求

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody

val JSON: MediaType = "application/json; charset=utf-8".toMediaType()
val client = OkHttpClient()

fun post(url: String, json: String) {
    val body: RequestBody = json.toRequestBody(JSON)
    val request: Request = Request.Builder()
        .url(url)
        .post(body)
        .build()
    client.newCall(request).enqueue(object : Callback {
        override fun onResponse(call: Call, response: Response) {
            println("onResponse: ${response.body.toString()}")
        }

        override fun onFailure(call: Call, e: IOException) {
            println("onFailure: ${e.message}")
        }
    })
}

GET异步请求类似,同样是创建Request时通过Request.Builder.post()方法设置请求类型为POST请求并设置了请求体。

更多

TODO

参考

OkHttp

Upgrading to OkHttp 4

OkHttp 3.13.0 changlog

OkHttp 3.13 Requires Android 5+

OkHttp 4 Goes Kotlin