java 校验接收的前端参数

一.引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.0.5.RELEASE</version>
</dependency>

二.在接收参数的类中添加注解,指定校验规则,和提示信息

@Null：被注释的元素必须为null
@NotNull：被注释的元素不能为null
@AssertTrue：该字段只能为true
@AssertFalse：该字段的值只能为false
@Min("value","message")：被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max("value","message")：被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin("value","message")：被注释的元素必须是一个数字，验证小数的最小值
@DecimalMax("value","message")：被注释的元素必须是一个数字，验证小数的最大值
@Size(max,min)：查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等
@Past：被注释的元素必须是一个过去的日期
@Future：被注释的元素必须是一个将来的日期
@Pattern(regexp = “[abc]”)：被注释的元素必须符合指定的正则表达式。
@Email：被注释的元素必须是电子邮件地址
@Length(max=5,min=1,message=“长度在1~5”)：检查所属的字段的长度是否在min和max之间，只能用于字符串
@NotEmpty：被注释的字符串必须非空
@Range(min=1,max=5,message=“大小在1~5”)：被注释的元素必须在合适的范围内
@NotBlank：不能为空，检查时会将空格忽略
@NotEmpty：不能为空，这里的空是指空字符串
 

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
 
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;

@Data
public class Employee {
 
    /** 姓名 */
    @NotBlank(message = "请输入名称")
    @Length(message = "名称不能超过个 {max} 字符", max = 10)
    public String name;
 
    /** 年龄 */
    @NotNull(message = "请输入年龄")
    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100)
    public Integer age;
 
 	/**手机 */
    @Length(message = "手机号码格式不正确",min = 11,max = 11)
    private String sharePhone;

	@NotEmpty(message = "兴趣不能为空")
	@Size(message = "兴趣数量不能大于{max}个",max = 10)
	private List<String> hobbyList;
}

三、在controller的方法中参数接收出加注解 @Valid，表示此参数接收对象将被约束

@PostMapping
@ApiOperation(value = "新增数据")
public Result insert(@Valid @RequestBody Employee employee) {
    //方法体省略...
}

四、内部成员变量类 

如果只这样设置了，那主类下的成员变量类的字段上即便加上@Max注解也不会被校验，还需要给成员变量类加上@Valid注解

五、加入MethodArgumentNotValidException到统一异常检测类

@RestControllerAdvice(basePackages = {"com.quickstart.myself"})
@Slf4j
public class BusinessExceptionHandle {
 
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public <T> BusinessResponseEntity<T> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error("##########MethodArgumentNotValidException");
        String msg = "未知的参数异常";
        BindingResult bindingResult = e.getBindingResult();
        if (bindingResult.hasErrors()) {
            msg = bindingResult.getAllErrors().stream().map(error -> error.getDefaultMessage()).collect(Collectors.joining());
        }
        log.error(msg);
        return BusinessResponseEntity.error(msg);
    }
}