使用validation库给项目添加数据验证功能

1、引入依赖库

<!--        对于客户端提交表单或者Ajax中的数据，后端的Controller必须先要做验证，
            然后才能使用这些数据。我们使用Validation库。-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2、创建Form类，封装客户端提交的数据（就是你得表单或者AJAX请求或者axios请求等）

首先，要明白这个Form类是干什么的。

他是用来对我们写的controller方法要传入的参数进行数据验证功能的

那么我们就要定义一个Contoller方法：

package com.zhao.controler;

import com.zhao.common.util.R;
import com.zhao.controler.form.ValidationTestForm;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

/**
 * @Author: 
 * @Date: 
 * @Description:
 */
//定义指定，返回的是Json数据
@RestController
//定义 访问的相对路径
@RequestMapping("/swagger")
@Api("Swagger的测试类")
public class SwaggerTestController {

    //定义方法的  访问相对路径
    @PostMapping("/test")
    //APIOperation的注解是在配置Swagger的时候定义的，
    //作用是：当添加了这个注解的方法会被Swagger扫描到
    @ApiOperation("Swagger接口的测试方法带的注解")
    public R swaggerTest(@Valid @RequestBody ValidationTestForm form){
        return R.ok("validationTestFrom表验证过的数据为："+ form.getName());
    }
}

在此声明一下，R对象,这里的R对象做的是数据封装，其实就是返回了标准化的数据（自定义的），可以替换为直接返回String

package com.zhao.common.util;

import org.apache.http.HttpStatus;

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

/**
 * @Author: 
 * @Date: 
 * @Description: 封装Web返回对象
 */
public class R extends HashMap<String, Object> {

    public R() {
        //定义状态码为200
        put("code", HttpStatus.SC_OK);
        //定义消息为成功
        put("msg", "success");
    }
    // 重写父类HashMap的put方法，实现链式调用put方法
    public R put(String key, Object value) {
        super.put(key, value);//这里调用的是父类HashMap的put方法
        return this;
    }
    //定义常用Web数据返回类型
    public static R ok() {
        //此时返回的R对象包括code和msg
        return new R();
    }
    //自定义消息信息(通过传入的参数）
    public static R ok(String msg) {
        R r = new R();
        r.put("msg", msg);
        return r;
    }
    //向对象中传入map集合
    public static R ok(Map<String, Object> map) {
        R r = new R();
        r.putAll(map);
        return r;
    }
    public static R error(int code, String msg) {
        R r = new R();
        r.put("code", code);
        r.put("msg", msg);
        return r;
    }
    // 此时返回的错误为500错误， 但是错误信息可以自己定义
    public static R error(String msg){
        return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, msg);
    }
    // 500异常，且不知道什么错误，直接返回error
    public static R error() {
        return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, "抱歉，这是未知异常，请联系管理员！");
    }

}

重点看：

public R swaggerTest(@Valid @RequestBody ValidationTestForm form){
        return R.ok("validationTestFrom表验证过的数据为："+ form.getName());
}

这里的参数是使用的ValidationTestForm表验证过的数据。

然后交代**ValidationTestForm.java**的定义如下：

package com.zhao.controler.form;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;

/**
 * @Author: 
 * @Date: 
 * @Description:
 *     validation库在做后端验证的时候，要求必须用封装类（Form类）来保存客户端提交的数据，
 * 然后在封装类中，我们可以定义验证的规则，validation会执行这些规则，帮我们验证客户端提交的数据。
 */

@ApiModel
@Data
//为SwaggerTestController里面的swaggerTest()方法设置一个Form类，接受客户端提交的name数据。
public class ValidationTestForm {
    //作用是name属性不能为空，且不能为空字符串
    @NotBlank
    //匹配所有的简体中文汉字，并且汉字字数要在2-15之间
    @Pattern(regexp = "^[\\u4e00-\\u9fa5]{2,15}$")
    @ApiModelProperty("姓名")
    private String name;
}

3、测试验证结果

1.如果是在浏览器中测试直接：http://localhost:8080/swagger/test?name=赵四
（注意带上参数，并且是中文简体，长度为2-15，才能通过，也可以测试一下不通过，会报400错误）

2.如果用swagger测试就是：

swagger测试首页如下：

点击Try it out 进行测试：

并输入name的值， 即

点击Execute，执行

如果有疑问，已在评论区提出，我们共同探讨问题。

如果有帮助，点个关注，共同进步。