spring mvc实现自定义验证器Validator

news2024/11/24 12:42:59

使用场景

在接口开发的日常实践中，确保数据准确性是保障业务稳定性的关键一环。面对诸如登录时验证用户名密码非空、创建用户时检查邮箱和手机号格式的正确性等需求，手动编写校验逻辑不仅耗时费力，还会显著降低代码的可读性和维护性。鉴于网络环境的不确定性及前端数据易遭篡改的特性，后端实施严格的参数校验变得尤为关键，以确保存储和处理的数据在逻辑上的无懈可击。

Validator介绍

Validator框架凭借其遵循的JSR-303规范，不仅强化了后端数据入口的防御机制，还通过减少重复劳动，优化了开发流程，是提升软件质量和开发速度不可或缺的工具。在现代应用开发中，其重要性不言而喻，是确保应用健壮性和数据准确性的有力保障。
JSR-303，作为Java参数验证的标准，旨在通过预定义的注解来规范数据校验，如@NotNull、@Email、@Size等，极大地减轻了开发者的工作负担。利用Validator，开发者能够快速实现诸如必填项检查、邮箱格式验证、长度限制等常见校验，无需编写冗余的验证代码，从而显著提升了开发效率与代码质量。

代码示例

创建VO对象

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;

/**
 * 自定义用户参数，用于自定义验证器
 */
@Data
public class UserVo {
    @NotBlank
    private String id;
    @Length(min = 6, max = 12, message = "密码长度必须在 6 到 12 之间")
    private String name;
    @Email(message = "邮箱格式错误")
    private String email;
}

创建接口

import com.my.java.entity.mvc.UserVo;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
@Validated
@RequestMapping("/mvc")
public class ValidController {

    @PostMapping("/user/validate")
    public String test1(@Validated @RequestBody UserVo userVo){
        log.info("validEntity is {}", userVo);
        return "userVo valid success";
    }
}

创建全局异常处理

import lombok.AllArgsConstructor;
import lombok.Data;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

import java.util.List;
import java.util.stream.Collectors;

/**
 * 自定义全局异常处理
 */
@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    /**
     *  处理参数校验异常
     * @param ex
     * @param headers
     * @param status
     * @param request
     * @return
     */
    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        List<ObjectError> allErrors = ex.getBindingResult().getAllErrors();
        // 提取allErrors中的错误信息，存入一个List<String>中，不打印
        List<String> errorList = allErrors.stream().map(ObjectError::getDefaultMessage).collect(Collectors.toList());

        ApiError apiError = new ApiError(HttpStatus.BAD_REQUEST, "Validation failed", errorList);
        return new ResponseEntity<>(apiError, apiError.getStatus());
    }

}
@Data
@AllArgsConstructor
class ApiError {
    private HttpStatus status;
    private String message;
    private List<String> errors;
}