Spring Boot 2.7.x自定义User实体验证器实现方案咨询

核心思路 #

因为你的验证规则涉及多字段组合判断，字段级注解无法满足需求，所以采用「类级自定义注解 + 自定义ConstraintValidator」的方式实现，完全契合Spring Validation规范，适配2.7.x版本。

具体实现步骤 #

1. 定义类级自定义验证注解 #

创建类级注解，标记需要执行组合验证的User类：

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

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = UserValidator.class)
public @interface ValidUser {
    // 验证失败提示信息
    String message() default "必须提供手机号/邮箱，或者完整的姓名+地址+城市+国家+邮政编码组合";
    
    // 分组验证用（可选）
    Class<?>[] groups() default {};
    
    // 负载信息（可选）
    Class<? extends Payload>[] payload() default {};
}

2. 实现自定义验证器逻辑 #

编写ConstraintValidator实现类，处理具体验证规则：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class UserValidator implements ConstraintValidator<ValidUser, User> {

    @Override
    public boolean isValid(User user, ConstraintValidatorContext context) {
        // 规则1：判断三个选项是否至少满足一个
        boolean hasPhone = user.getPhone() != null;
        boolean hasEmail = user.getEmail() != null;
        boolean hasFullAddress = user.getName() != null 
                && user.getAddress() != null 
                && user.getCity() != null 
                && user.getCountry() != null 
                && user.getPostalCode() != null;

        if (!hasPhone && !hasEmail && !hasFullAddress) {
            return false;
        }

        // 规则2：如果选择地址组合，确保所有字段都不为null
        if (hasFullAddress) {
            // 可扩展判断字段是否为空串，比如!user.getName().trim().isEmpty()，按需调整
            return user.getName() != null 
                    && user.getAddress() != null 
                    && user.getCity() != null 
                    && user.getCountry() != null 
                    && user.getPostalCode() != null;
        }

        return true;
    }
}

3. 在User类上启用验证 #

给User类添加自定义注解@ValidUser：

@ValidUser
class User{
    private String email;
    private String phone;
    private String name;
    private String address;
    private String city;
    private String country;
    private String postalCode;
    
    // getters and setters
}

4. 在Controller中触发验证 #

在接收User参数的Controller方法上，添加@Valid或@Validated注解触发验证：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;

@RestController
public class UserController {

    @PostMapping("/users")
    public String createUser(@RequestBody @Valid User user) {
        // 业务逻辑处理
        return "用户创建成功";
    }
}

5. 自定义验证异常返回（可选） #

如果需要统一验证失败的返回格式，可全局捕获MethodArgumentNotValidException：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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>> handleValidationExceptions(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach(error -> {
            String errorMessage = error.getDefaultMessage();
            errors.put("error", errorMessage);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
}

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