Spring WebFlux Kotlin项目自定义枚举Converter不被调用如何解决?
问题排查与解决方案
场景1:转换器用于查询参数、路径变量、表单参数
该场景下是Spring ConversionService负责类型转换,不生效通常是以下几个原因:
- Kotlin类默认final导致Spring无法正确注册
Kotlin类默认是final类型,Spring部分组件注册逻辑需要类可继承才能完成代理和识别,给Converter类加上open关键字即可解决,也可以引入Kotlin的all-open插件,配置@Component注解自动取消final限制。 - 泛型签名匹配失败
你当前实现的Converter返回可空类型WarehousesType?,Spring匹配转换器时会严格校验目标类型签名,Kotlin可空类型会携带@Nullable注解,导致和非空枚举类型匹配失败。调整返回值为非空即可,异常分支直接抛出错误不需要返回null:@Component open class WarehousesTypeEnumConverter : Converter<String, WarehousesType>{ companion object { private val log: Logger = LoggerFactory.getLogger(WarehousesTypeEnumConverter::class.java) } override fun convert(value: String): WarehousesType = try { log.info("try to convert {} to {}", value, WarehousesType::class.java) WarehousesType.valueOf(value.uppercase()) }catch (e: IllegalArgumentException){ log.error("error to convert {} to {}", value, WarehousesType::class.java) throw e } } - 手动注册方式不严谨
泛型擦除可能导致Spring无法识别转换器的目标类型,手动注册时强制指定转换的源和目标类型即可:
如果接口参数声明为可空类型@Configuration open class WebConfig : WebFluxConfigurer { override fun addFormatters(registry: FormatterRegistry) { // 显式指定转换类型,避免泛型擦除导致匹配失败 registry.addConverter(String::class.java, WarehousesType::class.java, WarehousesTypeEnumConverter()) } }WarehousesType?,需要同步调整转换器的目标类型为可空,或者直接将参数改为非空减少匹配歧义。
场景2:转换器用于@RequestBody JSON字段的枚举转换
该场景下Spring Converter不会生效,JSON反序列化由Jackson负责,有两种解决方案:
- 方案1:单独给目标枚举配置大小写不敏感的反序列化器
@JsonDeserialize(using = WarehousesTypeDeserializer::class) enum class WarehousesType { // 枚举值定义 } class WarehousesTypeDeserializer : StdDeserializer<WarehousesType>(WarehousesType::class.java) { override fun deserialize(p: JsonParser, ctxt: DeserializationContext): WarehousesType { return WarehousesType.valueOf(p.text.uppercase()) } } - 方案2:全局配置Jackson,所有枚举都支持大小写兼容
@Configuration open class JacksonConfig { @Bean open fun objectMapper(): ObjectMapper { return ObjectMapper() .configure(DeserializationFeature.ACCEPT_CASE_INSENSITIVE_ENUMS, true) } }
内容的提问来源于stack exchange,提问作者Jose Luiz Junior
相关产品推荐
相关产品推荐

