后台数据校验和统一异常处理

谁借莪１个温暖的怀抱￠ 2023-02-10 05:21 25阅读 0赞

## 后台数据校验 ##

JSR303

1.  给Bean添加校验注解:javax.validation.constraints，并定义自己的message提示
2.  开启校验功能@Valid ，分组校验使用@Validated （在Controller 的方法参数加）
    
    > 效果：校验错误以后会有默认的响应；
3.  给校验的bean后紧跟一个BindingResult，就可以获取到校验的结果（统一异常处理后，可以不写了）
4.  **分组校验**（多场景的复杂校验）
    
    >  *  @NotBlank(message = “品牌名必须提交”,groups = \{AddGroup.class,UpdateGroup.class\})  
    >     给校验注解标注什么情况需要进行校验
    >  *  @Validated(\{AddGroup.class\})
    >  *  默认没有指定分组的校验注解@NotBlank，在分组校验情况@Validated(\{AddGroup.class\})下不生效，只会在@Validated生效；
5.  **自定义校验**
    
    > 1）、编写一个自定义的校验注解  
    > 2）、编写一个自定义的校验器 ConstraintValidator  
    > 3）、关联自定义的校验器和自定义的校验注解  
    > \* @Documented  
    > \* @Constraint(validatedBy = \{ ListValueConstraintValidator.class【可以指定多个不同的校验器，适配不同类型的校验】 \})  
    > \* @Target(\{ METHOD, FIELD, ANNOTATION\_TYPE, CONSTRUCTOR, PARAMETER, TYPE\_USE \})  
    > \* @Retention(RUNTIME)  
    > \* public @interface ListValue \{

注意分组校验：分组校验类型是一个接口，不需要任何实现：  
如：

public interface AddGroup { 
    }

代码示例：

实体类

@Data
    @TableName("pms_brand")
    public class BrandEntity 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 = "品牌名必须提交",groups = { AddGroup.class,UpdateGroup.class})
    	private String name;
    	/** * 品牌logo地址 */
    	@NotBlank(groups = { AddGroup.class})
    	@URL(message = "logo必须是一个合法的url地址",groups={ AddGroup.class,UpdateGroup.class})
    	private String logo;
    	/** * 介绍 */
    	private String descript;
    	/** * 显示状态[0-不显示；1-显示] */
    // @Pattern()
    	@NotNull(groups = { AddGroup.class, UpdateStatusGroup.class})
      	@ListValue(vals={ 0,1},groups = { AddGroup.class, UpdateStatusGroup.class})
    	private Integer showStatus;
    	/** * 检索首字母 */
    	@NotEmpty(groups={ AddGroup.class})
    	@Pattern(regexp="^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups={ AddGroup.class,UpdateGroup.class})
    	private String firstLetter;
    	/** * 排序 */
    	@NotNull(groups={ AddGroup.class})
    	@Min(value = 0,message = "排序必须大于等于0",groups={ AddGroup.class,UpdateGroup.class})
    	private Integer sort;
    
    }

**Controlller**  
使用注解 `@Valid`  
配合统一异常处理，参数校验错误，会给统一异常处理  
统一异常处理后，BindingResult 就不用写了

/** * 保存 */
        @RequestMapping("/save")
        //@RequiresPermissions("product:brand:save")
        public R save(@Validated({ AddGroup.class}) @RequestBody BrandEntity brand/*,BindingResult result*/){ 
    // if(result.hasErrors()){ 
    // Map<String,String> map = new HashMap<>();
    // //1、获取校验的错误结果
    // result.getFieldErrors().forEach((item)->{ 
    // //FieldError 获取到错误提示
    // String message = item.getDefaultMessage();
    // //获取错误的属性的名字
    // String field = item.getField();
    // map.put(field,message);
    // });
    //
    // return R.error(400,"提交的数据不合法").put("data",map);
    // }else { 
    //
    // }
    
            brandService.save(brand);
    
    
            return R.ok();
        }

### 自定义数据校验 ###

pom 依赖

<dependency>
     	 <groupId>javax.validation</groupId>
         <artifactId>validation-api</artifactId>
         <version>2.0.1.Final</version>
     </dependency>

注解接口编写：

@Documented
    @Constraint(validatedBy = {  ListValueConstraintValidator.class })
    @Target({  METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    public @interface ListValue { 
        String message() default "{com.fyj.common.valid.ListValue.message}";
    
        Class<?>[] groups() default {  };
    
        Class<? extends Payload>[] payload() default {  };
    
        int[] vals() default {  };
    }

ValidationMessages.properties 编写 （注解接口指定的message 信息）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z5ajEzOTI1NDc1OTU3_size_16_color_FFFFFF_t_70]

校验器编写 (必须实现 ConstraintValidator 接口)

public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> { 
    
        private Set<Integer> set = new HashSet<>();
        //初始化方法
        @Override
        public void initialize(ListValue constraintAnnotation) { 
    
            int[] vals = constraintAnnotation.vals();
            for (int val : vals) { 
                set.add(val);
            }
    
        }
    
        //判断是否校验成功
    
        /** * * @param value 需要校验的值 * @param context * @return */
        @Override
        public boolean isValid(Integer value, ConstraintValidatorContext context) { 
    		
    		// 校验，判断set 是否包含提交的value 值
            return set.contains(value);
        }
    }

## 统一异常处理 ##

使用注解`@RestControllerAdvice`

添加一个统一处理异常类：  
代码：

/** * 集中处理所有异常 */
    @Slf4j
    //@ResponseBody
    //@ControllerAdvice(basePackages = "com.fyj.fyjmall.product.controller")
    @RestControllerAdvice(basePackages = "com.fyj.fyjmall.product.controller")
    public class FyjmallExceptionControllerAdvice { 
    
    
        @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);
        }
    
    
        // 处理任意类型的异常
        @ExceptionHandler(value = Throwable.class)
        public R handleException(Throwable throwable){ 
    
            log.error("错误：",throwable);
            return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
        }
    }

错误码定义：

/*** * 错误码和错误信息定义类 * 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;
        }
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z5ajEzOTI1NDc1OTU3_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200520161122718.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z5ajEzOTI1NDc1OTU3,size_16,color_FFFFFF,t_70