JSR303校验

JSR-303数据校验实战-优快云博客

1、JSR-303数据校验简介

JSR是Java Specification Requests的缩写，意思是Java 规范提案

JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation

即，JSR 303，Bean Validation规范 ，为Bean验证定义了元数据模型和API.。默认的元数据模型是通过Annotations来描述的，但是也可以使用XML来重载或者扩展。

2、SR303数据校验使用步骤

1.引入依赖

<!-- <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency> -->
导入上面这个包报错，不知道为啥
下面这个包正确
 <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.0.7.Final</version>
        </dependency>

2.给需要校验的字段添加校验注解

注解类型

在javax.validation.constraints包下有许多的注解：

区别

@NotNull

适用于基本数据类型(Integer，Long，Double等等)，当 @NotNull 注解被使用在 String 类型的数据上，则表示该数据不能为 Null（但是可以为 Empty）

@NotBlank

适用于 String 类型的数据上，加了@NotBlank 注解的参数不能为 Null 且 trim() 之后 size > 0，必须有实际字符

源码注释翻译：带注释的元素不能为空，并且必须包含至少一个非空白字符。接受CharSequence。

@NotEmpty

适用于 String、Collection集合、Map、数组等等，加了@NotEmpty 注解的参数不能为 Null 或者 长度为 0

源码注释翻译：被注释的元素既不能为null也不能为空。

示例

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

import java.io.Serializable;

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

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Positive;


/**
 * 品牌
 * 
 * @author liucan
 * @email liucan@gmail.com
 * @date 2022-08-27 14:23:15
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
	 * 品牌id
	 */
    @TableId
    private Long brandId;
    /**
	 * 品牌名
	 */
    @NotEmpty(message = "品牌名不能为空")
    private String name;
    /**
	 * 品牌logo地址
	 */
    @NotEmpty(message = "logo不能为空")
    @URL(message = "logo必须是一个合法的url")
    private String logo;
    /**
	 * 介绍
	 */
    private String descript;
    /**
	 * 显示状态[0-不显示；1-显示]
	 */
    private Integer showStatus;
    /**
	 * 检索首字母
	 */
    @NotEmpty
    @Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母")
    private String firstLetter;
    /**
	 * 排序
	 */
    @NotNull
    @Positive(message = "排序必须为正整数")
    private Integer sort;

}

3.在Controller中的方法形参前加上@Valid注解

    /**
     * 保存
     */
    @RequestMapping("/save")
    public R save(@RequestBody @Valid BrandEntity brand, BindingResult result){
        HashMap<String, String> map = new HashMap<>();
        if(result.hasErrors()){
            result.getFieldErrors().forEach((item)->{
                String field = item.getField();
                String message = item.getDefaultMessage();
                map.put(field,message);
            });
            return R.error(400,"提交的数据不合法").put("data",map);
        }else{
            brandService.save(brand);
        }
 
        return R.ok();
    }

在参数后接收BingingResult可获取到校验结果

3、统一异常处理

1.在common中新建一个枚举用于存放我们异常类型

public enum BizCodeEnume {
    UNKNOW_EXCEPTION(10000,"系统未知异常"),
    VAILD_EXCEPTION(10001,"参数格式校验失败");
 
    private int code;
    private String msg;
    BizCodeEnume(int code,String msg){
        this.code = code;
        this.msg = msg;
    }
 
    public int getCode() {
        return code;
    }
 
    public String getMsg() {
        return msg;
    }
}

2.在exception下新建GulimallExceptionControllerAdvice用于集中处理异常

import com.liucan.common.exception.BizCodeEnume;
import com.liucan.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
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 org.springframework.web.bind.annotation.RestControllerAdvice;
 
import java.util.HashMap;
 
/**
 * 集中处理异常
 */
// 统一处理basePackages中的异常
@Slf4j
//@ResponseBody
//@ControllerAdvice(basePackages = "com.liucan.gulimall.product.controller")
 
@RestControllerAdvice(basePackages = "com.liucan.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {
 
    //标注方法可以处理的异常
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleVaildException(MethodArgumentNotValidException e){
        log.info("数据校验出现异常:{},异常类型:{}",e.getMessage(),e.getClass());
        BindingResult result = e.getBindingResult();
        HashMap<String, String> errMap = new HashMap<>();
        result.getFieldErrors().forEach((item)->{
 
            errMap.put(item.getField(),item.getDefaultMessage());
            });
        return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errMap);
    }
    @ExceptionHandler(value = Throwable.class)
    public R hanleException(Throwable throwable){
        return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
    }
}