beanvalidation校验方法参数_SpringCloud里参数校验/参数验证

点击上方蓝色字体&＃xff0c;选择“标星公众号”

优质文章&＃xff0c;第一时间送达

66套java从入门到精通实战课程分享

在控制器类的方法里自己写校验逻辑代码当然也可以&＃xff0c;只是代码比较丑陋&＃xff0c;有点“low”。业界有更好的处理方法&＃xff0c;分别阐述如下。

&＃64;GetMapping("/path/{group:[a-zA-Z0-9_]&＃43;}/{userid}")
&＃64;ResponseBody
public String path(&＃64;PathVariable("group") String group, &＃64;PathVariable("userid") Integer userid) {
    return group &＃43; ":" &＃43; userid;
}



用法是&＃xff1a;路径变量:正则表达式。当请求URI不满足正则表达式时&＃xff0c;客户端将收到404错误码。不方便的地方是&＃xff0c;不能通过捕获异常的方式&＃xff0c;向前端返回统一的、自定义格式的响应参数。

&＃64;GetMapping("/validate1")
&＃64;ResponseBody
public String validate1(
        &＃64;Size(min &＃61; 1,max &＃61; 10,message &＃61; "姓名长度必须为1到10")&＃64;RequestParam("name") String name,
        &＃64;Min(value &＃61; 10,message &＃61; "年龄最小为10")&＃64;Max(value &＃61; 100,message &＃61; "年龄最大为100") &＃64;RequestParam("age") Integer age) {
    return "validate1";
}



如果前端传递的参数不满足规则&＃xff0c;则抛出异常。注解Size、Min、Max来自validation-api.jar&＃xff0c;更多注解参见相关标准小节。

当参数是VO时&＃xff0c;可以在VO类的属性上添加校验注解。

public class User {
    &＃64;Size(min &＃61; 1,max &＃61; 10,message &＃61; "姓名长度必须为1到10")
    private String name;
 
    &＃64;NotEmpty
    private String firstName;
 
    &＃64;Min(value &＃61; 10,message &＃61; "年龄最小为10")&＃64;Max(value &＃61; 100,message &＃61; "年龄最大为100")
    private Integer age;
 
    &＃64;Future
    &＃64;JSONField(format&＃61;"yyyy-MM-dd HH:mm:ss")
    private Date birth;
    。。。
}



其中&＃xff0c;Future注解要求必须是相对当前时间来讲“未来的”某个时间。

&＃64;PostMapping("/validate2")
&＃64;ResponseBody
public User validate2(&＃64;Valid &＃64;RequestBody User user){
    return user;
}

5、自定义校验规则

5.1 自定义注解校验

需要自定义一个注解类和一个校验类。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
 
&＃64;Documented
&＃64;Retention(RetentionPolicy.RUNTIME)
&＃64;Target({ElementType.PARAMETER,ElementType.FIELD})
&＃64;Constraint(validatedBy &＃61; FlagValidatorClass.class)
public &＃64;interface FlagValidator {
    // flag的有效值&＃xff0c;多个使用,隔开
    String values();
 
    // flag无效时的提示内容
    String message() default "flag必须是预定义的那几个值&＃xff0c;不能随便写";
 
    Class>[] groups() default {};
 
    Class extends Payload>[] payload() default {};
}



import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
 
public class FlagValidatorClass implements ConstraintValidator {
    /**
     * FlagValidator注解规定的那些有效值
     */
    private String values;
    &＃64;Override
    public void initialize(FlagValidator flagValidator) {
        this.values &＃61; flagValidator.values();
    }
    /**
     * 用户输入的值&＃xff0c;必须是FlagValidator注解规定的那些值其中之一。
     * 否则&＃xff0c;校验不通过。
     * &＃64;param value 用户输入的值&＃xff0c;如从前端传入的某个值
     */
    &＃64;Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        // 切割获取值
        String[] value_array &＃61; values.split(",");
        Boolean isFlag &＃61; false;for (int i &＃61; 0; i             // 存在一致就跳出循环if (value_array[i] .equals(value)){
                isFlag &＃61; true; break;
            }
        }return isFlag;
    }
}

使用我们自定义的注解&＃xff1a;

public class User {
    // 前端传入的flag值必须是1或2或3&＃xff0c;否则校验失败
    &＃64;FlagValidator(values &＃61; "1,2,3")
    private String flag ;
    。。。
}



5.2 分组校验

import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
 
public class Resume {
    public interface Default {
    }
 
    public interface Update {
    }
 
    &＃64;NotNull(message &＃61; "id不能为空", groups &＃61; Update.class)
    private Long id;
 
    &＃64;NotNull(message &＃61; "名字不能为空", groups &＃61; Default.class)
    &＃64;Length(min &＃61; 4, max &＃61; 10, message &＃61; "name 长度必须在 {min} - {max} 之间", groups &＃61; Default.class)
    private String name;
 
    &＃64;NotNull(message &＃61; "年龄不能为空", groups &＃61; Default.class)
    &＃64;Min(value &＃61; 18, message &＃61; "年龄不能小于18岁", groups &＃61; Default.class)
    private Integer age;
    。。。
}



    /**
     * 使用Defaul分组进行验证
     * &＃64;param resume
     * &＃64;return
     */
    &＃64;PostMapping("/validate5")
    public String addUser(&＃64;Validated(value &＃61; Resume.Default.class) &＃64;RequestBody Resume resume) {
        return "validate5";
    }
 
    /**
     * 使用Default、Update分组进行验证
     * &＃64;param resume
     * &＃64;return
     */
    &＃64;PutMapping("/validate6")
    public String updateUser(&＃64;Validated(value &＃61; {Resume.Update.class, Resume.Default.class}) &＃64;RequestBody Resume resume) {
        return "validate6";
    }



