retrofit如何发送json

Retrofit发送全攻略：轻松实现JSON数据交互**

在Android开发中,网络请求是不可或缺的一环，Retrofit作为当前最流行的网络请求库之一，以其简洁的API、强大的扩展性和对OkHttp的深度集成，深受开发者喜爱，在实际开发中，我们经常需要将JSON数据作为请求体发送到服务器，本文将详细介绍如何使用Retrofit发送JSON数据，涵盖GET、POST、PUT等多种请求方式，并辅以代码示例，助你轻松。

准备工作：添加依赖与配置

在使用Retrofit之前,确保你的项目中已经添加了必要的依赖，主要包括Retrofit本身、OkHttp（Retrofit依赖它）、以及用于JSON解析的Gson（Retrofit内置Gson支持，也可使用其他如Moshi、Jackson）。

在build.gradle (Module: app)文件中添加：

implementation 'com.squareup.retrofit2:retrofit:2.9.0' // Retrofit核心库
implementation 'com.squareup.retrofit2:converter-gson:2.9.0' // Gson转换器
implementation 'com.squareup.okhttp3:logging-interceptor:4.9.3' // 可选，用于打印日志

定义数据模型类

发送JSON数据通常对应一个Java或Kotlin数据类,Retrofit会使用这个数据类来序列化成JSON字符串，或者反序列化JSON字符串为对象。

我们要发送一个用户注册的信息：

User.kt (Kotlin)

data class User(
    val username: String,
    val password: String,
    val email: String
)

User.java (Java)

public class User {
    private String username;
    private String password;
    private String email;
    // 构造方法、getters和setters
    public User(String username, String password, String email) {
        this.username = username;
        this.password = password;
        this.email = email;
    }
    public String getUsername() { return username; }
    public void setUsername(String username) { this.username = username; }
    public String getPassword() { return password; }
    public void setPassword(String password) { this.password = password; }
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
}

创建Retrofit实例并配置

我们需要创建一个Retrofit实例,并配置基础URL以及JSON转换器。

val retrofit = Retrofit.Builder()
    .baseUrl("https://your-api-base-url.com/") // 替换为你的API基础URL
    .addConverterFactory(GsonConverterFactory.create()) // 添加Gson转换器
    .build()

定义API接口

使用Retrofit时,我们需要定义一个接口来描述所有的网络请求，对于发送JSON数据，主要涉及到@Body注解。

POST请求发送JSON

@Body注解用于标记一个对象作为请求体，Retrofit会将其序列化为JSON并发送。

ApiService.kt

interface ApiService {
    @POST("api/register") // 相对路径，会与baseUrl拼接
    suspend fun registerUser(@Body user: User): Response<User> // 或者 suspend fun registerUser(@Body user: User): retrofit2.Response<User>
}

说明：

@POST("api/register")：指定请求方式为POST，相对路径为api/register。
@Body user: User：表示将User对象作为请求体，Retrofit会使用Gson将其转换为JSON。
suspend fun：在Kotlin协程环境中，推荐使用suspend函数定义接口方法。
Response<User>：返回类型，表示我们可以获取到原始的响应信息，包括状态码、响应头和响应体。

PUT请求发送JSON

PUT请求与POST类似,同样使用@Body注解来发送JSON数据，通常用于更新资源。

@PUT("api/users/{userId}")
suspend fun updateUser(@Path("userId") userId: String, @Body user: User): Response<User>

GET请求发送JSON（不常见，但可讨论）

GET请求的参数是通过查询参数（Query Parameters）或路径参数（Path Parameters）传递的，而不是请求体，因为GET请求的请求体在HTTP规范中并未被广泛支持，且大多数服务器会忽略GET请求的请求体。

如果确实需要通过GET请求发送JSON数据（某些特定API要求），可能需要手动将JSON序列化为字符串，然后作为查询参数传递，但这并不推荐。

不推荐的GET发送JSON方式（示例）：

// 假设User有一个方法可以转换为JSON字符串
@GET("api/users/search")
fun searchUsers(@Query("filter") jsonFilter: String): Response<List<User>>

使用时：

val userFilter = User("john_doe", "", "") // 只填充需要搜索的字段
val jsonFilter = Gson().toJson(userFilter)
apiService.searchUsers(jsonFilter)

调用API发送JSON数据

定义好API接口后,我们就可以创建接口的实现类（通过Retrofit的create方法），并调用相应的方法发送请求。

// 1. 创建Retrofit实例
val retrofit = Retrofit.Builder()
    .baseUrl("https://your-api-base-url.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .build()
// 2. 创建API服务实例
val apiService = retrofit.create(ApiService::class.java)
// 3. 准备请求数据
val userToRegister = User("testuser", "password123", "test@example.com")
// 4. 发起请求（在协程作用域内）
try {
    val response = apiService.registerUser(userToRegister)
    if (response.isSuccessful) {
        // 请求成功，处理响应体
        val registeredUser = response.body()
        Log.d("Retrofit", "注册成功: $registeredUser")
    } else {
        // 请求失败，处理错误响应
        Log.e("Retrofit", "注册失败: ${response.code()} ${response.message()}")
    }
} catch (e: Exception) {
    Log.e("Retrofit", "网络请求异常", e)
}

发送JSON数组和复杂JSON对象

如果需要发送JSON数组或嵌套的复杂JSON对象,只需确保你的数据模型类定义正确即可。

示例：发送用户列表（JSON数组）

// 数据模型
data class UsersList(val users: List<User>)
// API接口
@POST("api/batchRegister")
suspend fun batchRegister(@Body usersList: UsersList): Response<String>
// 调用
val usersList = UsersList(listOf(
    User("user1", "pass1", "user1@example.com"),
    User("user2", "pass2", "user2@example.com")
))
apiService.batchRegister(usersList)

Retrofit会自动将UsersList对象序列化为包含users数组的JSON对象。

自定义JSON请求体（如直接发送字符串）

有时,你可能已经有了JSON字符串，或者需要更灵活地控制请求体的格式，这时，可以使用@Body注解配合RequestBody。

import okhttp3.RequestBody
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.MediaType.Companion.toMediaTypeOrNull
interface ApiService {
    @POST("api/customJson")
    fun sendCustomJson(@Body body: RequestBody): Response<String>
}
// 调用
val jsonPayload = "{\"key\":\"value\", \"number\":123}"
val mediaType = "application/json; charset=utf-8".toMediaTypeOrNull()
val requestBody = RequestBody.create(mediaType, jsonPayload)
apiService.sendCustomJson(requestBody)

通过以上步骤,我们了在Retrofit中发送JSON数据的核心方法：