分布式电商项目二十八：完善品牌管理的添加功能-分组校验

完善品牌管理的添加功能-分组校验

针对不同的请求，不能使用相同的校验规则，例如在添加品牌时，不能携带id信息，应该是系统自动生成，而在修改品牌信息是时，必须要有id才能修改，所以需要添加分组校验的功能。

添加分组注解

由于所有的功能都有分组校验的需求，所以把分组的包放在common模块中，添加三个空接口进行分组：

package com.lastingwar.common.valid;

public interface AddGroup {
}

package com.lastingwar.common.valid;

public interface UpdateGroup {
}

package com.lastingwar.common.valid;

public interface UpdateStatusGroup {
}

之后修改实体类内容：

package com.lastingwar.mall.product.entity;

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

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

import com.lastingwar.common.valid.AddGroup;
import com.lastingwar.common.valid.UpdateGroup;
import com.lastingwar.common.valid.UpdateStatusGroup;
import lombok.Data;
import org.hibernate.validator.constraints.URL;

import javax.validation.constraints.*;

/**
 * 品牌
 *
 * @author yhm
 * @email 403627000@qq.com
 * @date 2020-05-29 16:37:08
 */
@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})

	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;

}

分组标记完成之后，来到controller页面，使用原来的校验注解不能添加分组，所以修改为@Validated({AddGroup.class})注解，如下：

    /**
     * 保存
     */
    @RequestMapping("/save")
    //@RequiresPermissions("product:brand:save")
    public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand ){
		brandService.save(brand);

        return R.ok();
    }

    /**
     * 修改
     */
    @RequestMapping("/update")
    //@RequiresPermissions("product:brand:update")
    public R update(@Validated({UpdateGroup.class}) @RequestBody BrandEntity brand){
		brandService.updateById(brand);

        return R.ok();
    }

注意@Validated({UpdateGroup.class})要求必须把所以需要校验的内容添加进group中，不然默认不校验，如果使用@Validated不添加分组，则没有分组的内容生效（不推荐这样使用）
之后可以输入id信息同时测试save请求和updata请求，可以看出已经分组成功

编写自定义的校验注解

有时候会需要自己编写校验注解，根据规范编写过程如下：（以private Integer showStatus;的值为例子）
一、添加一个ListValue校验注解
参考别的校验注解的编写内容：

首先导入依赖，在common的pom文件中添加：

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

之后创建mall-common/src/main/resources目录下的ValidationMessages.properties 错误信息配置文件，添加对应的错误信息：

com.lastingwar.common.valid.ListValue.message=必须提交指定的值

编写注解
创建文件mall-common/src/main/java/com/lastingwar/common/valid/ListValue.java
内容如下：

package com.lastingwar.common.valid;

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

@Documented
@Constraint(
        validatedBy = {}
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ListValue {
    String message() default "{javax.validation.constraints.ListValue.message}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    int[] vals() default { };
}

校验器
注解的以下位置要求提供校验器，校验器以同样自定义：

创建文件ListValueConstraintValidator，内容如下：

package com.lastingwar.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> {
    //包含0,1的值
    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 判断是否包含在0,1中，
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

之后把校验器添加进注解中：

package com.lastingwar.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.lastingwar.common.valid.ListValue.message}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    int[] vals() default { };
}

测试自定义的校验注解
将UpdateStatusGroup分组添加到controller中：

    /**
     * 修改状态
     */
    @RequestMapping("/update/status")
    //@RequiresPermissions("product:brand:update")
    public R updateStatus(@Validated(UpdateStatusGroup.class) @RequestBody BrandEntity brand){
        brandService.updateById(brand);

        return R.ok();
    }

之后就能在postman中进行测试：


自定义的注解已经起作用了。

tips：这里会使得前端修改显示状态的按钮上出现一个bug，需要修改前端的请求方式
修改brand.vue的方法：

  methods: {
    // 获取数据列表
    updateBrandStatus(data) {
      console.log("最新信息", data);
      let { brandId, showStatus } = data;
      //发送请求修改状态
      this.$http({
        url: this.$http.adornUrl("/product/brand/update/status"),
        method: "post",
        data: this.$http.adornData({ brandId, showStatus }, false)
      }).then(({ data }) => {
        this.$message({
          type: "success",
          message: "状态更新成功"
        });
      });
    },

修改完成之后测试：