SpringDoc OpenAPI中@NotBlank注解导致表单参数解析异常问题分析

问题背景

在使用SpringDoc OpenAPI为Spring Boot项目生成API文档时，开发人员发现一个有趣的现象：当在控制器方法的表单参数上添加@NotBlank注解后，该参数在生成的OpenAPI文档中消失了。而同样的接口，不加注解时却能正常显示参数信息。

问题复现

我们来看两个非常相似的接口定义：

@PostMapping("/test1")
public Result test1(String ip) {
    return new Result();
}

@PostMapping("/test2")
public Result test2(@NotBlank String ip) {
    return new Result();
}

在生成的OpenAPI文档中，/test1接口正确地显示了ip参数，而/test2接口却将ip参数转换为了请求体(body)中的内容，而不是作为查询参数(query parameter)出现。

问题分析

1. 参数绑定机制差异

Spring MVC在处理请求参数时，对于简单类型参数(如String)默认会从查询参数或表单数据中获取。但当参数上添加了验证注解(如@NotBlank)后，SpringDoc OpenAPI的处理逻辑发生了变化。

2. SpringDoc的注解处理逻辑

SpringDoc OpenAPI在解析控制器方法参数时，会根据参数上的注解类型决定如何生成OpenAPI规范：

• 对于没有验证注解的简单参数，SpringDoc会将其视为查询参数
• 当参数添加了Bean Validation注解(如@NotBlank)后，SpringDoc会将其视为请求体的一部分

3. 底层原因

这种行为的根本原因在于SpringDoc的参数解析器(ParameterBuilder)对验证注解的处理方式。当检测到参数上有验证注解时，它会假设这是一个复杂的对象(即使实际上是一个简单类型)，从而将其归类为请求体而非查询参数。

解决方案

1. 显式指定参数位置

最直接的解决方案是使用@Parameter注解显式指定参数的位置：

@PostMapping("/test2")
public Result test2(
    @Parameter(in = ParameterIn.QUERY)
    @NotBlank String ip) {
    return new Result();
}

2. 自定义参数解析器

对于项目中有大量类似情况时，可以考虑实现自定义的OperationCustomizer来修正这种行为：

@Component
public class SimpleParamOperationCustomizer implements OperationCustomizer {
    @Override
    public Operation customize(Operation operation, HandlerMethod handlerMethod) {
        // 自定义参数处理逻辑
        return operation;
    }
}

3. 升级SpringDoc版本

在较新的SpringDoc版本中(1.7.0+)，这个问题已经得到修复。升级到最新版本可以避免这个问题。

最佳实践建议

1. 一致性原则：项目中应统一参数传递方式，要么全部使用查询参数，要么全部使用请求体
2. 显式优于隐式：对于关键参数，建议使用@Parameter注解明确指定参数位置
3. 文档验证：生成API文档后应进行人工验证，确保文档与实际接口行为一致
4. 版本控制：保持SpringDoc版本更新，及时获取问题修复

总结

SpringDoc OpenAPI对带有验证注解的参数处理方式有其设计考量，但在简单类型参数上可能会导致不符合预期的文档生成结果。理解这一行为背后的机制后，开发者可以通过多种方式进行调整，确保生成的API文档准确反映接口的实际行为。在实际开发中，建议结合项目需求选择最适合的解决方案。