SpringBoot——服务端数据校验

男娘i 2022-11-09 11:25 211阅读 0赞

`Spring Validator`和`Hibernate Validator`是两套`Validator`，可以混着用，这里我们用`Hibernate Validator`

## 一、添加依赖： ##

添加依赖的时候注意不要添加版本号，比如`<version>7.0.1.Final</version>`，不然你自己加的跟实际使用的`springboot`版本不兼容就不生效了，我一开始就指定了版本号，结果跟我`springboot2.*`的不兼容，虽然没报错，就是数据校验不生效

<dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator</artifactId>
    </dependency>

## 二、测试用例 ##

实体类中，在需要数据校验的字段上通过添加注解的形式来校验的，`message`属性的值是校验不通过的返回信息，也可以几个注解一起使用比如和`@Length(min = 2, max = 20, message = "长度要在2到20之间")` ，具体有哪些常用注解看文章末尾

import javax.validation.constraints.NotBlank;
    import javax.validation.constraints.NotEmpty;
    
    public class UserEntity { 
        @NotBlank(message = "姓名不能为空")
        private String name;
        @NotEmpty(message = "密码不能为空")
        private String password;
    
        public String getName() { 
            return name;
        }
    
        public void setName(String name) { 
            this.name = name;
        }
    
        public String getPassword() { 
            return password;
        }
    
        public void setPassword(String password) { 
            this.password = password;
        }
    }

controller类中的方法里面对应的实体类对象要加`@Validated`注解，不然数据校验不生效，还有要加`BindingResult`对象，因为校验结果是放到BindingResult对象中的

import com.example.mybatis.demo.entity.UserEntity;
    import org.springframework.validation.BindingResult;
    import org.springframework.validation.FieldError;
    import org.springframework.validation.annotation.Validated;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    @RestController
    @RequestMapping("/api")
    public class UserController { 
    
    
        @PostMapping("/getUser")
    
        public Object  getUser(@Validated UserEntity userEntity, BindingResult bindingResult){ 
            try { 
                if(bindingResult.hasErrors()) { 
                    List<FieldError> fieldErrors =
                            bindingResult.getFieldErrors();
                    for (FieldError fieldError : fieldErrors) { 
                        String message = fieldError.getDefaultMessage();
                        String field = fieldError.getField();
                        //这样就可以罗列出有问题的字段和错误提示信息
                        System.out.println(field + ":" + message);
                    }
                }
                return "成功";
            } catch (Exception e) { 
                e.printStackTrace();
                return "失败";
            }
    
        }
    }

**控制台输出：**

![在这里插入图片描述][20210314231615853.png]

**补充:**

如果要在页面上获取报错信息的话，前提是这个页面是在resources下（是前后端分离只能通过接口把值传给前端了），比如`<span th:errors="${userEntity.name}"</span>`  
**注意：**

*  默认情况下，如果校验失败会抛javax.validation.ConstraintViolationException异常，可以用统一异常处理去对这些异常做处理
 *  An Errors/BindingResult argument is expected to be declared  
    immediately after the model attribute

## 三、配置文件来统一配置返回信息 ##

通过配置文件来配置的话就不需要每次修改提示信息都去改代码，然后重新打包部署到生产环境了  
**1、新建配置文件`ValidationMessages.properties`，配置文件名字一定要叫这个，连后缀名也要一样，不然不生效**  
![在这里插入图片描述][20210315214352787.png]

**2、`ValidationMessages.properties`内容如下：key是自己定义的，想取什么名字随你开心，我这边就是类名加字段名了**

userEntity.name="姓名不能为空"
    userEntity.password="密码不能为空"

**3、在实体类中，`message`的值就是配置文件对应的key了**

public class UserEntity { 
        @NotBlank(message = "{userEntity.name}")
        private String name;
        @NotEmpty(message = "{userEntity.password}")
        private String password;
    }

**4、控制台输出：发现输出信息乱码了，原因是`ValidationMessages.properties`配置文件是`ISO-8859-1`编码的**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70]

**5、解决办法**  
打开自己安装的jdk下面的bin目录，我的安装路径是`C:\Program Files\Java\jdk1.8.0_131\bin`，在里面找到`native2ascii.exe`，并且双击打开，输入中文按回车就会出现对应的ISO编码了，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70 1]

将生成的ISO编码复制到配置文件中:

userEntity.name=\u59d3\u540d\u4e0d\u80fd\u4e3a\u7a7a
    userEntity.password=\u5bc6\u7801\u4e0d\u80fd\u4e3a\u7a7a

现在在来看控制台输出：可以看到一切正常了

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70 2]

