如何为Spring Cloud OpenFeign Client创建自定义解码器处理PageView响应

要在Feign响应阶段自动解析PageView并取出content列表，无需业务代码处理，可通过自定义解码器实现，步骤如下：

1. 编写自定义解码器 #

创建CustomFeignDecoder类，继承SpringDecoder（适配Spring生态的Feign解码器），重写decode方法完成PageView的解析与content提取：

import feign.Response
import feign.codec.Decoder
import org.springframework.cloud.openfeign.support.SpringDecoder
import org.springframework.http.converter.HttpMessageConverter
import java.lang.reflect.Type

class CustomFeignDecoder(private val messageConverters: List<HttpMessageConverter<*>>) : Decoder {
    private val delegate = SpringDecoder { messageConverters }

    override fun decode(response: Response, type: Type): Any? {
        // 构造PageView带泛型的类型，指定泛型为方法声明的返回类型（比如List<MyObject>）
        val pageViewType = object : ParameterizedTypeImpl(PageView::class.java, arrayOf(type)) {}
        // 委托SpringDecoder解析成PageView对象
        val pageView = delegate.decode(response, pageViewType) as PageView<*>
        // 直接返回content列表
        return pageView.content
    }

    // 自定义ParameterizedType实现，用于动态指定PageView的泛型参数
    private class ParameterizedTypeImpl(
        private val rawType: Type,
        private val actualTypeArguments: Array<Type>
    ) : java.lang.reflect.ParameterizedType {
        override fun getRawType(): Type = rawType
        override fun getActualTypeArguments(): Array<Type> = actualTypeArguments
        override fun getOwnerType(): Type? = null
    }
}

2. 配置Feign使用自定义解码器 #

在CustomFeignConfiguration类中注册自定义解码器的Bean：

import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.http.converter.HttpMessageConverter
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter

@Configuration
class CustomFeignConfiguration {

    @Bean
    fun customFeignDecoder(): CustomFeignDecoder {
        // 配置需要的Http消息转换器，这里以Jackson为例（处理JSON）
        val messageConverters = listOf(MappingJackson2HttpMessageConverter())
        return CustomFeignDecoder(messageConverters)
    }
}

3. 验证效果 #

你的FeignClient代码无需修改，当调用getMyObjectsBySomeProperty方法时，Feign会自动将接口返回的PageView解析为List<MyObject>，业务代码直接拿到数据即可，无需处理PageView对象。

注意：确保PageMetadataView类已正确定义，且与接口返回的metadata字段结构匹配，避免解析失败。

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