迁移ContentNegotiation至根路由后StatusPages序列化异常问题

当你把全局ContentNegotiation从Application级迁移到根路由后，StatusPages作为全局插件无法获取路由内的内容协商配置，导致异常响应无法序列化，返回406空体。以下是几种可行的解决办法：

1. 抽离ContentNegotiation配置，在StatusPages中复用 #

把通用的内容协商配置单独抽成变量，既用于路由安装，也在StatusPages处理异常时手动调用序列化逻辑：

// 抽离通用配置
val commonContentNegotiation = ContentNegotiationConfig().apply {
    json(Json {
        prettyPrint = true
        ignoreUnknownKeys = true
    })
    // 添加其他需要的格式支持
}

// 根路由安装ContentNegotiation
routing {
    install(ContentNegotiation, commonContentNegotiation)
    
    // GraphQL路由使用自定义配置
    route("/graphql") {
        install(ContentNegotiation) {
            // 你的GraphQL专属内容协商配置
        }
        // GraphQL路由逻辑
    }
}

// StatusPages中手动复用配置处理异常
install(StatusPages) {
    exception<Throwable> { call, cause ->
        val errorResp = CustomErrorResponse(message = cause.message ?: "未知错误")
        val negotiator = ContentNegotiation(commonContentNegotiation)
        negotiator.negotiate(call).serialize(errorResp, call)
    }
}

2. 在路由内实现全局异常捕获 #

绕过StatusPages的全局限制，在根路由内添加异常处理逻辑，利用路由级的ContentNegotiation自动序列化响应：

routing {
    install(ContentNegotiation) {
        // 全局路由级内容协商配置
    }

    // 根路由异常捕获，确保所有子路由的异常都能被处理
    handle {
        try {
            proceed()
        } catch (e: Throwable) {
            call.respond(
                status = HttpStatusCode.InternalServerError,
                message = CustomErrorResponse(e.message ?: "服务器内部错误")
            )
        }
    }

    // GraphQL自定义路由
    route("/graphql") {
        install(ContentNegotiation) {
            // 自定义配置
        }
        // 路由逻辑
    }
}

3. 手动序列化并指定Content-Type #

如果场景简单，直接在StatusPages中手动序列化错误响应，强制指定JSON类型，无需依赖ContentNegotiation：

install(StatusPages) {
    exception<Throwable> { call, cause ->
        val errorJson = Json.encodeToString(
            CustomErrorResponse(message = cause.message ?: "未知错误")
        )
        call.respondText(
            text = errorJson,
            contentType = ContentType.Application.Json,
            status = HttpStatusCode.InternalServerError
        )
    }
}

内容的提问来源于stack exchange，提问作者caeus