springboot项目后端数据校验jsr303

前言

在项目的开发过程中，保证数据的完整性和规范性是很重要的一个环节，一般的做法是在前端上做一些数据的校验，同时为了保证严谨性，防止有些非法的请求不经过前端，直接通过接口来访问，那同样会引起一些数据的异常，所以在后端同样也要做数据的校验，在这里记录的是使用jsr303来进行对后端表单的校验，通过在参数接收实体类上使用校验注解，并配置统一的异常处理来实现输入数据的校验。

使用方法

1.引入参数校验starter依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2.在接收参数类中的字段上使用预制或者自定义注解

package com.example.springwebdomo.dto;

import lombok.Data;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Data
public class UserDto {
    private Long id;
    @NotNull
    private String name;
    @Email
    private String email;
    @NotEmpty
    private String phone;
    @NotEmpty
    private String address;
    private String remarks;
}

常用的注解：

@Null验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false

长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min and max included.

日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。

数值检查
建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=) 被指定的元素必须在合适的范围内
@Range(min=10000,max=50000,message=”range.bean.wage”)
@Valid递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)

3.使用@ControllerAdvice做统一异常处理，以后还可以在此类中增加其他通用异常的处理，可以根据不同的异常类型设置不同的状态码。

package com.example.springwebdomo.exception;

import com.example.springwebdomo.util.R;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class CommonValidateException {
    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public R validateException(MethodArgumentNotValidException e){
        BindingResult bindingResult=e.getBindingResult();
        Map<String,String> map=new HashMap<>();
        bindingResult.getFieldErrors().forEach(exption->{
            map.put(exption.getField(),exption.getDefaultMessage());

        });
        return R.error(400,"数据校验异常").put("data",map);

    }

    @ExceptionHandler(value = Throwable.class)
    public R error(Throwable throwable){
        return R.error();
    }
}

R对象为统一返回的对象

package com.example.springwebdomo.util;

import java.util.HashMap;
import java.util.Map;

public class R extends HashMap<String, Object> {
    private static final long serialVersionUID = 1L;

    public R() {
        put("code", 0);
        put("msg", "success");
    }

    public static R error() {
        return error(500, "未知异常，请联系管理员");
    }

    public static R error(String msg) {
        return error(500, msg);
    }

    public static R error(int code, String msg) {
        R r = new R();
        r.put("code", code);
        r.put("msg", msg);
        return r;
    }

    public static R ok(String msg) {
        R r = new R();
        r.put("msg", msg);
        return r;
    }

    public static R ok(Map<String, Object> map) {
        R r = new R();
        r.putAll(map);
        return r;
    }

    public static R ok() {
        return new R();
    }

    public R put(String key, Object value) {
        super.put(key, value);
        return this;
    }
}

访问接口，返回格式如下图

 这样一个普通的后端校验就做好了，在正常的业务中，通常是在一个DTO中要区分新增时候的验证和修改时的验证，这时候就需要做分组校验

分组校验

1、定义可能的分组接口，空接口就可以，例如定义新增和修改的分组

package com.example.springwebdomo.exception.validategroup;

public interface AddGroup {
}

package com.example.springwebdomo.exception.validategroup;

public interface ModifyGroup {
}

2、在DTO中指定字段校验的分组类型

package com.example.springwebdomo.dto;

import com.example.springwebdomo.exception.validategroup.AddGroup;
import com.example.springwebdomo.exception.validategroup.ModifyGroup;
import lombok.Data;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Null;

@Data
public class UserDto {
    @NotEmpty(groups = ModifyGroup.class,message = "修改时id不可以为空")
    @Null(groups = AddGroup.class,message = "新增时id可以为空")
    private Long id;
    @NotEmpty(groups = {AddGroup.class,ModifyGroup.class},message = "用户名新增和修改都不能为空")
    private String name;
    @Email
    private String email;
    @NotEmpty
    private String phone;
    @NotEmpty
    private String address;
    private String remarks;
}

3、在controller类中指定方法需要使用哪个校验分组

    @PostMapping("/user/save")
    public ResponseEntity save(@Validated({AddGroup.class}) @RequestBody UserDto userDto){
        userService.save(userDto);
        return ResponseEntity.ok("324");

    }

    @PutMapping("/user/modify")
    public ResponseEntity modify(@Validated({ModifyGroup.class}) @RequestBody UserDto userDto){
        userService.save(userDto);
        return ResponseEntity.ok("324");

    }

 这样就可以在新增和修改时分别实现不同的数据校验了

自定义注解

定义一个校验注解，其中下面三个方法是必须的

  String message() default Constant.ValidationConstant.NUM_ONLY_MSG;

  Class<?>[] groups() default {};

  Class<? extends Payload>[] payload() default {};

用于指定校验类

@Constraint(
        validatedBy = {NumOnlyConstraintValidator.class}
)

注解类：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
// 指定校验器
@Constraint(
        validatedBy = {NumOnlyConstraintValidator.class}
)
public @interface NumOnlyValid {
    String message() default Constant.ValidationConstant.NUM_ONLY_MSG;

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

校验类：需要实现ConstraintValidator接口，两个范型，第一个用于指定校验注解，第二个校验参数的类型，在initialize方法中可以获取到注解中定义的入参，在isValid方法中用于做校验

@Slf4j
public class NumOnlyConstraintValidator implements ConstraintValidator<NumOnlyValid,Object> {
    @Override
    public void initialize(NumOnlyValid constraintAnnotation) {
    }

    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        String pattern= "^(0|[1-9][0-9]*)$";
        boolean isMatch = Pattern.matches(pattern, o.toString());
        return isMatch;
    }
}

之后就可以直接在dto的熟悉中使用改注解了。