已完成数据表、Model等开发，如何在Controller中实现API调用时自动验证复选框？

1. 基于JSR-380（Bean Validation）的自动验证 #

这是最常用的标准验证方式，通过注解快速实现规则校验，无需手动编写大量判断逻辑。

1.1 定义带验证注解的DTO（推荐方式） #

把复选框对应的参数封装到DTO类中，给字段添加对应验证注解：

import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.Pattern;
import java.util.List;

public class CheckboxRequestDTO {
    // 校验：必须至少选择一个复选框
    @NotEmpty(message = "请至少选择一个选项")
    // 校验：每个选项必须匹配指定规则（示例：仅允许A/B/C）
    @Pattern(regexp = "^(A|B|C)$", message = "选项非法，仅支持A/B/C")
    private List<String> selectedOptions;

    // getter & setter
    public List<String> getSelectedOptions() {
        return selectedOptions;
    }

    public void setSelectedOptions(List<String> selectedOptions) {
        this.selectedOptions = selectedOptions;
    }
}

1.2 在Controller中启用验证 #

在Controller方法的DTO参数前添加@Valid注解，Spring会自动触发校验逻辑：

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import jakarta.validation.Valid;

@RestController
public class CheckboxController {

    @PostMapping("/submit-checkboxes")
    public ResponseEntity<String> submitCheckboxes(@Valid @RequestBody CheckboxRequestDTO request) {
        // 校验通过后执行业务逻辑
        return ResponseEntity.ok("提交成功，选中选项：" + request.getSelectedOptions());
    }
}

1.3 全局处理校验失败的返回 #

校验不通过时Spring会抛出MethodArgumentNotValidException，可以全局捕获并返回友好的错误信息：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationErrors(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((FieldError) error).getField();
            String errorMsg = error.getDefaultMessage();
            errors.put(fieldName, errorMsg);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
}

2. 自定义验证逻辑（复杂场景适用） #

如果校验规则需要依赖数据库查询、外部接口调用等复杂逻辑，可以自定义验证注解或在Service层手动校验。

2.1 自定义验证注解 #

先定义注解类：

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

@Documented
@Constraint(validatedBy = ValidCheckboxOptionsValidator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidCheckboxOptions {
    String message() default "选项非法";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

再实现对应的验证器：

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
import java.util.List;
import java.util.Set;

public class ValidCheckboxOptionsValidator implements ConstraintValidator<ValidCheckboxOptions, List<String>> {
    // 可注入Repository从数据库获取合法选项列表
    // @Autowired
    // private OptionRepository optionRepo;

    @Override
    public void initialize(ValidCheckboxOptions constraintAnnotation) {
        // 初始化逻辑，比如预加载合法选项
    }

    @Override
    public boolean isValid(List<String> values, ConstraintValidatorContext context) {
        if (values == null || values.isEmpty()) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("请至少选择一个选项").addConstraintViolation();
            return false;
        }
        // 示例：从数据库查询的合法选项集合
        Set<String> validOptions = Set.of("A", "B", "C", "D");
        boolean allValid = values.stream().allMatch(validOptions::contains);
        if (!allValid) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("仅允许选择A/B/C/D").addConstraintViolation();
        }
        return allValid;
    }
}

最后在DTO中使用自定义注解：

public class CheckboxRequestDTO {
    @ValidCheckboxOptions
    private List<String> selectedOptions;

    // getter & setter
}

2.2 在Service层手动校验 #

如果不想使用注解，也可以直接在Service层编写校验逻辑：

import org.springframework.stereotype.Service;
import java.util.List;
import java.util.Set;

@Service
public class CheckboxService {
    // 注入Repository
    // @Autowired
    // private OptionRepository optionRepo;

    public void validateCheckboxOptions(List<String> selectedOptions) {
        if (selectedOptions == null || selectedOptions.isEmpty()) {
            throw new IllegalArgumentException("请至少选择一个选项");
        }
        Set<String> validOptions = Set.of("A", "B", "C", "D"); // 实际从数据库查询
        boolean hasInvalidOption = selectedOptions.stream().anyMatch(opt -> !validOptions.contains(opt));
        if (hasInvalidOption) {
            throw new IllegalArgumentException("存在非法选项，仅支持A/B/C/D");
        }
    }
}

在Controller中调用校验：

@PostMapping("/submit-checkboxes")
public ResponseEntity<String> submitCheckboxes(@RequestBody CheckboxRequestDTO request) {
    checkboxService.validateCheckboxOptions(request.getSelectedOptions());
    // 执行业务逻辑
    return ResponseEntity.ok("提交成功");
}

3. URL参数传递复选框的校验 #

如果复选框是通过URL参数传递（如?selected=A&selected=B），可以直接在Controller方法参数上添加注解（需在类上添加@Validated）：

import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import jakarta.validation.constraints.NotEmpty;
import java.util.List;

@RestController
@Validated
public class CheckboxController {

    @PostMapping("/submit-checkboxes")
    public ResponseEntity<String> submitCheckboxes(
            @RequestParam @NotEmpty(message = "请至少选择一个选项") List<String> selected) {
        // 校验逻辑
        return ResponseEntity.ok("提交成功，选中选项：" + selected);
    }
}

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