SpringDoc OpenAPI中@Parameter与@RequestPart注解的required属性冲突解析

在Spring Boot应用开发中，我们经常会使用SpringDoc OpenAPI来自动生成API文档。最近在使用过程中发现了一个关于参数必填标记的有趣现象：当同时使用@RequestPart和@Parameter注解时，它们的required属性存在优先级问题，这直接影响了API文档的准确性和参数验证行为。

问题现象

假设我们有一个接收文件上传的接口，其中包含一个URL参数：

@PostMapping
public void upload(
    @NotBlank @URL 
    @RequestPart(name = "url", required = false) 
    @Parameter(description = "URL参数", required = true) 
    String url) {
    // 方法实现
}

开发者期望这个URL参数在文档中显示为必填（通过@Parameter(required=true)），但在实际请求中允许不传（通过@RequestPart(required=false)）。然而实际情况是：

1. 生成的OpenAPI文档中，URL参数不会被标记为必填
2. 如果将@RequestPart改为required=true，文档会正确显示必填，但请求验证会提前拦截缺失的参数

技术背景分析

这个问题涉及到Spring MVC和SpringDoc OpenAPI两个框架的不同处理逻辑：

1. Spring MVC层面：@RequestPart的required属性直接影响参数绑定行为。当设置为true时，如果请求中缺少该参数，框架会直接抛出MissingServletRequestPartException，根本不会执行后续的校验逻辑。

2. SpringDoc OpenAPI层面：默认情况下，文档生成器会优先考虑@RequestPart的required属性，而忽略@Parameter的配置。这与开发者期望的行为不符。

解决方案探讨

目前官方尚未提供直接的配置来解决这个矛盾，但我们可以考虑以下几种变通方案：

方案一：统一使用@RequestPart的required属性

@RequestPart(name = "url", required = true)
@Parameter(description = "URL参数")
String url

这样能确保文档和验证行为一致，但失去了灵活控制文档和实际验证的能力。

方案二：自定义OpenAPI配置

通过实现OpenApiCustomiser接口，可以手动修改生成的OpenAPI文档：

@Bean
public OpenApiCustomiser openApiCustomiser() {
    return openApi -> {
        openApi.getPaths().forEach((path, pathItem) -> {
            pathItem.readOperations().forEach(operation -> {
                // 手动设置特定参数的required属性
            });
        });
    };
}

方案三：使用DTO对象封装参数

更推荐的方式是使用DTO对象来封装请求参数：

public class UploadRequest {
    @NotBlank
    @URL
    private String url;

    // getter/setter
}

// 控制器方法
@PostMapping
public void upload(@Valid UploadRequest request) {
    // 实现
}

这种方式分离了文档生成和参数验证的关注点，更加清晰。

最佳实践建议

1. 保持文档与实现一致：API文档应该准确反映接口的实际行为，避免文档说必填但实际可不传的情况。

2. 优先使用DTO模式：对于复杂参数，使用DTO对象可以更好地组织代码，同时方便统一处理验证和文档生成。

3. 考虑使用分组验证：如果需要区分不同场景下的必填要求，可以使用验证分组功能。

总结

SpringDoc OpenAPI与Spring MVC在参数必填标记处理上存在一些不一致，这提醒我们在设计API时需要综合考虑文档生成和实际验证的需求。通过合理的架构设计和适当的变通方案，我们可以创建出既文档清晰又行为一致的API接口。未来版本的SpringDoc可能会改进这一行为，但目前开发者需要了解这些底层细节以避免陷阱。