Java校验validate介绍和使用实例_Java

java校验validate

日常开发中，我们时常需要提供可靠的 api 接口，此时对于请求的入参就需要校验，以保证最终数据入库的正确性，这就成了必不可少的活。例如说，用户注册时，会校验手机格式的正确性、邮箱格式的正确性、密码非弱密码等。

但是如果使用 if-else 这种代码去校验，那么需要校验的地方有很多情况下，代码量就会变的十分臃肿，若是一个类请求参数校验字段又多的化，相信各位小伙伴对不会开心，这么干肯定不合适，代码也不优雅，那么如何解决这个问题呢？

答案就是下面要介绍的 validation

validation介绍

validation 技术在java中运用最早在2009 年，java 官方提出了 bean validation 规范，而后经历了jsr303、jsr349、jsr380 三次标准的更迭，发展到了 2.0 。

bean validation 和我们以前学习过的 jpa 一样，只提供规范，不提供具体的实现。因此实际使用过程，常用的是 hibernate 的校验组件：org.hibernate.hibernate-validator

常见的注解

通常情况下，在javax.validation.constraints 包下，定义了一系列的约束（constraint）注解，一共 22 个注解，快速略过即可。如下：

空和非空检查

@notblank：只能用于字符串不为 null ，并且字符串 .trim() 以后 length 要大于 0 。
@notempty：集合对象的元素不为 0 ，即集合不为空。
@notnull：不能为 null 。
@null：必须为 null 。

数值检查

