controller层入参检验

controller层入参校验-使用javax.validate

是不是还在为入参校验苦恼，使用@Validated注解吧。

上案例：

在入参处加上@Validated注解。

import org.springframework.validation.annotation.Validated;

@PostMapping("/insert")
public BaseResponse<Boolean> insert(@RequestBody @Validated CertificationPackageInsertBO packageInsertBO){
  return certificationPackageService.insert(packageInsertBO);
}

在需要校验的字段上面加上@Valid注解。

非空校验，长度校验，正则匹配，都可以做到。让代码更加简单。

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import java.io.Serializable;
public class CertificationPackageInsertBO implements Serializable {
  private static final long serialVersionUID = 4883262723373949093L;
  /**
   * 应用名
   */
  @Valid
  @NotBlank(message = ErrorCodeEnum.PARAMETER_ERROR)
  @Size(max = 50,message = ErrorCodeEnum.PARAMETER_ERROR)
  private String appName;
  /**
   * 版本
   */
  @Valid
  @NotBlank(message = ErrorCodeEnum.PARAMETER_ERROR)
  @Pattern(regexp = RegexConstant.VERSION_REGEX, message = ErrorCodeEnum.PARAMETER_ERROR)
  private String version;

}

再整一个统一失败返回。

import org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.Objects;


/**
 * The type sim rest controller advice.
 *
 * @author
 */
@RestControllerAdvice
public class ExceptionRestControllerAdvice {

    /**
     * Handler exception base response.
     *
     * @param exception the exception
     * @return base response
     */
    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.OK)
    public BaseResponse<Object> handlerException(Exception exception){
        LogUtil.error("全局异常",exception);
        BaseResponse<Object> response = new BaseResponse<>();
        response.setSuccess(null);
        response.setError(new ErrorBean(new SimException(ErrorCodeEnum.COMMON_ERROR)));
        return response;
    }


    /**
     * Handler method argument not valid exception base response.
     *
     * @param exception the exception
     * @return base response
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.OK)
    public BaseResponse<Object> handlerMethodArgumentNotValidException(MethodArgumentNotValidException exception){
        BaseResponse<Object> response = new BaseResponse<>();
        response.setSuccess(null);
        BindingResult bindingResult = exception.getBindingResult();
        LogUtil.error("字段校验错误:"+bindingResult);
        ObjectError error = bindingResult.getAllErrors().get(0);
        if(error != null) {
            // 从Arguments获取字段名
            String fieldName = "";
            if(error.getArguments() != null){
                for (Object argument : error.getArguments()) {
                    if(argument instanceof DefaultMessageSourceResolvable){
                        DefaultMessageSourceResolvable resolvable = (DefaultMessageSourceResolvable)argument;
                        fieldName = resolvable.getDefaultMessage();
                    }
                }
            }
            String message = error.getDefaultMessage();
            if(message != null) {
                message = message.replace(ErrorCodeEnum.FIELD_NAME, fieldName);
                String[] split = message.split(":");
                if(split.length>=2){
                    response.setError(new ErrorBean(new SimException(split[0].trim(),split[1].trim())));
                }
            }
        }
        if(Objects.isNull(response.getError())){
            response.setError(new ErrorBean(new SimException(ErrorCodeEnum.COMMON_ERROR)));
        }
        return response;
    }
}