feign自定义ErrorDecoder 错误时返回统一的错误对象

曾经的接口开发，大家都习惯返回200状态码，然后在响应体中使用以下形式

{
	code:200
	data:{
		name:zhangsan
		age:18
	}
	msg:msg
}

这时候feign的接收对象可以使用该对象。

现在接口都追求rest风格，接口在正常流程时会返回请求的数据，错误时会返回错误的描述信息。此时不同的情况下httpcode也不能统一是200
那么正常和异常的情况就不能一概而论，正常情况下直接返回数据

{
	name:zhangsan
	age:18
}

异常情况返回错误码和错误信息

{
	error_code:200
	message:message
}

这时候正常和异常返回不同对象，在feign中就需要不同的处理。
做法就是使用自定义的ErrorDecoder，在返回码不是2XX会进入这个处理流程

open class ExceptionErrorDecoder(private var objectMapper: ObjectMapper = ObjectMapper()) : ErrorDecoder {
    private val logger = LoggerFactory.getLogger(ExceptionErrorDecoder::class.java)

    override fun decode(s: String, response: Response): Exception {
        val reader = response.body().asReader()
        val body = Util.toString(reader)
        logger.info("feign接口url:${response.request().url()},body:$body")
        val javaType =
            objectMapper.typeFactory.constructParametricType(Map::class.java, String::class.java, String::class.java)
        try {
            val map: Map<String, String> = objectMapper.readValue(body, javaType)
            return CommonException(map.getValue("code"), map.getValue("message"))
        } catch (e: IOException) {
            logger.warn("字符串转List失败，{}", e.message)
        }
        return CommonException("500", "未知异常")
    }
}

然后搞一个

//@Configuration 需要对所有FeignClient生效的话放开这个注释
open class Configuration {

    @Bean
    open fun exceptionErrorDecoder(): ExceptionErrorDecoder {
        return ExceptionErrorDecoder()
    }
}

注意，这里没有用@Configuration注解，因为可以在FeignClient上可以手动注明使用哪个。如下：

@FeignClient(name = "hello", configuration = [Configuration::class])
@RequestMapping("/worlds")
interface MyClient {

如果不用给每个FeignClient定义不同的配置，可以加@Configuration注解，并且不用在每个FeignClient上指定配置。

PS：如果你在使用Kotlin，并且最终捕获的异常不是你在ErrorDecoder中返回的异常，而是一个UndeclaredThrowableException，可以参考我另一篇文章