**6、由于`ValidationMessages.properties`配置文件的内容改成ISO编码的形式，要是时间太久，谁知道这个key对应的中文是什么，总不可能一个个转换成中文看吧。我们可以新建一个`Messages_zh_CN.properties`来存对应的中文，相当于一个中文备注了，配置文件可以自定义命名，我这边就叫`Messages_zh_CN`，这样一打开这个配置文件就可以找到这个key对应的中文了，毕竟key是唯一的**

![在这里插入图片描述][20210315221747355.png]

## 四、controller中其它参数的校验 ##

在控制层加一个`@Validated`，不加是不生效的，然后对要加验证的参数前面加`@NotBlank`就行了

import org.springframework.validation.annotation.Validated;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.validation.ConstraintViolationException;
    import javax.validation.constraints.NotBlank;
    
    @RestController
    @RequestMapping("/api")
    @Validated
    public class UserController { 
    
        @PostMapping("/getUser")
    
        public Object  getUser(@NotBlank(message = "值不能为空") String name){ 
            try { 
    
                return "成功";
            } catch (ConstraintViolationException e) { 
                e.printStackTrace();
                return "失败";
            }
    
        }
    ｝

可以看到控制台抛出了javax.validation.ConstraintViolationException异常，异常的提醒就是你设置的值，但是在方法里面try catch是捕捉不到这个异常的，可以用全局异常的方式来捕捉[**SpringBoot优雅的全局异常处理**][SpringBoot]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70 3]

## 五、跳转页面异常 ##

简单来说，我一开始要访问登陆页面，登陆页面有错误提示信息`<span th:errors="${userEntity.name}"，`但是一开始加载这个页面，这个页面不知道`userEntity.name`是什么。因为直接由PageController跳转过来，但是UserEntity没有在PageController中声明  
![在这里插入图片描述][20210315223613795.png]  
解决办法：  
原先的controller

@Controller
    public class PageController { 
        @RequestMapping("/{page}")
        public String showPage(@PathVariable String page){ 
            return page;
        }
    }

改完之后的controller

@Controller
    public class PageController { 
        @RequestMapping("/{page}")
        public String showPage(@PathVariable String page, UserEntity userEntity){ 
            return page;
        }
    }

在跳转页面的方法中注入一个UserEntity对象，这是由于SpringMVC会将该对象放入到Model中传递，key的名称会使用该对象的驼峰命名规则来命名（驼峰命名规则即使用对象类名并把开头字母小写），和参数名没关系

如果想使用自定义的名称来对Model中的key进行命名，可以使用@ModelAttribute注解，这个注解是把命名的名称在页面里使用

# 六、常用注解 #

**Bean Validation 中内置的 constraint，JSR提供的标准注解**

@Null   被注释的元素必须为 null    
    @NotNull    被注释的元素必须不为 null    
    @AssertTrue     被注释的元素必须为 true    
    @AssertFalse    被注释的元素必须为 false    
    @Min(value)     被注释的元素必须是一个数字，其值必须大于等于指定的最小值    
    @Max(value)     被注释的元素必须是一个数字，其值必须小于等于指定的最大值    
    @DecimalMin(value)  被注释的元素必须是一个数字，其值必须大于等于指定的最小值    
    @DecimalMax(value)  被注释的元素必须是一个数字，其值必须小于等于指定的最大值    
    @Size(max=, min=)   被注释的元素的大小必须在指定的范围内    
    @Digits (integer, fraction)     被注释的元素必须是一个数字，其值必须在可接受的范围内    
    @Past   被注释的元素必须是一个过去的日期    
    @Future     被注释的元素必须是一个将来的日期    
    @Pattern(regex=,flag=)  被注释的元素必须符合指定的正则表达式

**Hibernate Validator提供的校验注解**

@NotBlank(message =)   被注释的字符串的必须非空    
    @Email  被注释的元素必须是电子邮箱地址    
    @Length(min=,max=)  被注释的字符串的大小必须在指定的范围内    
    @NotEmpty   验证字符串非null，且长度必须大于0 用来判断集合    
    @Range(min=,max=,message=)  被注释的元素必须在合适的范围内

[20210314231615853.png]: /images/20221023/3e906aac7a374737acf796a6583362c4.png
[20210315214352787.png]: /images/20221023/1440f10c5fb440b68ad66ca93f23d330.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70]: /images/20221023/3f7474643f7a463cbec50481c2d61467.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70 1]: /images/20221023/43db8be6452b480cadf379f8e885d406.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70 2]: /images/20221023/1290b8736c2b43818ec63234e4864170.png
[20210315221747355.png]: /images/20221023/2ea0457fea29452c89a0b17a572f30cc.png
[SpringBoot]: https://blog.csdn.net/weixin_43085797/article/details/114903198
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA4NTc5Nw_size_16_color_FFFFFF_t_70 3]: /images/20221023/8834db07b6c04535a0f559938ed3c5b8.png
[20210315223613795.png]: /images/20221023/a1c5a24309b3442da8a07d5413c194ee.png