Spring中如何根据PackageStatus动态控制DTO字段的必填性？

@RequestBody的required属性仅用于控制整个请求体是否必须传入，无法实现基于字段值的动态条件校验，所以用它达不到你的需求。要实现根据PackageStatus的值来控制originId和description的必填性，你需要使用类级别的自定义校验注解，具体实现如下：

1. 自定义校验注解 #

创建一个类级别的校验注解，用于标记需要进行动态校验的DTO：

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.*;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PackageStatusValidator.class)
public @interface PackageValidation {
    String message() default "当状态为UPDATED时，originId和description为必填字段";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

注：如果使用Spring Boot 2.x及更早版本，替换jakarta.validation为javax.validation

2. 实现校验逻辑 #

编写校验器类，实现ConstraintValidator接口，根据status的值判断字段是否符合要求：

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;

public class PackageStatusValidator implements ConstraintValidator<PackageValidation, PackageDTO> {

    @Override
    public boolean isValid(PackageDTO dto, ConstraintValidatorContext context) {
        if (dto == null) {
            return false; // 请求体不能为空，可根据实际需求调整
        }
        // 当状态为UPDATED时，校验originId和description是否非空
        if (PackageStatus.UPDATED.equals(dto.getStatus())) {
            return dto.getOriginId() != null 
                    && dto.getDescription() != null 
                    && !dto.getDescription().isBlank();
        }
        // 状态为CREATED时，字段可选，直接通过校验
        return true;
    }
}

3. 给DTO添加校验注解 #

在PackageDTO类上加上自定义的校验注解：

@PackageValidation
public class PackageDTO {
    private Long originId;
    private String description;
    private PackageStatus status;

    // 记得添加getter和setter方法，否则校验器无法获取字段值
    public Long getOriginId() { return originId; }
    public void setOriginId(Long originId) { this.originId = originId; }
    public String getDescription() { return description; }
    public void setDescription(String description) { this.description = description; }
    public PackageStatus getStatus() { return status; }
    public void setStatus(PackageStatus status) { this.status = status; }
}

4. 保持原有接口代码并处理校验异常 #

你的PUT接口已经添加了@Valid注解，无需修改；可以添加全局异常处理器来捕获校验失败的情况，返回友好的错误响应：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalValidationExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<String> handleValidationErrors(MethodArgumentNotValidException ex) {
        String errorMsg = ex.getBindingResult().getAllErrors().stream()
                .map(error -> error.getDefaultMessage())
                .findFirst()
                .orElse("请求参数校验失败");
        return new ResponseEntity<>(errorMsg, HttpStatus.BAD_REQUEST);
    }
}

这样，当请求体的status为UPDATED但originId或description为空时，接口会返回400错误和对应的提示信息；当status为CREATED时，这两个字段可以为空，校验会通过。

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