Kotlin 与 Android 网络请求

一、网络请求的基本概念

网络请求本质上是客户端 (Android 应用) 向服务器发送请求，并接收服务器响应的过程。这个过程涉及以下步骤：

• 创建请求: 指定请求方法 (GET, POST, PUT, DELETE 等)、URL 地址、请求头和请求体。
• 发送请求: 将请求发送到服务器。
• 接收响应: 接收服务器返回的数据，包括响应头和响应体。
• 处理响应: 解析响应数据并根据业务逻辑进行处理。

二、OkHttp 网络请求库

OkHttp 是一个高效的 HTTP 客户端库，它提供了丰富的 API 用于创建、发送和接收 HTTP 请求。以下是 OkHttp 的主要特点：

• 支持同步和异步请求: 可根据需求选择合适的请求方式。
• 自动处理连接池和缓存: 提升请求效率和节省流量。
• 拦截器机制: 可以自定义拦截器，方便进行请求和响应的处理。
• 支持 HTTPS: 提供安全可靠的网络连接。

2.1 OkHttp 的基本使用

import okhttp3.*
import java.io.IOException

fun main() {
    // 创建 OkHttpClient 实例
    val client = OkHttpClient()

    // 创建请求对象
    val request = Request.Builder()
        .url("https://www.example.com/api/data") // 请求 URL
        .build()

    // 发送请求并接收响应
    client.newCall(request).enqueue(object : Callback {
        override fun onFailure(call: Call, e: IOException) {
            println("请求失败: ${e.message}")
        }

        override fun onResponse(call: Call, response: Response) {
            if (response.isSuccessful) {
                val body = response.body?.string()
                println("请求成功: $body")
            } else {
                println("请求失败: ${response.code}")
            }
        }
    })
}

2.2 使用 OkHttp 拦截器

import okhttp3.*
import java.io.IOException

class MyInterceptor : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response {
        val request = chain.request()
        val newRequest = request.newBuilder()
            .addHeader("Authorization", "Bearer your_token") // 添加请求头
            .build()
        return chain.proceed(newRequest)
    }
}

fun main() {
    // 创建 OkHttpClient 实例
    val client = OkHttpClient.Builder()
        .addInterceptor(MyInterceptor()) // 添加拦截器
        .build()

    // ... 发送请求 ...
}

三、Retrofit 网络请求框架

Retrofit 是一个基于 OkHttp 的网络请求框架，它可以帮助开发者更便捷地进行网络请求操作。Retrofit 提供了以下优势：

• 代码简洁易读: 使用注解来定义请求接口，简化代码结构。
• 自动解析 JSON 数据: 提供方便的接口将 JSON 数据解析为 Java 对象。
• 支持各种请求方式: 支持 GET, POST, PUT, DELETE 等常见请求方法。
• 支持多种数据格式: 支持 JSON、XML 等数据格式。

3.1 Retrofit 的基本使用

import retrofit2.Call
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory
import retrofit2.http.GET

interface ApiService {
    @GET("/api/data")
    fun getData(): Call<DataResponse> // 定义请求接口
}

fun main() {
    // 创建 Retrofit 实例
    val retrofit = Retrofit.Builder()
        .baseUrl("https://www.example.com")
        .addConverterFactory(GsonConverterFactory.create())
        .build()

    // 创建 ApiService 接口对象
    val apiService = retrofit.create(ApiService::class.java)

    // 发送请求并接收响应
    val call = apiService.getData()
    call.enqueue(object : Callback<DataResponse> {
        override fun onFailure(call: Call<DataResponse>, t: Throwable) {
            println("请求失败: ${t.message}")
        }

        override fun onResponse(call: Call<DataResponse>, response: Response<DataResponse>) {
            if (response.isSuccessful) {
                val data = response.body()
                println("请求成功: ${data?.name}")
            } else {
                println("请求失败: ${response.code}")
            }
        }
    })
}

3.2 使用 Retrofit 拦截器

import okhttp3.OkHttpClient
import okhttp3.logging.HttpLoggingInterceptor
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory

fun main() {
    // 创建 OkHttp 实例
    val okHttpClient = OkHttpClient.Builder()
        .addInterceptor(HttpLoggingInterceptor().apply {
            level = HttpLoggingInterceptor.Level.BODY
        }) // 添加日志拦截器
        .build()

    // 创建 Retrofit 实例
    val retrofit = Retrofit.Builder()
        .baseUrl("https://www.example.com")
        .addConverterFactory(GsonConverterFactory.create())
        .client(okHttpClient) // 使用自定义的 OkHttp 实例
        .build()

    // ... 发送请求 ...
}

四、完整示例代码

import okhttp3.OkHttpClient
import okhttp3.logging.HttpLoggingInterceptor
import retrofit2.Call
import retrofit2.Response
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory
import retrofit2.http.GET
import java.io.IOException

// 数据模型
data class DataResponse(
    val name: String
)

// 定义请求接口
interface ApiService {
    @GET("/api/data")
    fun getData(): Call<DataResponse>
}

// 拦截器
class MyInterceptor : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response {
        val request = chain.request()
        val newRequest = request.newBuilder()
            .addHeader("Authorization", "Bearer your_token")
            .build()
        return chain.proceed(newRequest)
    }
}

fun main() {
    // 创建 OkHttp 实例
    val okHttpClient = OkHttpClient.Builder()
        .addInterceptor(HttpLoggingInterceptor().apply {
            level = HttpLoggingInterceptor.Level.BODY
        })
        .addInterceptor(MyInterceptor())
        .build()

    // 创建 Retrofit 实例
    val retrofit = Retrofit.Builder()
        .baseUrl("https://www.example.com")
        .addConverterFactory(GsonConverterFactory.create())
        .client(okHttpClient)
        .build()

    // 创建 ApiService 接口对象
    val apiService = retrofit.create(ApiService::class.java)

    // 发送请求并接收响应
    val call = apiService.getData()
    call.enqueue(object : Callback<DataResponse> {
        override fun onFailure(call: Call<DataResponse>, t: Throwable) {
            println("请求失败: ${t.message}")
        }

        override fun onResponse(call: Call<DataResponse>, response: Response<DataResponse>) {
            if (response.isSuccessful) {
                val data = response.body()
                println("请求成功: ${data?.name}")
            } else {
                println("请求失败: ${response.code}")
            }
        }
    })
}

说明:

• retrofit2.Call 代表一个网络请求，可以使用 enqueue 方法异步执行请求。
• retrofit2.Response 代表服务器返回的响应数据。
• GsonConverterFactory 是 Gson 库的转换器，用于将 JSON 数据解析为 Java 对象。
• HttpLoggingInterceptor 是 OkHttp 的日志拦截器，可以打印请求和响应日志，方便调试。
• MyInterceptor 是自定义的拦截器，用于添加请求头等操作。

总结

本文介绍了 Kotlin 与 Android 网络请求的入门知识，并演示了 OkHttp 和 Retrofit 的基本使用。通过使用这些网络请求库，开发者可以更加方便快捷地实现 Android 应用的网络功能。