谷粒商城 (十八) --------- 商品服务 API 品牌管理 ④ JSR303 后端数据校验

蔚落 2024-04-07 14:10 69阅读 0赞

#### 目录 ####

*  一、JSR303 注解的使用
 *  二、统一的异常处理
 *  三、JSR303 分组校验
 *  四、自定义校验

--------------------

## 一、JSR303 注解的使用 ##

JSR303使用步骤：

1)、给 Bean 添加校验注解：`javax.validation.constraints`，并定义自己的校验提示  
2)、开启校验功能 `@Valid`  
3)、给校验的bean后紧跟一个 BindingResult，就可以获取到校验结果

效果：校验错误以后会有默认的响应

给 name 加上校验注解 `@NotBlank`，作用是限定name至少包含一个非空字符  
![在这里插入图片描述][afe3959ac31c412d867a7c4e50a74858.png]

方法参数列表上加上 `@Valid` 注解表示启用校验  
![在这里插入图片描述][e9fdc409ae31437982513014cab740c5.png]  
自定义错误消息提示：

![在这里插入图片描述][e6c52ed151374b8c9970b2b3cc1a41ff.png]  
BindingResult 属性

![在这里插入图片描述][5128e44a449b447c826caad3cc7ae276.png]

@RequestMapping("/save")
    public R save(@Valid @RequestBody BrandEntity brand, BindingResult result){
        
        Map<String, String> map = new HashMap<>();
        if(result.hasErrors()){
        
            //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();
    }

给 logo 添加上 `@URL` 注解

![在这里插入图片描述][8f7fb4939dc14631a0811b05b99b7811.png]  
自定义校验 `@Pattren`

![在这里插入图片描述][9e144c20bb0240f0b28ab9f785f70437.png]

最小值注解 `@Min`

![在这里插入图片描述][a665a709490446b6845ef9dbe18b89cc.png]

## 二、统一的异常处理 ##

即使用 `@ControllerAdvice` \+ `@ExceptionHandler` 这俩注解

新建异常处理类

![在这里插入图片描述][b74c175609a045ff9ea522b57dd18c31.png]

将 BrandController 中代码注释掉，将错误码作为异常处理

![在这里插入图片描述][a95b746b35da4d7ea6159addd4452fce.png]  
异常处理类

package com.fancy.gulimall.product.exception;
    
    import com.fancy.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.*;
    
    import java.util.HashMap;
    import java.util.Map;
    
    @Slf4j
    @RestControllerAdvice(basePackages = "com.fancy.gulimall.product.controller")
    public class GulimallExceptionControllerAdvice {
        
    
        //精确匹配异常处理
        @ExceptionHandler(value= MethodArgumentNotValidException.class)
        public R handleValidException(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(400, "数据校验出现问题").put("data", errorMap);
        }
        //通用异常处理
        @ExceptionHandler(value = Throwable.class)
        public R handleException(Throwable throwable) {
        
            return R.error();
        }
    
    }

编写错误码枚举

package com.fancy.common.exception;
    
    /***
     * 错误码和错误信息定义类
     * 1. 错误码定义规则为 5 为数字
     * 2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用001:系统未知异常
     * 3. 维护错误码后需要维护错误描述，将他们定义为枚举形式
     * 错误码列表：
     * 10: 通用
     * 001：参数格式校验
     * 11: 商品
     * 12: 订单
     * 13: 购物车
     * 14: 物流
     *
     *
     */
    public enum BizCodeEnum {
        
        
        
        UNKNOWN_EXCEPTION(10000, "系统未知异常"),
        VALID_EXCEPTION(10001, "参数格式校验失败");
        
        
        private int code;
        private String msg;
        
        BizCodeEnum(int code, String msg) {
        
            this.code = code;
            this.msg = msg;
        }
    
        public int getCode() {
        
            return code;
        }
    
        public String getMsg() {
        
            return msg;
        }
    }

我们可以把数据校验码替换成枚举

![在这里插入图片描述][9e28b911cfc14a17b9bd9456eadda320.png]

## 三、JSR303 分组校验 ##

针对新增和修改这两种不同的情况，我们需要进行分组校验

给校验注解上标注什么情况进行校验

![在这里插入图片描述][bf13deeb63e44494814efdba1b0c7d34.png]

在 gulimall-common 中新建 valid 包，新建 AddGroup 与 UpdateGroup 接口

![在这里插入图片描述][084c510c2fda4ca4b0b53ffa34d9cebb.png]  
使用 `@Validated` 注解指定方法参数校验分组，标明执行此方法时哪一注解的校验的生效

![在这里插入图片描述][e49a0e87694248ce9fee4588d7a03188.png]

默认没有指定分组的校验注解`@NotBlank`，在分组校验的情况下不生效，只会在 `@Validated`生效

package com.fancy.gulimall.product.entity;
    
    import com.baomidou.mybatisplus.annotation.TableId;
    import com.baomidou.mybatisplus.annotation.TableName;
    
    import java.io.Serializable;
    import java.util.Date;
    
    import com.fancy.common.valid.AddGroup;
    import com.fancy.common.valid.UpdateGroup;
    import lombok.Data;
    import org.hibernate.validator.constraints.URL;
    
    import javax.validation.constraints.*;
    
    /**
     * 品牌
     * 
     * @author fancy
     * @email 1796952157@qq.com
     * @date 2022-09-02 21:37:22
     */
    @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地址
    	 */
    	@URL(message = "logo必须是一个合法的url", groups={
        AddGroup.class, UpdateGroup.class})
    	@NotEmpty(groups = {
        AddGroup.class})
    	private String logo;
    	/**
    	 * 介绍
    	 */
    	@NotBlank
    	private String descript;
    	/**
    	 * 显示状态[0-不显示；1-显示]
    	 */
    	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;
    
    }

