深入理解Sandwich库中API错误响应的处理机制

在移动开发中，处理API错误响应是每个开发者都需要面对的重要课题。本文将以Sandwich库为例，深入探讨如何正确处理API返回的错误信息，特别是当服务器返回包含详细错误信息的JSON响应体时。

问题背景

在使用Sandwich库处理API响应时，开发者可能会遇到这样的场景：服务器返回400 Bad Request状态码，同时响应体中包含了详细的错误信息（如JSON格式的错误描述）。然而，直接使用message()或messageOrNull方法只能获取到基础的HTTP状态信息，无法提取响应体中的具体错误内容。

错误响应处理机制

Sandwich库提供了完善的API响应处理机制，特别是对于错误响应。当API返回非成功状态码时，我们可以通过以下方式获取完整的错误信息：

1. payload属性：这是最直接获取完整响应体的方式，包含了服务器返回的原始数据
2. errorBody属性：专门用于访问错误响应体
3. messageOrNull：提供简略的错误描述

最佳实践

在实际开发中，推荐采用以下模式处理错误响应：

apiRepository.addItemToCart(productId, quantity)
    .onError { error ->
        // 直接访问payload获取完整错误响应
        val errorBody = error.payload?.string()
        // 或者使用errorBody属性
        val errorJson = error.errorBody?.string()
        
        // 解析JSON错误信息
        val errorMessage = try {
            JSONObject(errorBody).getString("error")
        } catch (e: Exception) {
            "Unknown error"
        }
        
        // 更新UI状态
        _state.update {
            it.copy(
                isLoading = false,
                error = errorMessage
            )
        }
    }

技术要点解析

1. payload与errorBody的区别：

   • payload是原始响应对象，包含完整的响应信息
   • errorBody是专门针对错误响应的便捷访问方式

2. 错误信息提取：

   • 对于JSON格式的错误响应，需要手动解析
   • 建议使用try-catch块包裹解析逻辑，防止解析异常

3. 状态管理：

   • 在ViewModel中合理管理加载状态和错误状态
   • 确保UI能够正确反映API调用状态

进阶技巧

对于更复杂的应用场景，可以考虑：

1. 创建统一的错误处理拦截器
2. 定义数据类来映射标准错误响应格式
3. 使用扩展函数简化错误处理逻辑

总结

Sandwich库提供了灵活且强大的API响应处理能力。通过正确使用payload和errorBody属性，开发者可以轻松获取服务器返回的详细错误信息，从而为用户提供更友好的错误提示。理解这些机制对于构建健壮的移动应用至关重要。

记住，良好的错误处理不仅能提升用户体验，还能帮助开发者更快地定位和解决问题。在实际项目中，建议建立统一的错误处理规范，确保整个团队遵循一致的错误处理模式。