SpringBoot整合Spring Validator

背景

在前台表单验证的时候，通常会校验一些数据的可行性，比如是否为空，长度，身份证，邮箱等等，那么这样是否是安全的呢，答案是否定的。因为也可以通过模拟前台请求等工具来直接提交到后台，比如postman这样的工具，那么遇到这样的问题怎么办呢，我们可以在后台也做相应的校验。后台就是校验数据的最后一道防线

环境

• ideaIU-2019.1

• Maven

• SpringBoot框架

步骤

1.pom.xml文件

SpringBoot框架真的是太方便了，只要引入了web-start的依赖，其内就包含着**Spring Validator**的依赖，我们可以直接上手应用，不必再去加什么配置之类的

在pom.xml文件中加入web-start的依赖，代码如下：

    <!--web依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

2.创造实体类

@Data
public class User implements Serializable {
    private BigInteger id;
    @JsonIgnore
    @Length(min = 6,max = 20,message = "密码长度必须在6~20个字符之间")
    private String password;

    @Length(min = 6,max = 20,message = "名称长度必须在6~20个字符之间")
    private String username;

    @Pattern(regexp = "^1(3|4|5|7|8)\\d{9}$",message = "手机号格式不正确")
    private String phone;
    @Pattern(regexp = "\\w+(\\.\\w)*@\\w+(\\.\\w{2,3}){1,3}",message = "邮箱格式不正确")
    private String email;
    private String created;
    private String  updated;
}

在这顺便普及一个小知识点，大家都看的出来，我这个类里没有get，set方法，也没有构造方法和toString方法，那是因为我在IDEA中用了lomobk插件，这极大的简化了开发人员写的臃肿代码，这是我总结lomobk的另一篇文章，有兴趣的可以看一下

Java应用Lombok（IDEA版）

言归正传，回到我们的主题，构造完实体类后，在想验证的属性上使用注解来标注这是我前台数据需要验证的成员属性，如：

 @Length(min = 6,max = 20,message = "密码长度必须在6~20个字符之间")
 //匹配正则表达式
 @Pattern(regexp = "^1(3|4|5|7|8)\\d{9}$",message = "手机号格式不正确")

基本的校验规则

空检查

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

布尔检查

• @AssertTrue 验证 Boolean 对象是否为 true
• @AssertFalse 验证 Boolean 对象是否为 false

日期检查

• @Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期
• @Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期

正则检查

• @Pattern 验证String对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式
  • regexp：正则表达式
  • flags：指定Pattern.Flag的数组，表示正则表达式的相关选项

数值检查

注意： 建议使用在String,Integer类型，不建议使用在 int 类型上，因为表单值为“”时无法转换为int但可以转换为String为“”，Integer 为 null

• @Min 验证 Number 和 String 对象是否大等于指定的值
• @Max 验证 Number 和 String 对象是否小等于指定的值
• @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示 .小数 存在精度
• @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示 .小数 存在精度
• @Digits 验证 Number 和 String 的构成是否合法
• @Digits(integer=,fraction=)验证字符串是否是符合指定格式的数字,integer指定整数精度，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.编写Contorller层

//提交用户表单
    @PostMapping("/save")
    public String save(@Valid User user, BindingResult result, Model model, RedirectAttributes redirectAttributes){   //因为需要重定向,所以这里不能使用Model,只能使用RedirectAttributes

        BaseResult baseResult = userService.save(user,result);

        //保存成功
        if (baseResult.getStatus() == 200){

            redirectAttributes.addFlashAttribute("baseResult",baseResult);

            return "redirect:/user/getAll";
        }

        //保存失败
        else{

            model.addAttribute("baseResult",baseResult);
            return "user/userForm";
        }

    }

我这个代码是先写了一个Server层，然后Contorller层调用了Server层的方法，大家在写的时候可以不用写Server层，直接在Controller层编写，这是我Server层的代码：

public BaseResult save(@Valid User user, BindingResult result){

        //验证不通过
        if (result.hasErrors()){
            return BaseResult.fail(result.getFieldError().getDefaultMessage());
        }
        //验证通过
        else{
            Date date = new Date();
            SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        ...
        ...
        }
    }

我是之前还自己写了一个BaseResult类，用于存放验证后的结果返回前台显示，我把它们放到这主要是为了自己以后复习时好找，大家可以不用看上面的代码，直接在Controller写就行了。

@GetMapping("/save")
    public String validator(@Valid ClassRoom classRoom, BindingResult result,Model model) {
    //验证有错误
        if (result.hasErrors()) {
           model.addAttribute("error",result.getFieldError().getDefaultMessage()); 
            return "user/userForm";
        }
        
        //验证通过
        return "redirect:/user/getAll";
    }

就是这么简单易上手，这是我输入错误后的的验证界面

完结散花。。。。。。。。。。。。。。。。