本文详细介绍了如何在 Android 应用中使用 Retrofit 2.x 框架向服务器发送包含 HTML 标签的 JSON 字符串数据。我们将通过构建数据模型、定义 API 接口以及进行网络请求的完整示例，演示如何将 HTML 内容作为普通字符串嵌入 JSON 请求体中，并强调了 Retrofit 自动处理编码的机制，以及服务器端处理此类数据时需要注意的安全事项。
在 Android 应用开发中，我们经常需要通过网络请求向服务器发送结构化数据。有时，这些数据中会包含富文本内容，例如带有 HTML 标签的字符串。使用 Retrofit 2.x 框架发送此类数据时，关键在于正确地构建请求体，并理解 JSON 序列化器（如 Gson）如何处理字符串。
理解包含 HTML 的 JSON 请求载荷
目标请求载荷通常是一个 JSON 对象，其中某个字段的值是一个包含 HTML 标签的字符串。例如：
{
"text": "<p>这是一段包含<b>粗体</b>和<i>斜体</i>文字的HTML内容。</p>",
"users": ["user_id_1", "user_id_2"]
}在这个例子中，text 字段的值是一个完整的 HTML 字符串。对于 Retrofit 而言，它仅仅是一个普通的 Java/Kotlin 字符串，JSON 转换器会负责将其正确地序列化到 JSON 格式中。
立即学习“前端免费学习笔记（深入）”；
Retrofit 2.x 实现方案
为了在 Retrofit 2.x 中发送此类数据，我们需要遵循以下步骤：
1. 定义数据模型 (POJO)
首先，创建一个 Java 或 Kotlin 数据类（POJO）来精确映射请求的 JSON 结构。这个类应该包含所有字段，其中包含 HTML 的字段类型应为 String。
Java 示例：
import com.google.gson.annotations.SerializedName;
import java.util.List;
public class PostRequestPayload {
@SerializedName("text")
private String textContent;
@SerializedName("users")
private List<String> userIds;
public PostRequestPayload(String textContent, List<String> userIds) {
this.textContent = textContent;
this.userIds = userIds;
}
// Getters and Setters (可选，Gson可以直接通过构造函数或字段访问)
public String getTextContent() {
return textContent;
}
public void setTextContent(String textContent) {
this.textContent = textContent;
}
public List<String> getUserIds() {
return userIds;
}
public void setUserIds(List<String> userIds) {
this.userIds = userIds;
}
}Kotlin 示例：
import com.google.gson.annotations.SerializedName
data class PostRequestPayload(
@SerializedName("text")
val textContent: String,
@SerializedName("users")
val userIds: List<String>
)2. 构建 Retrofit API 接口
接下来，定义一个 Retrofit 接口，使用 @POST 注解指定 HTTP 方法和路径，并使用 @Body 注解将我们定义的数据模型作为请求体发送。
import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.POST;
public interface MyApiService {
@POST("post_html_content") // 替换为你的实际API路径
Call<ApiResponse> postHtmlContent(@Body PostRequestPayload payload);
}这里的 ApiResponse 是一个用于接收服务器响应的数据模型，你需要根据实际情况定义它。如果服务器只返回状态码或简单消息，可以定义一个简单的响应类。
3. 发起网络请求
最后，你需要配置 Retrofit 实例，并使用上面定义的接口来发起网络请求。确保你已经添加了 Gson 转换器工厂，以便 Retrofit 能够将 POJO 转换为 JSON。
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import java.util.Arrays;
import java.util.List;
public class ApiClient {
private static final String BASE_URL = "https://your.api.com/"; // 替换为你的API基础URL
private MyApiService apiService;
public ApiClient() {
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create()) // 使用Gson作为JSON转换器
.build();
apiService = retrofit.create(MyApiService.class);
}
public void sendHtmlData() {
// 准备包含HTML的字符串
String htmlContent = "<p>ffsdsdf <span class=\"mention\" data-index=\"0\" data-denotation-char=\"@\" data-id=\"12fe9af4-e2d6-47cb-9601-64c7a1fe9c4a\" data-value=\"Vendor 3 company Vendor\"><span contenteditable=\"false\"><span class=\"ql-mention-denotation-char\">@</span>Vendor 3 company Vendor</span></span> </p>";
List<String> userIds = Arrays.asList("12fe9af4-e2d6-47cb-9601-64c7a1fe9c4a");
PostRequestPayload payload = new PostRequestPayload(htmlContent, userIds);
Call<ApiResponse> call = apiService.postHtmlContent(payload);
call.enqueue(new Callback<ApiResponse>() {
@Override
public void onResponse(Call<ApiResponse> call, Response<ApiResponse> response) {
if (response.isSuccessful()) {
System.out.println("数据发送成功！响应: " + response.body());
// 处理成功响应
} else {
System.err.println("数据发送失败！错误码: " + response.code());
// 处理错误响应
}
}
@Override
public void onFailure(Call<ApiResponse> call, Throwable t) {
System.err.println("网络请求失败！错误: " + t.getMessage());
// 处理网络错误
}
});
}
// 假设的ApiResponse类
static class ApiResponse {
// 根据服务器响应定义字段
String status;
String message;
@Override
public String toString() {
return "ApiResponse{" +
"status='" + status + '\'' +
", message='" + message + '\'' +
'}';
}
}
public static void main(String[] args) {
ApiClient client = new ApiClient();
client.sendHtmlData();
}
}关键注意事项
JSON 序列化器处理： 当你将一个包含 HTML 标签的 Java/Kotlin 字符串放入 POJO 中，并使用 Retrofit 发送时，Gson (或其他 JSON 转换器) 会自动将其作为 JSON 字符串的一部分进行序列化。这意味着 HTML 字符串中的特殊字符（如双引号 "、反斜杠 \ 等）会被自动转义，以确保生成的 JSON 是有效的。你无需手动对 HTML 字符串进行 URL 编码或 JSON 转义。
Content-Type： 当使用 @Body 注解发送 POJO 时，Retrofit 配合 Gson 转换器会自动设置请求的 Content-Type 为 application/json。服务器端应配置为接受并解析此类型的请求。
Retrofit 版本： 上述方法适用于 Retrofit 2.x 版本。早期的 Retrofit 1.x 可能使用 TypedString 或其他不同的机制，但已不再推荐使用。
-
服务器端 HTML 处理与安全 (XSS)：
- 解析： 服务器端接收到 JSON 后，需要解析 JSON 对象，然后从相应的字段中提取 HTML 字符串。
- 安全： 这一点至关重要。 如果你允许用户输入 HTML 内容并在客户端生成后发送，那么服务器端在将这些 HTML 存储到数据库或在其他用户的浏览器中渲染之前，必须对其进行严格的净化 (sanitization)。这是为了防止跨站脚本 (XSS) 攻击。恶意用户可能会注入 <script> 标签或其他恶意 HTML/JavaScript 代码，从而危害其他用户。应使用专业的 HTML 净化库（例如 Java 中的 OWASP ESAPI 或 Jsoup）来移除潜在的危险标签和属性。
动态 HTML 生成： 如果你的 HTML 内容是根据用户选择或其他动态数据生成的，你需要在客户端（Android 应用）中根据业务逻辑构建完整的 HTML 字符串，然后将其赋值给 PostRequestPayload 对象的 textContent 字段。
总结
在 Android Retrofit 2.x 中发送包含 HTML 标签的字符串数据是一个相对直接的过程。核心思想是将 HTML 视为一个普通的字符串，并将其嵌入到代表请求体的 POJO 中。Retrofit 及其 JSON 转换器会自动处理字符串的序列化和必要的转义。然而，开发者必须牢记，在服务器端处理和渲染用户提供的 HTML 内容时，实施严格的安全净化措施是防止 XSS 攻击的关键。
