无法验证 Spring Boot/Kotlin 协程控制器中的请求参数

Question

在 SpringBoot/Kotlin 协程项目中，我有一个像这样的控制器类。

@RestContollser
@Validated
class PostController(private val posts: PostRepository) {

    suspend fun search(@RequestParam q:String, @RequestParam  @Min(0) offset:Int, @RequestParam  @Min(1) limit:Int): ResponseEntity<Any> {}

}

@ResquestBody 上的验证与一般的 Spring WebFlux 一样工作，但是在测试

验证请求参数时，它失败并抛出异常，例如：

java.lang.ArrayIndexOutOfBoundsException: Index 1 out of bounds for length 1
    at java.base/java.util.Arrays$ArrayList.get(Arrays.java:4165)
    Suppressed: The stacktrace has been enhanced by Reactor, refer to additional information below:

它不是 ConstraintViolationException 。

Answer 1

我认为当您使用协程时，这是框架中的一个错误（更新，是的，我看到快乐歌曲评论）。总之：

“@Validated 确实还不符合协程标准，我们需要通过使用协程感知方法来发现方法参数来解决这个问题。”

麻烦的是，你的控制器上的方法的签名实际上被Spring增强了，有一个额外的参数，像这样，添加一个延续：

public java.lang.Object com.example.react.PostController.search(java.lang.String,int,int,kotlin.coroutines.Continuation)

所以当hibernate验证器调用getParameter名称来获取你的方法上的参数列表时，它认为请求中总共有 4 个，然后尝试获取第 4 个（索引 3）时出现索引越界异常。

如果你在 this: 的返回上放置一个断点

   @Override
        public E get(int index) {
            return a[index];
        }

，并放置一个断点条件 index ==3 && a.length <4 你可以看到发生了什么。

我会将其报告为 Spring 问题跟踪器上的错误。

您可能最好采用另一种方法，如此处所述，使用 RequestBody 作为 DTO 并使用 @Valid 注释

https://www.vinsguru.com/spring-webflux-validation/

Answer 2

感谢快乐歌曲的评论，我现在找到了克服这个障碍的最佳解决方案 Spring Github 问题#23499。

正如此问题的评论和 PaulNuk 的答案中所解释的，运行时将在方法参数中附加一个 Continuation ，这将使 Hibernate 验证器中方法参数名称的索引计算失败。

解决方案是更改 ParameterNameDiscoverer.getParameterNames(Method) 方法，并在它是 挂起 函数时添加一个空字符串作为附加参数名称。

class KotlinCoroutinesLocalValidatorFactoryBean : LocalValidatorFactoryBean() {
    override fun getClockProvider(): ClockProvider = DefaultClockProvider.INSTANCE

    override fun postProcessConfiguration(configuration: javax.validation.Configuration<*>) {
        super.postProcessConfiguration(configuration)

        val discoverer = PrioritizedParameterNameDiscoverer()
        discoverer.addDiscoverer(SuspendAwareKotlinParameterNameDiscoverer())
        discoverer.addDiscoverer(StandardReflectionParameterNameDiscoverer())
        discoverer.addDiscoverer(LocalVariableTableParameterNameDiscoverer())

        val defaultProvider = configuration.defaultParameterNameProvider
        configuration.parameterNameProvider(object : ParameterNameProvider {
            override fun getParameterNames(constructor: Constructor<*>): List<String> {
                val paramNames: Array<String>? = discoverer.getParameterNames(constructor)
                return paramNames?.toList() ?: defaultProvider.getParameterNames(constructor)
            }

            override fun getParameterNames(method: Method): List<String> {
                val paramNames: Array<String>? = discoverer.getParameterNames(method)
                return paramNames?.toList() ?: defaultProvider.getParameterNames(method)
            }
        })
    }
}

class SuspendAwareKotlinParameterNameDiscoverer : ParameterNameDiscoverer {

    private val defaultProvider = KotlinReflectionParameterNameDiscoverer()

    override fun getParameterNames(constructor: Constructor<*>): Array<String>? =
        defaultProvider.getParameterNames(constructor)

    override fun getParameterNames(method: Method): Array<String>? {
        val defaultNames = defaultProvider.getParameterNames(method) ?: return null
        val function = method.kotlinFunction
        return if (function != null && function.isSuspend) {
            defaultNames + ""
        } else defaultNames
    }
}

然后声明一个新的验证器工厂 bean。

    @Primary
    @Bean
    @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
    fun defaultValidator(): LocalValidatorFactoryBean {
        val factoryBean = KotlinCoroutinesLocalValidatorFactoryBean()
        factoryBean.messageInterpolator = MessageInterpolatorFactory().getObject()
        return factoryBean
    }

从我的 Github 获取完整示例代码。

更新：Spring 6 内置了对 Kotlin 协程控制器的验证支持。