在Android开发中，网络请求是我们经常会遇到的需求之一。OkHttp和Retrofit是两个非常常用的网络请求库，它们提供了很多高级用法来帮助我们更方便、更灵活地进行网络请求。
OkHttp高级用法
OkHttp是一个非常强大和灵活的网络请求库，它提供了很多高级用法来满足不同的需求。
自定义拦截器
拦截器是OkHttp的一个核心概念，它允许我们在网络请求的各个阶段进行干预和修改。通过自定义拦截器，我们可以实现很多功能，比如添加公共参数、修改请求头、记录日志等。
以下是一个自定义拦截器的示例代码：
class CustomInterceptor : Interceptor {
override fun intercept(chain: Interceptor.Chain): Response {
val request = chain.request()
// 在请求之前做一些处理
// ...
val response = chain.proceed(request)
// 在响应之后做一些处理
// ...
return response
}
}
我们可以通过addInterceptor()方法将拦截器添加到OkHttp客户端中：
val client = OkHttpClient.Builder()
.addInterceptor(CustomInterceptor())
.build()
取消请求
有时候我们可能需要取消一个正在进行的网络请求，比如用户在某个页面上进行输入时，需要实时联想数据来进行自动补全，但是用户可能会频繁地输入，如果前一个请求还没有返回，我们就需要取消掉它，以免造成资源浪费。
OkHttp提供了cancel()方法来取消一个正在进行的请求：
val call = client.newCall(request)
call.enqueue(object : Callback {
override fun onFailure(call: Call, e: IOException) {
// 请求失败处理
}
override fun onResponse(call: Call, response: Response) {
// 请求成功处理
}
})
// 取消请求
call.cancel()
文件上传和下载
OkHttp可以很方便地实现文件上传和下载功能。对于文件上传，我们可以使用MultipartBody来构建多部分请求体，并通过addFormDataPart()方法添加文件参数。
val requestBody = MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("file", "image.jpg", RequestBody.create(MediaType.parse("image/jpeg"), file))
.build()
val request = Request.Builder()
.url("http://www.example.com/upload")
.post(requestBody)
.build()
对于文件下载，我们只需要将返回的响应体保存到文件：
val call = client.newCall(request)
val response = call.execute()
val inputStream = response.body()?.byteStream()
val fileOutputStream = FileOutputStream(file)
val buffer = ByteArray(4096)
var bytesRead = 0
while (inputStream?.read(buffer).also { bytesRead = it!! } != -1) {
fileOutputStream.write(buffer, 0, bytesRead)
}
fileOutputStream.close()
inputStream?.close()
Retrofit高级用法
Retrofit是一个基于OkHttp的RESTful网络请求库，它提供了高度封装的接口来帮助我们更快速地进行网络请求。
自定义Converter
Retrofit提供了默认的JsonConverter来进行请求和响应的JSON序列化和反序列化，但是有时候我们可能会遇到其他格式的数据，比如XML或者Protocol Buffers。这时，我们可以自定义Converter来处理这些格式。
以下是一个自定义XML转换器的示例代码：
class XmlConverterFactory : Converter.Factory() {
override fun responseBodyConverter(
type: Type,
annotations: Array<out Annotation>,
retrofit: Retrofit
): Converter<ResponseBody, *>? {
if (type == String::class.java) {
return Converter<ResponseBody, String> { value -> value.string() }
}
return null
}
override fun requestBodyConverter(
type: Type,
parameterAnnotations: Array<out Annotation>,
methodAnnotations: Array<out Annotation>,
retrofit: Retrofit
): Converter<*, RequestBody>? {
if (type == String::class.java) {
return Converter<String, RequestBody> { value ->
RequestBody.create(MediaType.parse("application/xml"), value)
}
}
return null
}
}
我们可以通过addConverterFactory()方法将自定义Converter添加到Retrofit中：
val retrofit = Retrofit.Builder()
.baseUrl("http://www.example.com/")
.client(client)
.addConverterFactory(XmlConverterFactory())
.build()
自定义CallAdapter
Retrofit的默认CallAdapter是Call，它返回的是一个Call<T>对象，我们需要手动调用enqueue()或者execute()来执行网络请求。有时候我们可能希望使用其他类型的CallAdapter，比如Deferred或者LiveData，以更方便地处理网络请求的结果。
以下是一个自定义Deferred CallAdapter的示例代码：
class DeferredCallAdapterFactory : CallAdapter.Factory() {
override fun get(
returnType: Type,
annotations: Array<out Annotation>,
retrofit: Retrofit
): CallAdapter<*, *>? {
if (Deferred::class.java != getRawType(returnType)) {
return null
}
if (returnType !is ParameterizedType) {
throw IllegalStateException("Deferred return type must be parameterized as Deferred<Foo> or Deferred<out Foo>")
}
val responseType = getParameterUpperBound(0, returnType)
return DeferredCallAdapter<Any>(responseType)
}
}
class DeferredCallAdapter<T>(private val responseType: Type) : CallAdapter<T, Deferred<T>> {
override fun responseType() = responseType
override fun adapt(call: Call<T>): Deferred<T> {
val deferred = CompletableDeferred<T>()
deferred.invokeOnCompletion {
if (deferred.isCancelled) {
call.cancel()
}
}
call.enqueue(object : Callback<T> {
override fun onFailure(call: Call<T>, t: Throwable) {
deferred.completeExceptionally(t)
}
override fun onResponse(call: Call<T>, response: Response<T>) {
if (response.isSuccessful) {
deferred.complete(response.body())
} else {
deferred.completeExceptionally(HttpException(response))
}
}
})
return deferred
}
}
我们可以通过addCallAdapterFactory()方法将自定义CallAdapter添加到Retrofit中：
val retrofit = Retrofit.Builder()
.baseUrl("http://www.example.com/")
.client(client)
.addCallAdapterFactory(DeferredCallAdapterFactory())
.build()
总结
OkHttp和Retrofit是Android开发中非常常用和强大的网络请求库，它们提供了很多高级用法来满足我们的需求。通过自定义拦截器、取消请求、文件上传和下载等高级用法，我们可以更加灵活和方便地进行网络请求。同时，通过自定义Converter和CallAdapter，我们可以处理不同格式的数据和更方便地处理网络请求的结果。
希望通过这篇文章的介绍，能够帮助大家更好地理解和使用OkHttp和Retrofit的高级用法。
本文来自极简博客，作者：雨中漫步，转载请注明原文链接：Kotlin中的OkHttp和Retrofit的高级用法探索
