Android中使用Retrofit将API响应头转为POJO的实现方案

嘿，这个场景我之前做项目时刚好遇到过，给你分享几个实用的解决方案，既能把响应头转成POJO，也能轻松合并响应头和响应体的数据到一个对象里！

方案一：手动解析响应头到POJO（最直接） #

既然你已经在用Gson或者Jackson处理响应体，那完全可以用同样的库来解析响应头里的JSON数据。步骤很简单：

1. 定义响应头对应的POJO类
   先把响应头里的JSON字段映射成一个数据类，比如假设你的响应头里有个X-Auth-Data字段存着JSON格式的身份信息：

   data class LoginHeaderInfo(
       val authToken: String,
       val expiresIn: Long,
       val refreshToken: String
       // 其他响应头JSON里的字段
   )
   

2. 在onResponse中解析响应头并转为POJO
   拿到响应头里的JSON字符串后，直接用Gson解析成上面的POJO：

   override fun onResponse(call: Call<LoginModel.Response>, response: Response<LoginModel.Response>) {
       if (response.isSuccessful) {
           // 1. 解析响应头的JSON数据
           val headerJson = response.headers().get("X-Auth-Data")
           val headerInfo = runCatching {
               Gson().fromJson(headerJson, LoginHeaderInfo::class.java)
           }.getOrNull() ?: run {
               responseCallback?.onFailure("Failed to parse header data")
               return
           }
   
           // 2. 获取响应体数据
           val bodyResponse = response.body() ?: run {
               responseCallback?.onFailure("Empty response body")
               return
           }
   
           // 3. 这里可以单独处理headerInfo，或者和body合并后回调
           responseCallback?.onSuccess(Pair(headerInfo, bodyResponse))
       } else {
           val errorMsg = response.errorBody()?.string() ?: "Login failed with code ${response.code()}"
           responseCallback?.onFailure(errorMsg)
       }
   }
   

方案二：合并响应头和响应体到单个POJO（更优雅） #

如果希望上层拿到的是一个统一的对象，不用分开处理头和体，可以创建一个包含两者数据的合并类：

1. 定义合并后的POJO
   更灵活的方式是直接嵌套两个子对象，避免字段冗余：

   data class CombinedLoginResponse(
       val header: LoginHeaderInfo,
       val body: LoginModel.Response
   )
   

2. 填充合并类的数据
   在onResponse里把解析后的头和体数据都塞进合并类：

   override fun onResponse(call: Call<LoginModel.Response>, response: Response<LoginModel.Response>) {
       if (response.isSuccessful) {
           val headerJson = response.headers().get("X-Auth-Data")
           val headerInfo = Gson().fromJson(headerJson, LoginHeaderInfo::class.java) ?: run {
               responseCallback?.onFailure("Invalid header data")
               return
           }
   
           val bodyResponse = response.body() ?: run {
               responseCallback?.onFailure("Empty body")
               return
           }
   
           // 合并成一个统一对象
           val combinedResponse = CombinedLoginResponse(headerInfo, bodyResponse)
           responseCallback?.onSuccess(combinedResponse)
       } else {
           // 错误处理
           responseCallback?.onFailure("Login failed: ${response.code()}")
       }
   }
   

小提示：封装工具类避免重复代码 #

如果多个接口都需要解析响应头，可以封装一个通用的解析工具类，减少重复代码：

object HeaderParser {
    private val gson = Gson()

    fun <T> parse(headers: Headers, headerKey: String, clazz: Class<T>): T? {
        val jsonStr = headers.get(headerKey) ?: return null
        return try {
            gson.fromJson(jsonStr, clazz)
        } catch (e: JsonSyntaxException) {
            Log.e("HeaderParser", "Failed to parse header JSON: ${e.message}")
            null
        }
    }
}

使用时就一行代码：

val headerInfo = HeaderParser.parse(response.headers(), "X-Auth-Data", LoginHeaderInfo::class.java)

注意事项 #

• 一定要加异常捕获：响应头可能不存在目标字段，或者JSON格式错误，直接解析会崩溃，用runCatching或者try-catch处理更安全。
• 如果你的响应头是多个字段都是独立的JSON（而不是单个字段存JSON），那可以遍历headers，把需要的字段逐个提取后组装成POJO。

内容的提问来源于stack exchange，提问作者Ashok Reddy Narra