Retrofit中异常处理时获取请求URL和方法的最佳实践

在使用Retrofit进行网络请求时，开发者经常需要处理各种异常情况。一个常见的需求是当请求失败时，能够获取到请求的URL端点和方法类型(GET/POST等)，以便进行日志记录或错误分析。本文将深入探讨在Retrofit中实现这一需求的最佳实践。

问题背景

在Kotlin协程环境下，我们通常会使用挂起函数来封装Retrofit的API调用。一个典型的封装模式如下：

suspend fun <T : BaseResponse> safeCallApi(
    api: suspend () -> Response<T>
): Result<T> {
    return try {
        val response = api()
        // 处理成功响应
    } catch (e: Exception) {
        // 需要获取URL和方法信息
        Result.failure(UnknownException(e))
    }
}

当异常发生时，我们希望能够获取到请求的URL和方法类型，但直接通过异常对象很难获取这些信息。

解决方案

1. 使用Call对象替代挂起函数

Retrofit的Call对象包含了完整的请求信息。我们可以修改API定义，使其返回Call对象而非直接返回Response：

interface MyApiService {
    @GET("users")
    fun getUsers(): Call<UserResponse>
}

然后在封装函数中，我们可以通过Call对象获取请求信息：

suspend fun <T> safeCallApi(api: () -> Call<T>): Result<T> {
    val call = api()
    try {
        val response = call.awaitResponse()
        // 处理响应
    } catch (e: Exception) {
        val url = call.request().url.toString()
        val method = call.request().method
        // 记录日志或处理异常
    }
}

2. 异常类型分析

Retrofit可能抛出两种主要类型的异常：

1. HttpException：当服务器返回非成功状态码时抛出，包含Response对象
2. IOException：网络连接问题时抛出，不包含请求信息

对于HttpException，我们可以通过response()方法获取请求信息：

catch (e: HttpException) {
    val request = e.response()?.raw()?.request
    val url = request?.url?.toString()
    val method = request?.method
}

但对于IOException，我们只能通过预先保存的Call对象来获取请求信息。

实践建议

1. 统一封装网络请求：建议在项目基础架构层统一封装网络请求处理，集中记录请求和响应信息。

2. 完整的日志记录：除了URL和方法，还可以记录请求头、请求体、响应时间等信息。

3. 错误分类处理：根据不同的异常类型和请求信息，实现不同的错误处理策略。

4. 性能考虑：在记录日志时注意性能影响，可以考虑异步记录或采样记录。

完整示例

suspend fun <T> safeCallApi(api: () -> Call<T>): Result<T> {
    val call = api()
    val startTime = System.currentTimeMillis()
    
    return try {
        val response = call.awaitResponse()
        val duration = System.currentTimeMillis() - startTime
        
        logRequest(call.request(), duration, response.code())
        
        if (response.isSuccessful) {
            response.body()?.let { Result.success(it) } ?: Result.failure(NullBodyException())
        } else {
            Result.failure(ServerException(response.code()))
        }
    } catch (e: Exception) {
        logError(call.request(), e)
        Result.failure(NetworkException(e))
    }
}

private fun logRequest(request: Request, duration: Long, statusCode: Int) {
    // 实现请求日志记录
}

private fun logError(request: Request, e: Exception) {
    // 实现错误日志记录
}

通过这种方式，我们可以确保在任何异常情况下都能获取到完整的请求信息，为问题排查和系统监控提供有力支持。