实体类字段校验麻烦？自定义注解帮你校验

1. 创建一个注解

package com.atguigu.common.annotation;

import com.atguigu.common.annotation.validated.YgqListValueValidated;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

//表示这个是元注解
@Documented
//注解校验器类
@Constraint(validatedBy = {YgqListValueValidated.class})
//作用域，表示在方法，字段，类以及其他地方才可以表示这个注解
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
//标识运行时注解 始终不会丢弃，运行期也保留该注
@Retention(RetentionPolicy.RUNTIME)
public @interface YgqListValue {
//表示默认值，我们可以在ValidationMessages.properties里面配置，见下文
    String message() default "{com.atguigu.common.annotation.YgqListValue.message}";
	//支持分组
    Class<?>[] groups() default {};
	//payload 负载
    Class<? extends Payload>[] payload() default {};
	//定义一个数字参数，用于校验指定得数字
    int[] vals() default {};

}

2. 我们可以在resources里面创建ValidationMessages来配置message默认值
   
3. 定义校验器，校验值

package com.atguigu.common.annotation.validated;

import com.atguigu.common.annotation.YgqListValue;
import org.springframework.validation.annotation.Validated;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;

public class YgqListValueValidated implements ConstraintValidator<YgqListValue, Integer> {
    private HashSet<Integer> set = new HashSet<>();

    //校验器初始化
    @Override
    public void initialize(YgqListValue constraintAnnotation) {
        //将我们指定得值全部放到set集合里面
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }

    //校验结果
    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
        //integer就是我们实体类得值，跟我们定义注解时指定得值作比较，如果包含那就返回true，不包含就抛出异常，返回message
        return set.contains(integer);
    }
}

4. 定义自定义异常，方便统一返回指定错误json

package com.atguigu.gulimall.product.exception;

import com.atguigu.common.exception.HttpCode;
import com.atguigu.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;

/*
自定义异常类
 */
@Slf4j
@RestControllerAdvice
public class GulimallExceptionControllerAdvice {
    //自定义实体类字段校验拦截器 （MethodArgumentNotValidException是自定义字段异常类）
    @ExceptionHandler(value = org.springframework.web.bind.MethodArgumentNotValidException.class)
    public R handleVaildException(org.springframework.web.bind.MethodArgumentNotValidException e){
        HashMap<String, String> errMap = new HashMap<>();
        //取方法字段校验有问题得字段集合，一个一个把他们放到map中，返回给前端
        BindingResult bindingResult = e.getBindingResult();
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            errMap.put(fieldError.getField(),fieldError.getDefaultMessage());
        }
        return R.error(HttpCode.FIELD_NONCOMPLIANCE.getCode(),HttpCode.FIELD_NONCOMPLIANCE.getMessage()).put("data",errMap);
    }


    //没有拦截得全部处理
    @ExceptionHandler(value = Exception.class)
    public R handleException(Exception e){
        log.error(e.getMessage(),e.getClass());
        return R.error(HttpCode.UNKNOW_EXCEPTION.getCode(),HttpCode.UNKNOW_EXCEPTION.getMessage());
    }
}

5. 使用@YgqListValue 注解，vals就是指定0，1如果传递进来showStatus是0或者1，那么就校验通过，否则就返回异常给前端，

	@Data
	@TableName("pms_brand")
	public class BrandEntity implements Serializable {
		private static final long serialVersionUID = 1L;
		/**
		 * 显示状态[0-不显示；1-显示]
		 */
		@YgqListValue(vals={0,1})
		private Integer showStatus;
	}

6. controller

    /**
     * 保存
     */
    @RequestMapping("/save")
    //@RequiresPermissions("product:brand:save")
    public R save(@Valid @RequestBody BrandEntity brand){
		brandService.save(brand);
        return R.ok();
    }

7. 结果
   传递3就报错异常，会被我们自定义注解校验
   
   传递0或者1，就通过我能自定义注解校验成功