Hibernate-Validator(参数的校验)

一、Validator 有什么作用？

1. 在开发中经常需要写一些字段校验的代码，比如字段非空，字段长度限制，邮箱格式验证等等

2. 防止攻击！我们前后端分离，我们后端仅仅提供数据接口，若有人想破解我们，别人可以直接跳过前端！

1.1 场景

上图验证，只是前端的验证。对后端来说会增加数据的规范性，但是别人可以跳过你这个前端的验证！

使用Postman 就可以跳过前端验证。

所以我们需要在后端做一个数据的验证

1.2 validate的使用

1. 添加 Hibernate-Validator 依赖。如果当前是springboot项目且有web依赖，则不需要引用任何依赖，因为spring-boot-starter-web包中已经包含了Hibernate-Validator 依赖

<dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.0.7.Final</version>
</dependency>

2. 在类的属性上加上对应的注解，set，get方法采用了lombok框架，@apiModelProperty是swagger2依赖的注解

3. 在后端post方法上添加@RequestBody 和@Valid注解

只有添加@Valid注解，在类上书写的注解才可以生效。

4. 校验validator注解是否生效

由上图可知，校验注解生效，但是会抛出一个异常。所以应该对这个异常进行处理

1.3 validator常用的注解

注解	释义
@NotNull	被注释的元素必须不为 null 元素可以为任意值
@NotBlank	被标记的字符串不能为null或空串 只能标记在字符串上
@NotEmpty	被标记的集合不能为null或空集合 只能标记在集合上
@Null	被注释的元素必须为 null
@AssertTrue	被注释的元素必须为true
@AssertFalse	被注释的元素必须为 false
@Min(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)	被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Size(max, min)	被注释的元素的大小必须在指定的范围内，元素必须为集合，代表集合个数
@Digits (integer, fraction)	被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past	被注释的元素必须是一个过去的日期
@Future	被注释的元素必须是一个将来的日期
@Email	被注释的元素必须是电子邮箱地址
@Length(min=, max=)	被注释的字符串的大小必须在指定的范围内，必须为数组或者字符串，若为数组则表示为数组长度，字符串则表示为字符串长度
@Range(min=, max=)	被注释的元素必须在合适的范围内
@Pattern(regexp = )	正则表达式校验
@Valid	对象级联校验,即校验对象中对象的属性

二、全局的异常处理

package com.zxm.aspect;

import lombok.extern.slf4j.Slf4j;
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authz.UnauthorizedException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@Slf4j  // 记录日志的注解   相当于private static final Logger log  = LoggerFactory.getLogger(WebLogError.class);
@RestControllerAdvice // 用户拦截Controller抛给用户的异常信息
public class WebLogError {
    /**
     * 代表用户登录可能过期了
     */
    @ExceptionHandler(AuthenticationException.class)
    public ResponseEntity<String> authException(){
        return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("你的登录已经过期，请重新登录");
    }
    /**
     * 参数异常:需要给别人提醒一下
     */
    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<String> paramException(IllegalArgumentException e){
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
    }

    /**
     *  若是运行时，异常，我们的错误信息不能随便泄露给别人
     * @param e
     * @return
     */
    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<String> runtimeException(RuntimeException e){
        log.error("运行异常",e); // 可以帮我们记录在日志文件里面。方便排错
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器正在维修");
    }

    /**
     * shiro 里面没有某种权限的异常
     * @return
     */
    @ExceptionHandler(UnauthorizedException.class)
    public ResponseEntity<String> unauthorized(){
        return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("没有权限访问") ;
    }
    
    /**
     * shiro 里面没有某种权限的异常
     * @return
     */
	@ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<String> methodArgumentNotValidException(MethodArgumentNotValidException bindException){
        BindingResult bindingResult = bindException.getBindingResult();// bindingResult就是验证错误的结果
        System.out.println(bindingResult);
        StringBuffer sb = new StringBuffer("数据校验失败,原因是：");
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        for (FieldError fieldError : fieldErrors) {
            /**
             * fieldError.getField 那个字段
             * fieldError.getDefaultMessage 错误原因
             */

            sb.append(fieldError.getDefaultMessage()+"!");
        }
        return ResponseEntity.badRequest().body(sb.toString());
    }

}