JSR303简介
JSR是Java Specification Requests的缩写,意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR,以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。
准备工作
1.需要在项目中导入依赖,本项目基于SpringBoot
<!--jsr3参数校验器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
2.需要一个实体类
开始使用
1.首先在我们需要的实体类的属性上标注好注解
在非空处理方式上提供了@NotNull,@NotBlank和@NotEmpty
(1)@NotNull 该属性不能为null
(2)@NotEmpty 该字段不能为null或""
2.在我们需要的使用的controller方法中在我们的返回的json类型上添加注解
3.优化:我们发现我们以后其他方法都要验证的话,都要写这个接收的,很麻烦,我们就可以封装一个工具类、
package com.atguigu.gulimall.product.exception;
import com.atguigu.common.exception.BizCodeEnume;
import com.atguigu.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.RestController;
import java.util.HashMap;
import java.util.Map;
/**
* @author lwq
* @data 2021/7/5 18:05
*/
// @ControllerAdvice 统一处理异常的
@ControllerAdvice
@Slf4j
@RestController
public class GulimallExceptionControllerAdvice {
//数据效验的异常处理
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public R handleVaildExcetion(MethodArgumentNotValidException e) {
log.error("数据效验出现了异常,异常类型{}", e.getMessage(), e.getClass());
Map<String, Object> errorMap = new HashMap<>();
BindingResult bindingResult = e.getBindingResult();
bindingResult.getFieldErrors().forEach((fieldError) -> {
errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
});
return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(), BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data", errorMap);
}
@ExceptionHandler(Throwable.class)
public R handleException(Throwable throwable) {
return R.error();
}
}
4.由于我们的业务,所有说我们一个定义好我们返回的状态码,来规范管理,我们返回的异常状态码是公共使用的所以我们放在公共模块中
package com.atguigu.common.exception;
/***
* 错误码和错误信息定义类
* 1. 错误码定义规则为5为数字
* 2. 前两位表示业务场景,最后三位表示错误码。例如:100001。10:通用 001:系统未知异常
* 3. 维护错误码后需要维护错误描述,将他们定义为枚举形式
* 错误码列表:
* 10: 通用
* 001:参数格式校验
* 11: 商品
* 12: 订单
* 13: 购物车
* 14: 物流
*
*
*/
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;
}
}