HttpClient Ktor 异常处理
Handling Exception in HttpClient Ktor
我在如下的公共模块中写了一段公共代码,并在JS环境下测试
val response = client.post<HttpResponse>(url) {
body = TextContent("""{"a":1,"b":2}""", ContentType.Application.Json)
}
if (response.status != HttpStatusCode.OK) {
logger.error("Error, this one failed bad?")
}
但是我的代码在 client.post 处结束,在没有网络的情况下取消了 corutineException。我如何处理这个和任何其他异常?如果有互联网连接。没有失败,我希望能够处理异常。如何?
注意:try,catch 无效
好吧,在到处询问之后,我得到了 github issues 的帮助,并来到这里工作
try {
val response = client.post<HttpResponse>(url) {
body = TextContent("""{"a":1,"b":2}""", ContentType.Application.Json)
}
if (response.status != HttpStatusCode.OK) {
logger.error("Error, this one failed bad?")
}
} catch (cause: Throwable) {
logger.error("Catch your error here")
}
不要混淆 catch (c: Throwable)
和 catch (e: Exception)
希望这对您有所帮助
没有对当前答案添加太多内容,但为了响应 CVS 的评论,我一直在使用以下内容在我的应用程序中添加 ktor 客户端错误处理。它使用 Result API。 runCatching {}
捕获所有 Throwable
,您可以调整 getOrElse
块的行为以捕获您感兴趣的异常。
suspend fun <T> HttpClient.requestAndCatch(
block: suspend HttpClient.() -> T,
errorHandler: suspend ResponseException.() -> T
): T = runCatching { block() }
.getOrElse {
when (it) {
is ResponseException -> it.errorHandler()
else -> throw it
}
}
// Example call
client.requestAndCatch(
{ get<String>("/") },
{
when (response.status) {
HttpStatusCode.BadRequest -> {} // Throw errors or transform to T
HttpStatusCode.Conflict -> {}
else -> throw this
}
}
)
我相信它可以变得更整洁,但这是我迄今为止想到的最好的。
我们可以使用这个包装成功和错误案例的扩展函数以集中方式处理它。我们可能会遇到网络错误、序列化错误或服务器错误,这些错误可能会为 UI 和 http 状态代码公开错误 bodies/messages。
suspend inline fun <reified T, reified E> HttpClient.safeRequest(
block: HttpRequestBuilder.() -> Unit,
): ApiResponse<T, E> =
try {
val response = request { block() }
ApiResponse.Success(response.body())
} catch (e: ClientRequestException) {
ApiResponse.Error.HttpError(e.response.status.value, e.errorBody())
} catch (e: ServerResponseException) {
ApiResponse.Error.HttpError(e.response.status.value, e.errorBody())
} catch (e: IOException) {
ApiResponse.Error.NetworkError
} catch (e: SerializationException) {
ApiResponse.Error.SerializationError
}
suspend inline fun <reified E> ResponseException.errorBody(): E? =
try {
response.body()
} catch (e: SerializationException) {
null
}
这是下面定义的 ApiResponse
,所以有工作代码:
sealed class ApiResponse<out T, out E> {
/**
* Represents successful network responses (2xx).
*/
data class Success<T>(val body: T) : ApiResponse<T, Nothing>()
sealed class Error<E> : ApiResponse<Nothing, E>() {
/**
* Represents server (50x) and client (40x) errors.
*/
data class HttpError<E>(val code: Int, val errorBody: E?) : Error<E>()
/**
* Represent IOExceptions and connectivity issues.
*/
object NetworkError : Error<Nothing>()
/**
* Represent SerializationExceptions.
*/
object SerializationError : Error<Nothing>()
}
}
我发现 ApiResponse
对我的案例很有效,但如果你有 other/special 个案例,你不必像这样模拟你的 api 响应,你也可以使用 kotlin-result or Arrow's Either.
我在如下的公共模块中写了一段公共代码,并在JS环境下测试
val response = client.post<HttpResponse>(url) {
body = TextContent("""{"a":1,"b":2}""", ContentType.Application.Json)
}
if (response.status != HttpStatusCode.OK) {
logger.error("Error, this one failed bad?")
}
但是我的代码在 client.post 处结束,在没有网络的情况下取消了 corutineException。我如何处理这个和任何其他异常?如果有互联网连接。没有失败,我希望能够处理异常。如何?
注意:try,catch 无效
好吧,在到处询问之后,我得到了 github issues 的帮助,并来到这里工作
try {
val response = client.post<HttpResponse>(url) {
body = TextContent("""{"a":1,"b":2}""", ContentType.Application.Json)
}
if (response.status != HttpStatusCode.OK) {
logger.error("Error, this one failed bad?")
}
} catch (cause: Throwable) {
logger.error("Catch your error here")
}
不要混淆 catch (c: Throwable)
和 catch (e: Exception)
希望这对您有所帮助
没有对当前答案添加太多内容,但为了响应 CVS 的评论,我一直在使用以下内容在我的应用程序中添加 ktor 客户端错误处理。它使用 Result API。 runCatching {}
捕获所有 Throwable
,您可以调整 getOrElse
块的行为以捕获您感兴趣的异常。
suspend fun <T> HttpClient.requestAndCatch(
block: suspend HttpClient.() -> T,
errorHandler: suspend ResponseException.() -> T
): T = runCatching { block() }
.getOrElse {
when (it) {
is ResponseException -> it.errorHandler()
else -> throw it
}
}
// Example call
client.requestAndCatch(
{ get<String>("/") },
{
when (response.status) {
HttpStatusCode.BadRequest -> {} // Throw errors or transform to T
HttpStatusCode.Conflict -> {}
else -> throw this
}
}
)
我相信它可以变得更整洁,但这是我迄今为止想到的最好的。
我们可以使用这个包装成功和错误案例的扩展函数以集中方式处理它。我们可能会遇到网络错误、序列化错误或服务器错误,这些错误可能会为 UI 和 http 状态代码公开错误 bodies/messages。
suspend inline fun <reified T, reified E> HttpClient.safeRequest(
block: HttpRequestBuilder.() -> Unit,
): ApiResponse<T, E> =
try {
val response = request { block() }
ApiResponse.Success(response.body())
} catch (e: ClientRequestException) {
ApiResponse.Error.HttpError(e.response.status.value, e.errorBody())
} catch (e: ServerResponseException) {
ApiResponse.Error.HttpError(e.response.status.value, e.errorBody())
} catch (e: IOException) {
ApiResponse.Error.NetworkError
} catch (e: SerializationException) {
ApiResponse.Error.SerializationError
}
suspend inline fun <reified E> ResponseException.errorBody(): E? =
try {
response.body()
} catch (e: SerializationException) {
null
}
这是下面定义的 ApiResponse
,所以有工作代码:
sealed class ApiResponse<out T, out E> {
/**
* Represents successful network responses (2xx).
*/
data class Success<T>(val body: T) : ApiResponse<T, Nothing>()
sealed class Error<E> : ApiResponse<Nothing, E>() {
/**
* Represents server (50x) and client (40x) errors.
*/
data class HttpError<E>(val code: Int, val errorBody: E?) : Error<E>()
/**
* Represent IOExceptions and connectivity issues.
*/
object NetworkError : Error<Nothing>()
/**
* Represent SerializationExceptions.
*/
object SerializationError : Error<Nothing>()
}
}
我发现 ApiResponse
对我的案例很有效,但如果你有 other/special 个案例,你不必像这样模拟你的 api 响应,你也可以使用 kotlin-result or Arrow's Either.