【快学springboot】4.接口参数校验

发布时间:『 2019-06-08 00:25:17 』  博客类别:快学springboot  阅读(-1)

前言

在开发接口的时候,参数校验是必不可少的。参数的类型,长度等规则,在开发初期都应该由产品经理或者技术负责人等来约定。如果不对入参做校验,很有可能会因为一些不合法的参数而导致系统出现异常。

上一篇文章讲了多种接受参数的方法【快学springboot】3.多种接受参数的方式。因为目前json类型的参数是最常用的,所以这里只讲解json类型的参数校验。其他类型的大同小异。

新建一个Param.java

public class Param {

private String username;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
}

目前这个类只有一个username属性。

使用Validated注解开启参数校验

@PostMapping(value = "/validate/notblank")
public Object validateNotBlank(@RequestBody @Validated Param param) {
return param;
}

NotBlank 非空判断

修改Param.java,在username属性上添加NotBlank注解

@NotBlank
private String username;

测试

【快学springboot】4.接口参数校验

【快学springboot】4.接口参数校验

通过控制台,我们可以看到抛出了一个MethodArgumentNotValidException异常,上面的返回结果其实是springboot默认的异常捕获器返回的。为了统一接口的数据返回格式,我们也需要自定义一个全局异常拦截器,这个将会在下一讲中讲解。

我们还可以通过NotBlank注解的message属性设置异常信息:

@NotBlank(message = "username不可为空")
private String username;

【快学springboot】4.接口参数校验

Length字符串长度判断

还是那个Param.java,我们给username加上Length注解,如下:

@Length(min = 2,max = 3)
@NotBlank(message = "username不可为空")
private String username;

【快学springboot】4.接口参数校验

同样,我们也可以使用message属性来设置返回错误信息。这里就不演示了。

NotNull 限制属性不可谓null

虽然前面有NotBlank注解了,但是一些Integer,Long等包装类型,还是需要用到NotNull注解来判断。

范围判断Min和Max

在Param.java上新增一个age属性,并且使用Min和Max注解限定大小

@Min(1)
@Max(100)
private Integer age;

这样写的问题是,如果age为空,则不会校验。如下:

【快学springboot】4.接口参数校验

所以我们还需要加上NotNull注解

@Min(1)
@Max(100)
@NotNull
private Integer age;

【快学springboot】4.接口参数校验

【快学springboot】4.接口参数校验

也可使用@Range注解来限定范围

@Range(min = 1, max = 100)

Email 注解校验邮件

@Email
private String email;

【快学springboot】4.接口参数校验

Pattern 注解校验正则表达式

@Pattern(regexp = "\d{4}-\d{2}-\d{2}")
private String birthday;

【快学springboot】4.接口参数校验

总结

以上总结了部分常用的参数校验的方法,当然还有很详细的一些没有列举处理,有需要的,可以自行搜索使用方式即可。参数校验,往往需要和全局的异常拦截器来配套使用,使得返回的数据结构永远是保持一致的,这样才能方便客户端解释。

下一节会对统一返回格式和全局异常拦截器做一个讲解。


上一篇:【快学springboot】5.全局异常捕获,异常流处理业务逻辑

下一篇:【快学springboot】3.多种接受参数的方式


Happyjava的博客

何以解忧?唯有定投!可以是定期投资,也可以是定期学习,不冲突!

个人QQ号: 「1015030682」

联系邮箱: 「happyjava@foxmail.com」

备案号:浙ICP备17032647号-3