@decimalmax(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值。
@decimalmin(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值。
@digits(integer, fraction)：被注释的元素必须是一个数字，其值必须在可接受的范围内。
@positive：判断正数。
@positiveorzero：判断正数或 0 。
@max(value)：该字段的值只能小于或等于该值。
@min(value)：该字段的值只能大于或等于该值。
@negative：判断负数。
@negativeorzero：判断负数或 0 。

boolean 值检查

@assertfalse：被注释的元素必须为 true 。
@asserttrue：被注释的元素必须为 false 。

长度检查

@size(max, min)：检查字段的 size 是否在 min 和 max 之间，可以是字符串、数组、集合、map 等。

日期检查

@future：被注释的元素必须是一个将来的日期。
@futureorpresent：判断日期是否是将来或现在日期。
@past：检查该字段的日期是在过去。
@pastorpresent：判断日期是否是过去或现在日期。

其它检查

@email：被注释的元素必须是电子邮箱地址。
@pattern(value)：被注释的元素必须符合指定的正则表达式。

hibernate validator 附加的约束注解，在org.hibernate.validator.constraints 包下，定义了一系列的约束（constraint）注解。常见的如示。

@range(min=, max=)：被注释的元素必须在合适的范围内。
@length(min=, max=)：被注释的字符串的大小必须在指定的范围内。
@url(protocol=,host=,port=,regexp=,flags=)：被注释的字符串必须是一个有效的 url 。
@safehtml：判断提交的 html 是否安全。例如说，不能包含 javascript 脚本等等。

其他的就不一一列举了，有感兴趣的小伙伴可以去源码包看看。

@valid和 @validated

@valid 注解，是 bean validation 所定义，可以添加在普通方法、构造方法、方法参数、方法返回、成员变量上，表示它们需要进行约束校验。
@validated 注解，是 spring validation 锁定义，可以添加在类、方法参数、普通方法上，表示它们需要进行约束校验。同时，@validated 有 value 属性，支持分组校验。

对于初学者来说，很容易搞混 @valid 和 @validated 注解。

① 声明式校验：spring validation 仅对 @validated 注解，实现声明式校验。
② 分组校验：bean validation 提供的 @valid注解，因为没有分组校验的属性，所以无法提供分组校验。此时，我们只能使用 @validated 注解。
③ 嵌套校验：相比来说，@valid注解的地方，多了【成员变量】。这就导致，如果有嵌套对象的时候，只能使用@valid注解。

spring-boot-starter-web 依赖里，已经默认引入 hibernate-validator 依赖，所以本示例使用的是 hibernate validator 作为 bean validation 的实现框架。

1、简单校验

编写实体类（这里以常用的用户注册为场景）

@data
public class sysuser {
    private long userid;
    /**
     * 账号
     */
    @notblank(message = "用户名不能为空")
    @size(min = 6, message = "用户名长度不能小于6个字符")
    private string username;
    /**
     * 密码
     */
    @notempty(message = "密码不能为空")
    @size(min = 8, message = "密码长度不能小于8个字符")
    private string password;
    /**
     * 手机号
     */
    @notblank(message = "手机号不能为空")
    @size(min = 11, max = 11, message = "手机号长度不对")
    private string mobile;
}

编写前端控制器

@restcontroller
@requestmapping("/user")
public class sysusercontroller {
    @postmapping("/add")
    public r adduser(@requestbody @valid sysuser sysuser) {
        system.out.println("走到这里说明校验成功");
        system.out.println(sysuser);
        return r.ok(r.success_msg);
    }
}

编写前端响应封装实体

public class r extends hashmap<string, object> {
    private static final long serialversionuid = 1l;
    public static final string success_msg = "操作成功！";
    public static final string fail_msg = "操作失败！";
    public r() {
        this.put((string) "code", 0);
    }
    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((string) "code", code); r.put((string) "msg", msg); return r; } public static r ok(string msg) { r r = new r(); r.put((string) "msg", msg); return r; } public static r ok(object object) { r r = new r(); r.put("result", object); return r; } public static r ok(int code, string msg) { r r = new r(); r.put((string) "code", code); r.put((string) "msg", msg); return r; } public static r ok(map&lt;string, object&gt; 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; }

编写自定义异常（用于后续业务抛出异常错误）

public class rrexception extends runtimeexception {

private static final long serialversionuid = 1l;

private string msg;

private int code = 500;

public rrexception(string msg) {

super(msg);

this.msg = msg;

}

public rrexception(string msg, throwable e) {

super(msg, e);

this.msg = msg;

}

public rrexception(string msg, int code) {

super(msg);

this.msg = msg;

this.code = code;

}

public rrexception(string msg, int code, throwable e) {

super(msg, e);

this.msg = msg;

this.code = code;

}

public string getmsg() {

return msg;

}

public void setmsg(string msg) {

this.msg = msg;

}

public int getcode() {

return code;

}

public void setcode(int code) {

this.code = code;

}

}

当访问/user/add这个post接口时，如果参数不符合model中定义的话，程序中就回抛出400异常状态码，并提示错误信息，如下所示。

{
“timestamp”: “2021-05-20t01:08:28.831+0000”,
“status”: 400,
“error”: “bad request”,
“errors”: [
{
“codes”: [ “size.sysuser.mobile”, “size.mobile”, “size.java.lang.string”, “size” ],
“arguments”: [ { “codes”: [ “sysuser.mobile”, “mobile” ], “arguments”: null, “defaultmessage”: “mobile”, “code”: “mobile” },
11,
11
],
“defaultmessage”: “手机号长度不对”,
“objectname”: “sysuser”,
“field”: “mobile”,
“rejectedvalue”: “155833013”,
“bindingfailure”: false,
“code”: “size”
}
],
“message”: “validation failed for object=‘sysuser'. error count: 1”,
“path”: “/user/add”
}

自定义校验注解

虽然 jsr303 和 hibernate validtor 已经提供了很多校验注解，但是当面对复杂参数校验时，还是不能满足我们的要求，这时候我们就需要自定义校验注解。

下面以“list数组中不能含有null元素”为实例自定义校验注解

1、注解定义如示。

@target({elementtype.annotation_type, elementtype.method, elementtype.field})

@retention(runtime)

@documented

@constraint(validatedby = listnothavenullvalidatorimpl.class)//此处指定了注解的实现类

public @interface listnothavenull {

/**

* 添加value属性，可以作为校验时的条件,若不需要，可去掉此处定义

/

int value() default 0;

string message() default “list集合中不能含有null元素”;

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

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

/*

* 定义list，为了让bean的一个属性上可以添加多套规则

*/

@target({method, field, annotation_type, constructor, parameter})

@retention(runtime)

@documented

@interface list {

listnothavenull[] value();

}

}

编写自定义校验实现类

@service
public class listnothavenullvalidatorimpl implements constraintvalidator<listnothavenull, list> {
private int value;
@override
public void initialize(listnothavenull constraintannotation) {
//传入value 值，可以在校验中使用
this.value = constraintannotation.value();
}
public boolean isvalid(list list, constraintvalidatorcontext constraintvalidatorcontext) {
for (object object : list) {
if (object == null) {
//如果list集合中含有null元素，校验失败
return false;
} else if (object instanceof string) {
string value = object.tostring();
if (value.trim().length() == 0){
return false;
}
}
}
return true;
}
}

model中添加注解：

@data
public class sysrole {

private long roleid; @notblank(message = "角色名不能为空") private string name; @notempty(message = "资源列表不能为空") @listnothavenull(message = "list 中不能含有null元素") @valid private list&lt;string&gt; paths;

编写前端控制器

@postmapping(“/addrole”)

public r addrole(@requestbody @valid sysrole sysrole) {

system.out.println(“走到这里说明校验成功”);

system.out.println(sysrole);

return r.ok(r.success_msg);

}

使用方法同 “简单校验”，在在需要校验的model上面加上@valid即可。

通用的validtor校验工具类

public class validatorutils {
private validatorutils() { }

private static validator validator; static { validator = validation.builddefaultvalidatorfactory().getvalidator(); } /** * 校验对象 * * @param object 待校验对象 * @param groups 待校验的组 * @throws rrexception 校验不通过，则报rrexception异常 */ public static void validateentity(object object, class&lt;?&gt;... groups) throws rrexception { set&lt;constraintviolation&lt;object&gt;&gt; constraintviolations = validator.validate(object, groups); if (!constraintviolations.isempty()) { iterator&lt;constraintviolation&lt;object&gt;&gt; iterator = constraintviolations.iterator(); stringbuilder msg = new stringbuilder(); while (iterator.hasnext()) { constraintviolation&lt;object&gt; constraint = iterator.next(); msg.append(constraint.getmessage()).append(','); } throw new rrexception(msg.tostring().substring(0,msg.tostring().lastindexof(','))); } }

使用方式，在接收到前端传递的参数后，使用validatorutils.validateentity(【参数名】);即可校验，支持分组校验，分组需要定义分组接口。