## 四、自定义校验 ##

1、编写自定义校验注解

2、编写自定义校验器

3、关联自定义的校验器和自定义的校验注解

@NotNull(groups = {
        AddGroup.class, UpdateStatusGroup.class})
    @ListValue(vals={
        0, 1}, groups = {
        AddGroup.class, UpdateStatusGroup.class})
    private Integer showStatus;

package com.fancy.common.valid;
    
    import javax.validation.Constraint;
    import javax.validation.Payload;
    import java.lang.annotation.*;
    
    @Documented
    @Constraint(
            validatedBy = {
        ListValueConstraintValidator.class}
    )
    @Target({
        ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface ListValue {
        
        String message() default "{com.fancy.common.valid.ListValue.message}";
    
        Class<?>[] groups() default {
        };
    
        Class<? extends Payload>[] payload() default {
        };
    
        int[] vals() default {
        };
    }

package com.fancy.common.valid;
    
    import javax.validation.ConstraintValidator;
    import javax.validation.ConstraintValidatorContext;
    import java.util.HashSet;
    import java.util.Set;
    
    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) {
        
    
            return set.contains(value);
        }
    }

[afe3959ac31c412d867a7c4e50a74858.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/e6c7ccdfb4ed4afeb45dfb27c3b4ba40.png
[e9fdc409ae31437982513014cab740c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f57d23d7c1be4e40aad61011da64c68b.png
[e6c52ed151374b8c9970b2b3cc1a41ff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f974f3c5cc1b4755b1a027b66f481fe3.png
[5128e44a449b447c826caad3cc7ae276.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/5425ffebffe24ef59e56a90fdf44ca8a.png
[8f7fb4939dc14631a0811b05b99b7811.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/993430da18134e9fb3bf38ec628ffbf9.png
[9e144c20bb0240f0b28ab9f785f70437.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/80bb2a537f8945d5aefd17d47ee82f14.png
[a665a709490446b6845ef9dbe18b89cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/0e482046cb2841f6b70146e9ec034ff3.png
[b74c175609a045ff9ea522b57dd18c31.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/ee67c56671754b48841adfa905ca346d.png
[a95b746b35da4d7ea6159addd4452fce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f10600b205eb4a3fa9fef694a33836da.png
[9e28b911cfc14a17b9bd9456eadda320.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f3a672cb723746db929635b1dec58ffc.png
[bf13deeb63e44494814efdba1b0c7d34.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d8d868ff4475489eaee2f8081685ff4e.png
[084c510c2fda4ca4b0b53ffa34d9cebb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/23c957dfe3be4da2a70280ce304a2969.png
[e49a0e87694248ce9fee4588d7a03188.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/8c2ca272769b4801a34eeb317f0c16c4.png