【学习笔记】后端表单验证JSR303

概况

在处理后端的业务逻辑是常常会涉及表单数据的提交请求，我们不仅在前端对数据进行验证，而且在后端也需要对数据进行验证，以此来保证数据的完整性，而后端对于表单数据的验证使用的最多的莫过于JSR303。

你能get到的知识点？

1、表单验证的使用
2、由于表单验证引起的异常捕获

1、引入依赖

使用JSR303，我们需要引入依赖，一般来说我们只需要引入javax.validation即可，但是对于一些javax.validation无法验证的（例如URL）我们就需要引入hibernate来进行验证了。

 <dependency>
     <groupId>javax.validation</groupId>
     <artifactId>validation-api</artifactId>
     <version>2.0.1.Final</version>
 </dependency>
 <dependency>
     <groupId>org.hibernate</groupId>
     <artifactId>hibernate-validator</artifactId>
     <version>6.0.18.Final</version>
     <scope>compile</scope>
 </dependency>

2、自定义验证规则

自定义验证规则，最方便的莫过于使用注解的方式对我们的bean进行验证，并且可以返回我们自己定义的返回消息。

JSR注释：

• @NotNull –验证带注释的属性值不为 null
• @AssertTrue –验证带注释的属性值为 true
• @Size –验证带注释的属性值的大小介于属性 min和 max之间；可以应用于 String， Collection， Map和数组属性
• @Min – v验证带注释的属性的值不小于 value属性
• @Max –验证带注释的属性的值不大于 value属性
• @Email –验证带注释的属性是有效的电子邮件地址
  一些注释接受其他属性，但是message属性是所有这些属性共有的。这是通常在相应属性的值未通过验证时呈现的消息。

在JSR中可以找到一些其他注释：

• @NotEmpty –验证属性不为null或为空；可以应用于 String， Collection， Map或 Array值
• @NotBlank –只能应用于文本值，并验证该属性不是null还是空格
• @Positive和 @PositiveOrZero –适用于数值并验证其严格为正，或包含0的正数
• @Negative和 @NegativeOrZero –适用于数字值并验证其严格为负数，或包含0的负数
• @Past和 @PastOrPresent –验证日期值是过去还是现在（包括现在）；可以应用于日期类型，包括Java 8中添加的日期类型
• @Future和@FutureOrPresent –验证日期值是将来的日期还是将来的日期（包括现在）

@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id
	 */
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotEmpty(message = "品牌名不能为空")
	private String name;
	/**
	 * 品牌logo地址
	 */
	@URL(message = "必须是一个合法的地址")
	private String logo;
	/**
	 * 介绍
	 */
	@NotEmpty(message = "介绍不能为空")
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty(message = "检索首字母不能为空")
	@Pattern(regexp = "/^[a-zA-Z]$/",message = "检索必须是一个字母")
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull(message = "排序不能为空")
	@Min(value = 0,message = "排序的数必须大于等于零")
	private Integer sort;

}

3、校验捕获异常错误

第一种：controller捕获

在对bean进行验证后，我们需要捕获我们的验证结果。

1. @Valid：首先使用@Valid 为验证级联标记属性、方法参数或方法返回类型。也就是说我们使用这个注解后验证才生效。
2. BindingResult：在验证的bean后紧跟BindingResult，用于获取我们的验证结果，使用result.hasErrors()判断是否有异常，使用 result.getFieldErrors()获取验证后的详细数据
3. R：我们常常使用JSon数据来进行前后端的数据发送与接收，这里同理，该R为自定的类，如果你不想写自定义的消息类，你可以直接用JSONObject进行数据的保存。

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

第二种：统一异常捕获

所有的controller制作厂的逻辑处理，我们则需要使用一个统一的controller进行所有异常的捕获

1、正常的控制器处理正常的逻辑
    /**
     * 保存
     */
    @RequestMapping("/save")
    public R save(@Valid @RequestBody BrandEntity brand){
            brandService.save(brand);
            return R.ok();
    }
    
2、编写一个controllerAdvice进行异常统一处理

@RestControllerAdvice("com.lomtom.mall.product.controller")
public class ExceptionController {

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e){
        BindingResult result = e.getBindingResult();
        Map<String,String> map = new LinkedHashMap<>();
        result.getFieldErrors().forEach(item -> {
            String message = item.getDefaultMessage();
            String field = item.getField();
            map.put(field, message);
        });
        return R.error(400, "数据不合法").put("data", map);
    }
}

第三种：统一处理配合枚举

与第二种同理，只是新增枚举统一管理异常的状态码与消息提醒，翻遍代码的修改与查看

1、编写枚举
public enum ExceptionEnum {
    DATA_EXCEPTION(400,"数据不合法");

    private Integer code;
    private String message;

    ExceptionEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }


    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}
2、与第二种唯一不同的是所有的状态码与消息提示交给枚举
return R.error(ExceptionEnum.DATA_EXCEPTION.getCode(), ExceptionEnum.DATA_EXCEPTION.getMessage()).put("data", map);

4、测试

发送请求获取返回，所有的返回结果都一样，只是实现的方式稍有不同而已。

{
    "msg": "数据不合法",
    "code": 400,
    "data": {
        "name": "品牌名不能为空",
        "descript": "介绍不能为空",
        "sort": "排序不能为空",
        "firstLetter": "检索首字母不能为空"
    }
}

关注公众号：博奥思园
还是那句话：你的支持是我前进的最大动力