retrofit怎么发送json数据

Retrofit发送JSON数据：从基础到实践的完整指南

在Android开发中,Retrofit作为一款类型安全的HTTP客户端，因其简洁易用和强大的功能而广受欢迎，发送JSON数据是网络请求中非常常见的场景，本文将详细介绍如何使用Retrofit发送JSON数据，包括基础配置、请求体构建、错误处理以及高级技巧。

Retrofit基础配置

要使用Retrofit发送JSON数据,首先需要进行基础配置，主要包括添加依赖、定义接口和创建Retrofit实例。

添加依赖

在app模块的build.gradle文件中添加Retrofit和Gson的依赖：

implementation 'com.squareup.retrofit2:retrofit:2.9.0'
implementation 'com.squareup.retrofit2:converter-gson:2.9.0'

定义API接口

创建一个接口,使用@POST或@PUT等注解定义端点，并通过@Body注解标记请求体：

public interface ApiService {
    @POST("api/user")
    Call<User> createUser(@Body User user);
    @PUT("api/user/{id}")
    Call<User> updateUser(@Path("id") int userId, @Body User user);
}

创建Retrofit实例

配置Retrofit实例,指定基础URL和JSON转换器：

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.example.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .build();

构建JSON请求体

使用Java对象作为请求体

最常用的方式是将Java对象自动转换为JSON,首先创建一个与JSON结构对应的Java类：

public class User {
    private String name;
    private String email;
    private int age;
    // 构造方法、getter和setter
}

然后在接口方法中使用@Body注解：

@POST("api/user")
Call<User> createUser(@Body User user);

调用时直接传入User对象：

User user = new User("John Doe", "john@example.com", 30);
Call<User> call = apiService.createUser(user);

使用Map作为请求体

如果需要动态构建JSON,可以使用Map：

@POST("api/user")
Call<User> createUser(@Body Map<String, Object> userMap);

调用方式：

Map<String, Object> userMap = new HashMap<>();
userMap.put("name", "Jane Doe");
userMap.put("email", "jane@example.com");
userMap.put("age", 25);
Call<User> call = apiService.createUser(userMap);

使用JSON字符串作为请求体

如果已经有JSON字符串,可以使用@Body直接传递：

@POST("api/user")
Call<User> createUser(@Body String jsonBody);

调用方式：

String jsonBody = "{\"name\":\"Bob\",\"email\":\"bob@example.com\",\"age\":40}";
Call<User> call = apiService.createUser(jsonBody);

发送请求并处理响应

同步请求

try {
    Response<User> response = call.execute();
    if (response.isSuccessful()) {
        User user = response.body();
        // 处理成功响应
    } else {
        // 处理错误响应
    }
} catch (IOException e) {
    e.printStackTrace();
}

异步请求

call.enqueue(new Callback<User>() {
    @Override
    public void onResponse(Call<User> call, Response<User> response) {
        if (response.isSuccessful()) {
            User user = response.body();
            // 处理成功响应
        } else {
            // 处理错误响应
        }
    }
    @Override
    public void onFailure(Call<User> call, Throwable t) {
        // 处理请求失败
    }
});

高级配置与技巧

自定义JSON转换器

如果需要自定义JSON处理,可以实现自己的Converter：

public class CustomGsonConverter extends Converter.Factory {
    // 实现自定义转换逻辑
}

然后在Retrofit配置中使用：

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.example.com/")
    .addConverterFactory(new CustomGsonConverter())
    .build();

添加请求头

可以在接口方法或请求体上添加请求头：

@Headers("Content-Type: application/json")
@POST("api/user")
Call<User> createUser(@Body User user);
// 或者在方法参数上添加
@POST("api/user")
Call<User> createUser(@Header("Authorization") String token, @Body User user);

处理复杂JSON结构

对于复杂的JSON结构,可以使用嵌套对象和集合：

public class Order {
    private String orderId;
    private List<Product> products;
    private Address shippingAddress;
    // getters and setters
}
public class Product {
    private String productId;
    private String name;
    private int quantity;
    private double price;
    // getters and setters
}
public class Address {
    private String street;
    private String city;
    private String zipCode;
    // getters and setters
}

使用RxJava或Coroutines

Retrofit支持与RxJava和Kotlin Coroutines集成：

// RxJava
@POST("api/user")
Observable<User> createUser(@Body User user);
// Coroutines
@POST("api/user")
suspend fun createUser(@Body user: User): Response<User>

错误处理

检查HTTP状态码

if (response.code() == 400) {
    // 处理400错误
} else if (response.code() == 401) {
    // 处理401错误
}

解析错误响应

try {
    ErrorResponse errorResponse = Gson().fromJson(response.errorBody()?.charStream(), ErrorResponse::class.java)
} catch (e: Exception) {
    e.printStackTrace()
}

最佳实践

保持接口简洁：每个接口方法只负责一个特定的API端点
使用数据类：为所有JSON结构创建对应的数据类
统一错误处理：实现统一的错误处理机制
添加日志：使用HttpLoggingInterceptor记录请求和响应
异步请求：尽量使用异步请求避免阻塞主线程

Retrofit发送JSON数据是Android开发中的基础技能,通过合理配置Retrofit、定义合适的接口方法、构建正确的请求体，并结合适当的错误处理机制，可以高效地实现与服务器的JSON数据交互，这些技巧将大大提升开发效率和代码质量。

正文