spring注解校验跟分组校验详解

• 1.实体类

package com.lg.sgg.product.entity;

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

import java.io.Serializable;
import java.util.Date;

import com.lg.common.valid.AddGroup;
import com.lg.common.valid.UpdateGroup;
import lombok.Data;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;

/**
 * 品牌
 * 
 * @author lg
 * @email lg@gmail.com
 * @date 2020-11-02 20:42:27
 */
@Data
@TableName("pms_brand")
public class PmsBrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id 
	 */
	@NotNull(message = "修改不能品牌Id不能为空",groups = {UpdateGroup.class})
    @Null(message = "新增不能指定id",groups = {AddGroup.class})
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名不能为空")
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank(message = "品牌的logo地址不能为空")
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	@NotNull
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	private String firstLetter;
	/**
	 * 排序
	 */
	private Integer sort;

}

• 2.新建两个分组空接口
  add分组

package com.lg.common.valid;

public interface AddGroup {
}

Update分组

package com.lg.common.valid;

public interface UpdateGroup {
}

• 3. 使用@Validated指定分组
     说明：这里要是指定了分组，实体类上的注解就是指定了分组的注解才生效，没有指定分组的默认不生效，要是没有指定分组，就是对没有指定分组的注解生效，指定分组的注解就不生效了
• 4. 配合使用全局异常处理

package com.lg.sgg.product.exception;

import com.lg.common.exception.BizCodeEnume;
import com.lg.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.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

/**
 * Date:2020/12/8
 *
 * @author:lg
 */
@Slf4j
//  Rest 返回的都是一个json 数据，如果想返回一个页面的话，直接
// 使用ControllerAdvice，下面的每一个#ExceptionHandler单独可以加上ResponseBody
// 返回数据
@RestControllerAdvice(basePackages = "com.lg.sgg.product.controller")
public class SggGlobalException {


    /**
     * 所有异常捕获，可以自定义不同类型的异常
     * @param throwable
     * @return
     */
    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable){

        log.error("错误：",throwable);
        return R.error(1000,"系统错误");
    }



    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public R handleVaildException(MethodArgumentNotValidException e){
        log.error("数据校验出现问题{}，异常类型：{}",e.getMessage(),e.getClass());
        BindingResult bindingResult = e.getBindingResult();

        Map<String,String> errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach((fieldError)->{
            errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
        });
        return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
    }
}

• 5.测试结果

http://localhost:88/api/product/brand/save

{"brandId":1111}

{
    "msg": "参数格式校验失败",
    "code": 10001,
    "data": {
        "brandId": "新增不能指定id"
    }
}

http://localhost:88/api/product/brand/update

{"brandId":null}

{
    "msg": "参数格式校验失败",
    "code": 10001,
    "data": {
        "brandId": "修改不能品牌Id不能为空"
    }
}

• 6.小结
  JSR303
  1、给Bean添加校验注解:javax.validation.constraints，并定义自己的message提示
  2、开启校验功能@Valid
  效果：校验错误以后会有默认的响应；
  3、给校验的bean后紧跟一个BindingResult，就可以获取到校验的结果
  4、分组校验（多场景的复杂校验）
  1)、 @NotBlank(message = “品牌名必须提交”,groups = {AddGroup.class,UpdateGroup.class})
  给校验注解标注什么情况需要进行校验
  2）、@Validated({AddGroup.class})
  3)、默认没有指定分组的校验注解@NotBlank，在分组校验情况@Validated({AddGroup.class})下不生效，只会在@Validated生效；