Java类属性字段校验（validation的使用）

最新推荐文章于 2024-03-07 19:43:43 发布
最新推荐文章于 2024-03-07 19:43:43 发布
阅读量1.8w 收藏 87
点赞数 23
分类专栏： Java 文章标签： java validation
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/rao991207823/article/details/117001686
版权

Java类属性字段校验（validation的使用）

1、需求来源：日常校验需求

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

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

答案就是下面要介绍的 validation

2、validation介绍

validation 技术在Java中运用最早在2009 年，Java 官方提出了 Bean Validation 规范，而后经历了JSR303、JSR349、JSR380 三次标准的更迭，发展到了 2.0 。

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

2-1、常见的注解

  1. 通常情况下，在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)：被注释的元素必须符合指定的正则表达式。

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

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

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

  3. @Valid和 @Validated

    • @Valid 注解，是 Bean Validation 所定义，可以添加在普通方法、构造方法、方法参数、方法返回、成员变量上，表示它们需要进行约束校验。

    • @Validated 注解，是 Spring Validation 锁定义，可以添加在类、方法参数、普通方法上，表示它们需要进行约束校验。同时，@Validated 有 value 属性，支持分组校验。

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

① 声明式校验：Spring Validation 仅对 @Validated 注解，实现声明式校验。

② 分组校验：Bean Validation 提供的 @Valid注解，因为没有分组校验的属性，所以无法提供分组校验。此时，我们只能使用 @Validated 注解。

③ 嵌套校验：相比来说，@Valid注解的地方，多了【成员变量】。这就导致，如果有嵌套对象的时候，只能使用@Valid注解。

2-2、快速入门

  • 在 pom.xml 文件中，引入相关依赖。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.raos</groupId>
    <artifactId>validation-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <!-- 实现对 Spring MVC 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- lombok依赖（代码简洁处理） -->
		<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>compile</scope>
        </dependency>
        <!-- 单元测试依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

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<String, Object> 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"
}

2、自定义校验注解

虽然 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();
    }
}

2、编写自定义校验实现类

@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;
    }
}

3、model中添加注解：

@Data
public class SysRole {

    private Long roleId;

    @NotBlank(message = "角色名不能为空")
    private String name;

    @NotEmpty(message = "资源列表不能为空")
    @ListNotHaveNull(message = "List 中不能含有null元素")
    @Valid
    private List<String> paths;

}

4、编写前端控制器

    @PostMapping("/addRole")
    public R addRole(@RequestBody @Valid SysRole sysRole) {
        System.out.println("走到这里说明校验成功");
        System.out.println(sysRole);
        return R.ok(R.SUCCESS_MSG);
    }

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

3、通用的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<?>... groups) throws RRException {
        Set<ConstraintViolation<Object>> constraintViolations = validator.validate(object, groups);

        if (!constraintViolations.isEmpty()) {
            Iterator<ConstraintViolation<Object>> iterator = constraintViolations.iterator();
            StringBuilder msg = new StringBuilder();
            while (iterator.hasNext()) {
                ConstraintViolation<Object> constraint = iterator.next();
                msg.append(constraint.getMessage()).append(',');
            }
            throw new RRException(msg.toString().substring(0,msg.toString().lastIndexOf(',')));
        }
    }
}

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

