Kotlin HTTP 请求

在 Kotlin 中，使用 HTTP 请求来访问 REST API 是一种非常常见的任务。本文将介绍 Kotlin 中进行 HTTP 请求所需的工具、库和最佳实践。

使用 OkHttp 进行 HTTP 请求

OkHttp 是一个基于 Java 的 HTTP 客户端，采用简单的 API 和异步请求功能，成为了许多开发者的首选。而在 Kotlin 中，使用 OkHttp 也是非常方便的。

添加 OkHttp 依赖

要使用 OkHttp，首先需要在项目的 build.gradle 文件中添加 OkHttp 的依赖：

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

发起 GET 请求

发起 GET 请求是最基本的 HTTP 请求之一。以下代码片段展示了如何在 Kotlin 中使用 OkHttp 发出简单的 GET 请求：

val client = OkHttpClient()
val url = "https://jsonplaceholder.typicode.com/todos/1"
val request = Request.Builder().url(url).build()

client.newCall(request).enqueue(object : Callback {
    override fun onFailure(call: Call, e: IOException) {
        // 处理请求失败逻辑
    }

    override fun onResponse(call: Call, response: Response) {
        val result = response.body?.string()
        // 处理请求成功逻辑
    }
})

发起 POST 请求

POST 请求可以用于向服务器提交数据。以下代码片段展示了如何在 Kotlin 中使用 OkHttp 发出简单的 POST 请求：

val client = OkHttpClient()
val url = "https://jsonplaceholder.typicode.com/posts"
val requestBody = FormBody.Builder().add("title", "foo").add("body", "bar").build()
val request = Request.Builder().url(url).post(requestBody).build()

client.newCall(request).enqueue(object : Callback {
    override fun onFailure(call: Call, e: IOException) {
        // 处理请求失败逻辑
    }

    override fun onResponse(call: Call, response: Response) {
        val result = response.body?.string()
        // 处理请求成功逻辑
    }
})

使用 Retrofit 进行 HTTP 请求

Retrofit 是一个基于 OkHttp 的 REST 客户端库，提供了强大的 API 和类型安全的 HTTP 请求操作，广受欢迎。以下是如何在 Kotlin 中使用 Retrofit 进行 HTTP 请求的步骤。

添加 Retrofit 依赖

要使用 Retrofit，需要在项目的 build.gradle 文件中添加 Retrofit 的依赖：

dependencies {
    implementation "com.squareup.retrofit2:retrofit:2.9.0"
    implementation "com.squareup.retrofit2:converter-gson:2.9.0"
}

其中，converter-gson 用于将响应体转换为 Gson 对象。

定义 API 接口

在 Kotlin 中使用 Retrofit 时，首先需要定义一个 API 接口，例如：

interface TodoApi {
    @GET("/todos/{id}")
    fun getTodoById(@Path("id") id: Int): Call<Todo>

    @POST("/todos")
    fun createTodo(@Body todo: Todo): Call<Todo>
}

接口中的方法声明与实际的 API 端点一一对应，方法参数和注解表示请求的 HTTP 方法、路径和参数。

创建 Retrofit 实例

创建 Retrofit 实例时，需要传入服务器的基本 URL 和 Gson 转换器：

val retrofit = Retrofit.Builder()
    .baseUrl("https://jsonplaceholder.typicode.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .build()

使用 Retrofit 接口

通过 retrofit.create() 方法创建 API 接口的实现类对象，并调用其中的方法：

val todoApi = retrofit.create(TodoApi::class.java)

val call = todoApi.getTodoById(1)
call.enqueue(object : Callback<Todo> {
    override fun onResponse(call: Call<Todo>, response: Response<Todo>) {
        val todo = response.body()
        // 处理请求成功逻辑
    }

    override fun onFailure(call: Call<Todo>, t: Throwable) {
        // 处理请求失败逻辑
    }
})

结束语

本文介绍了 Kotlin 中使用 OkHttp 和 Retrofit 进行 HTTP 请求的基础知识和最佳实践。希望读者可以根据自己的需求选择合适的工具和方案，轻松实现 HTTP 请求功能。