建立了两个分组&＃xff0c;名称分别为Default、Update。POST方法提交时使用Defaut分组的校验规则&＃xff0c;PUT方法提交时同时使用两个分组规则。

通过设置全局异常处理器&＃xff0c;统一向前端返回校验失败信息。

import com.scj.springbootdemo.WebResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.CollectionUtils;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
 
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.List;
import java.util.Set;
 
/**
 * 全局异常处理器
 */
&＃64;ControllerAdvice
public class GlobalExceptionHandler {
 
    private Logger logger &＃61; LoggerFactory.getLogger(GlobalExceptionHandler.class);
 
    /**
     * 用来处理bean validation异常
     * &＃64;param ex
     * &＃64;return
     */
    &＃64;ExceptionHandler(ConstraintViolationException.class)
    &＃64;ResponseBody
    public  WebResult resolveConstraintViolationException(ConstraintViolationException ex){
        WebResult errorWebResult &＃61; new WebResult(WebResult.FAILED);
        Set> constraintViolations &＃61; ex.getConstraintViolations();if(!CollectionUtils.isEmpty(constraintViolations)){
            StringBuilder msgBuilder &＃61; new StringBuilder();for(ConstraintViolation constraintViolation :constraintViolations){
                msgBuilder.append(constraintViolation.getMessage()).append(",");
            }
            String errorMessage &＃61; msgBuilder.toString();if(errorMessage.length()>1){
                errorMessage &＃61; errorMessage.substring(0,errorMessage.length()-1);
            }
            errorWebResult.setInfo(errorMessage);return errorWebResult;
        }
        errorWebResult.setInfo(ex.getMessage());return errorWebResult;
    }
    &＃64;ExceptionHandler(MethodArgumentNotValidException.class)
    &＃64;ResponseBody
    public WebResult resolveMethodArgumentNotValidException(MethodArgumentNotValidException ex){
        WebResult errorWebResult &＃61; new WebResult(WebResult.FAILED);
        List  objectErrors &＃61; ex.getBindingResult().getAllErrors();if(!CollectionUtils.isEmpty(objectErrors)) {
            StringBuilder msgBuilder &＃61; new StringBuilder();for (ObjectError objectError : objectErrors) {
                msgBuilder.append(objectError.getDefaultMessage()).append(",");
            }
            String errorMessage &＃61; msgBuilder.toString();if (errorMessage.length() > 1) {
                errorMessage &＃61; errorMessage.substring(0, errorMessage.length() - 1);
            }
            errorWebResult.setInfo(errorMessage);return errorWebResult;
        }
        errorWebResult.setInfo(ex.getMessage());return errorWebResult;
    }
}7、相关标准

JSR 303 是Bean验证的规范 &＃xff0c;Hibernate Validator 是该规范的参考实现&＃xff0c;它除了实现规范要求的注解外&＃xff0c;还额外实现了一些注解。
validation-api-1.1.0.jar 包括如下约束注解&＃xff1a;

hibernate-validator-5.3.6.jar 包括如下约束注解&＃xff1a;

这篇文章 写得比较深入&＃xff0c;我没有太理解。

公司不让上传源码到GitHub&＃xff0c;可以参加这篇文章。

常见的场景之一是&＃xff0c;查询某信息时要输入开始时间和结束时间。显然&＃xff0c;结束时间要≥开始时间。可以在查询VO类上使用自定义注解&＃xff0c;下面的例子来自这里。划重点&＃xff1a;&＃64;ValidAddress使用在类上。

&＃64;ValidAddress
public class Address {
 
    &＃64;NotNull
    &＃64;Size(max &＃61; 50)
    private String street1;
 
    &＃64;Size(max &＃61; 50)
    private String street2;
 
    &＃64;NotNull
    &＃64;Size(max &＃61; 10)
    private String zipCode;
 
    &＃64;NotNull
    &＃64;Size(max &＃61; 20)
    private String city;
 
    &＃64;Valid
    &＃64;NotNull
    private Country country;
 
    // Getters and setters
}



public class Country {
 
    &＃64;NotNull
    &＃64;Size(min &＃61; 2, max &＃61; 2)
    private String iso2;
 
    // Getters and setters
}



&＃64;Documented
&＃64;Target(TYPE)
&＃64;Retention(RUNTIME)
&＃64;Constraint(validatedBy &＃61; { MultiCountryAddressValidator.class })
public &＃64;interface ValidAddress {
 
    String message() default "{com.example.validation.ValidAddress.message}";
 
    Class>[] groups() default {};
 
    Class extends Payload>[] payload() default {};
}



public class MultiCountryAddressValidator 
       implements ConstraintValidator {
    public void initialize(ValidAddress constraintAnnotation) {
    }
    &＃64;Override
    public boolean isValid(Address address, 
                           ConstraintValidatorContext constraintValidatorContext) {
        Country country &＃61; address.getCountry();if (country &＃61;&＃61; null || country.getIso2() &＃61;&＃61; null || address.getZipCode() &＃61;&＃61; null) {return true;
        }
        switch (country.getIso2()) {case "FR":return // Check if address.getZipCode() is valid for Francecase "GR":return // Check if address.getZipCode() is valid for Greece
            default:return true;
        }
    }
}

原文链接&＃xff1a;

https://blog.csdn.net/jinjiankang/article/details/89711493

• 新款SpringBoot在线教育平台开源了

• 啃了这66套Java项目课程后&＃xff0c;终于找到工作了&＃xff01;

• 精品帖子大汇总

• 牛逼plus,Spring Boot-Shiro-Vue权限系统(细粒度控制到按钮)

感谢点赞支持下哈