宇枫16
关注
  • 23
    点赞
  • 踩
  • 87
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
springboot使用校验框架validation校验的示例
08-27
Spring Boot 使用 Validation 框架进行数据校验的示例 在 Spring Boot 框架中，使用 Validation 框架来进行数据校验是非常重要的。Validation 框架是 Java EE 6 中的一项子规范，叫做BeanValidation，官方参考实现...
二十七、Springboot整合Validation（验证）
panchang199266的博客
10-14 1万+
（一）常用注解 //开启验证，标注在待验证的Object对象上 @Valid //标注在待验证的字段上 @NotNull @Null @Size @Min @Max （二）具体使用 1、添加依赖 &lt;dependency&gt; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &lt;artifactId&gt...
Java 对list对象进行属性校验
路西法Lucifer
08-06 9235
ps:对list对象进行属性校验。 @Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上 @Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上 user实体类： package com.lucifer.demo.pojo; import lombok.Data; import javax.validation.constraints.N...
@Valid 注解校验提交的List（list 集合） javax.validation.Valid
热门推荐
dxiaol的博客
03-21 3万+
遇到需要直接提交一个list集合的接口需求 不想单独在创建个只有一个list集合pojo 那普通的用反就没法校验了 但是在网上搜到了个方法很好用 本来应该贴一下原链接 但是我一时手贱给页面关了 打开的网页太多 又不好找了。在此给参考的大佬谢罪了。 好了 上代码了 创建ValidList 用@Valid注解里面的list import lombok.Data; import javax...
java的validation框架（参数校验）
weixin_45703155的博客
04-20 7887
*** 自定义手机号注解*///注解的作用目标(可以设置作用在类，方法等等）@Target({ElementType.FIELD }) //注解的保留策略（注解的生命周期) @Retention(RetentionPolicy.RUNTIME) //不同之处：与注解关联的验证器//注解验证不通过时输出的信息String message() default "手机号验证错误";//约束注解在验证时所属的组别Class
JAVA中通过Hibernate-Validation进行参数验证
ywb201314的专栏
05-05 1469
Hibernate-Validation？ Hibernate-Validation是Hibernate框架中一套独立的后端校验框架，用于做参数的验证的；它是JSR303-Bean Validation规范的实现方案。 JSR？ JSR是Java Specification Requests的缩写，意思是Java 规范提案，用于指定java的标准。 Bean Validation？ Bean Validation是JSR中的303规范，用于提供Bean属性的相关校验规则。 Hibernate Vali
解决java接口使用spring-validation验证入参类型为List校验不生效的问题
hkl_Forever的博客
01-03 1762
由于 List 是接口，无法直接用于参数验证，但可以通过实现类重写 List 接口，把此实现类作为校验dto即可。传空值不可以请求，校验已生效。传空值可以请求，无法验证。
Java Validation Api使用方法实例解析
09-07
要使用Java Validation API，首先需要在项目中引入相关的依赖。对于Spring Boot 2项目，由于其内置了此依赖，通常无需额外添加。如果需要手动添加，可以引用如下Maven依赖： ```xml <groupId>javax.validation ...
Spring自带的校验框架Validation的使用实例
08-26
Spring 作为一个流行的 Java 框架，提供了一个内置的校验框架 Validation，用于验证用户输入数据的正确性。在本文中，我们将详细介绍如何使用 Spring 自带的校验框架 Validation 实现实例。 标题解释 本文的标题...
如何使用Spring Validation优雅地校验参数
08-18
然后，在待校验字段上增加校验规则注解，如下所示： ```java public class UserVO { @NotNull(message = "age 不能为空") private Integer age; } ``` 接着，在controller方法中添加@Validated和用于接收错误...
Java Validation Api如何实现自定义注解
09-07
最后，我们可以在需要校验的地方使用自定义的注解，比如在一个DTO类的字段上： ```java import io.swagger.annotations.ApiModelProperty; import lombok.Builder; import lombok.Data; import org.hibernate....
Java自定义校验注解实现List、set集合字段唯一性校验
suiyishiguang的博客
08-04 3063
Java自定义校验注解实现List、set集合字段唯一性校验
java使用Validation进行数据校验
weixin_46759354的博客
04-02 6260
把校验和业务逻辑分离开，让代码编写更加方便。Spring Validation其实就是对Hibernate Validator进一步的封装，方便在Spring中使用。
javax.validation包校验嵌套属性（List对象）的写法
mmdxgj的博客
07-30 6949
目的： 实现List嵌套对象OrgCityConfigRequest的校验 外层： 经尝试@Valid放在List<Obj>前面，List<@Valid Obj> 两种写法都可以校验 @Data @Builder @NoArgsConstructor @AllArgsConstructor public class OrgConfigRequest implements Serializable { @NotBlank(message = "orgCode不可为.
对列表的元素进行验证
最新发布
weixin_61933613的博客
03-07 651
摘要：开发中经常需要校验用户提交的值是否满足要求，@Valid可用于方法参数、返回值的验证，但是对于参数为列表时无效，此处记录几种对列表进行验证的方法
Java：基于注解对类实例字段进行通用校验
江南好
01-01 2709
抽象方法参数model的字段校验代码
Validation 参数校验
ljj19990804的博客
08-24 1264
在开发的过程中，为了确保数据的准确性、可靠性和减少脏数据等，我们时常需要对入参进行校验，以往是通过条件判断去实现参数校验，但是这样费时费力又效果不好，而参数校验对于我们来说是一个非常高效的开发工具。
Java代码简洁-validation参数校验
weixin_43994244的博客
07-09 8600
validation参数校验
Java validation 怎么设置校验指定字段
05-26
可以使用 Java Bean Validation API (JSR 380) 来为特定字段设置校验规则。以下是一些示例代码： 假设我们有一个 User 类，其中包含 name 和 age 两个字段。我们想要在校验时只关注 name 字段。 首先，我们需要在 name 字段上添加注解来指定校验规则。例如，我们可以使用 @NotBlank 注解来确保 name 字段不为空： ``` public class User { @NotBlank(message = "Name cannot be blank") private String name; private int age; // getters and setters } ``` 然后，我们可以在校验时只校验 name 字段，而不是整个 User 对象。可以使用 Validator 实例的 validateProperty 方法来完成此操作： ``` Validator validator = Validation.buildDefaultValidatorFactory().getValidator(); User user = new User(); user.setName(""); user.setAge(20); Set<ConstraintViolation<User>> violations = validator.validateProperty(user, "name"); ``` 在此示例中，我们仅校验了 name 字段，并将结果存储在 ConstraintViolation 对象的集合中。如果 name 字段为空，violations 集合将包含一个 ConstraintViolation 对象，该对象包含有关校验失败的信息。 希望这可以帮助你实现校验指定字段。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值