使用javax.validation.constraints校验参数合法性

简介: 以上就是javax.validation.constraints的基本用法和高级应用。通过掌握这个强大的校验框架,我们可以轻松地为Java项目实现数据校验功能,从而提高代码的健壮性和可维护性。

在Java开发过程中,数据校验是一项至关重要的任务。为了确保数据的完整性和正确性,我们通常需要对输入的数据进行一系列的校验。javax.validation.constraints提供了一套基于注解的校验框架,能够让我们简洁、高效地完成数据校验工作。本文将深入探讨javax.validation.constraints的基本用法和高级应用,帮助读者更好地理解和运用这个强大的校验框架。


基本用法:常用注解

javax.validation.constraints包含了一组基础的校验注解,覆盖了大多数常见的数据校验场景。下面我们逐一介绍这些基本注解:

@NotNull: 用于检查值是否为null。
@NotEmpty: 用于检查字符串、集合、数组等类型是否为空或null。
@Size: 用于检查字符串、集合、数组等类型的元素个数是否在指定的范围内。
@Min: 用于检查数值是否大于等于指定的最小值。
@Max: 用于检查数值是否小于等于指定的最大值。
@DecimalMin: 用于检查数值是否大于等于指定的最小值(可以是浮点数)。
@DecimalMax: 用于检查数值是否小于等于指定的最大值(可以是浮点数)。
@Digits: 用于检查数值是否符合指定的整数位数和小数位数要求。
@Email: 用于检查字符串是否符合电子邮件格式。
@Pattern: 用于检查字符串是否符合指定的正则表达式。
以下是一个简单的示例,展示了如何使用这些基本注解对一个用户实体类进行校验:
import javax.validation.constraints.*;
public class User {
    @NotNull(message = "ID 不能为空")
    private Long id;
    @NotEmpty(message = "用户名不能为空")
    @Size(min = 2, max = 20, message = "用户名长度必须在 2 到 20 个字符之间")
    private String username;
    @Min(value = 18, message = "年龄必须大于等于 18 岁")
    @Max(value = 100, message = "年龄必须小于等于 100 岁")
    private int age;
    @Email(message = "电子邮件格式不正确")
    private String email;
    // Getter and Setter ...
}


高级应用:自定义注解和校验器

尽管javax.validation.constraints提供了丰富的基础注解,但有时我们还需要进行一些特定的校验操作。这时,我们可以通过自定义注解和校验器来实现这些需求。


以下是一个示例,展示了如何创建一个自定义注解@Password,用于检查密码是否符合强度要求(至少包含一个大写字母、一个小写字母和一个数字):


首先,创建自定义注解@Password:

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Documented
@Constraint(validatedBy = PasswordValidator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface Password {
    String message() default "密码必须包含至少一个大写字母、一个小写字母和一个数字";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

然后,创建自定义校验器PasswordValidator:

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class PasswordValidator implements ConstraintValidator<Password, String> {
    private static final String PASSWORD_PATTERN = "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d]{8,}$";
    @Override
    public void initialize(Password constraintAnnotation) {
    }
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return false;
        }
        return value.matches(PASSWORD_PATTERN);
    }


最后,在需要校验的字段上添加自定义注解@Password:

public class User {
    // ... 其他字段
    @Password
    private String password;
    // Getter and Setter ...
}


整合Spring Boot

在Spring Boot项目中,我们可以很方便地整合javax.validation.constraints进行数据校验。首先,需要在项目的pom.xml文件中添加以下依赖:


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>


然后,在Controller方法的参数前添加@Valid注解,即可触发数据校验。当校验失败时,Spring Boot会抛出MethodArgumentNotValidException异常。我们可以通过定义全局异常处理器来捕获该异常,并将校验失败的信息返回给客户端:


import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<String> handleValidationException(MethodArgumentNotValidException exception) {
        StringBuilder message = new StringBuilder();
        exception.getBindingResult().getFieldErrors().forEach(fieldError ->
                message.append(fieldError.getField()).append(": ").append(fieldError.getDefaultMessage()).append("; ")
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(message.toString());
    }
}



以上就是javax.validation.constraints的基本用法和高级应用。通过掌握这个强大的校验框架,我们可以轻松地为Java项目实现数据校验功能,从而提高代码的健壮性和可维护性。

目录
相关文章
|
监控 druid Java
Spring Boot 3 集成 Druid 连接池详解
在现代的Java应用中,使用一个高效可靠的数据源是至关重要的。Druid连接池作为一款强大的数据库连接池,提供了丰富的监控和管理功能,成为很多Java项目的首选。本文将详细介绍如何在Spring Boot 3项目中配置数据源,集成Druid连接池,以实现更高效的数据库连接管理。
13875 2
Spring Boot 3 集成 Druid 连接池详解
|
NoSQL 网络协议 数据库
为什么 Lettuce 会带来更长的故障时间
本文详述了阿里云数据库 Tair/Redis 将使用长连接客户端在非预期故障宕机切换场景下的恢复时间从最初的 900s 降到 120s 再到 30s的优化过程,涉及产品优化,开源产品问题修复等诸多方面。
72281 11
为什么 Lettuce 会带来更长的故障时间
|
消息中间件 NoSQL Java
spring boot2升级boot3指南
本文介绍了如何将Spring Boot 2.x升级至Spring Boot 3.x,涵盖使用OpenRewrite自动化重构工具进行代码转换、依赖版本升级、配置属性调整及常见问题处理等内容,帮助开发者高效完成升级工作。
3148 7
|
11月前
|
监控 Java 测试技术
深度解析@Async注解:从实战应用到底层原理,避坑指南全攻略
本文全面解析Spring框架中@Async注解的使用方法和核心原理。文章首先介绍异步调用的概念与适用场景,然后详细讲解@Async的基础使用方式,包括环境搭建、注解配置和返回值处理。重点阐述了自定义线程池的三种实现方案及参数配置最佳实践,并深入剖析了@Async的底层实现机制和动态代理原理。针对实际开发中的常见问题,文章提供了事务处理、异常捕获、批量任务等进阶解决方案,并通过用户注册案例演示了异步任务的实际应用。
1120 6
|
前端开发 Java 微服务
《深入理解Spring》:Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石,提供IoC、AOP等核心功能;Spring MVC基于其构建,实现Web层MVC架构;Spring Boot则通过自动配置和内嵌服务器,极大简化了开发与部署。三者层层演进,Spring Boot并非替代,而是对前者的高效封装与增强,适用于微服务与快速开发,而深入理解Spring Framework有助于更好驾驭整体技术栈。
|
消息中间件 JSON Java
Spring Boot、Spring Cloud与Spring Cloud Alibaba版本对应关系
Spring Boot、Spring Cloud与Spring Cloud Alibaba版本对应关系
37342 1
|
SQL XML Java
ruoyi若依框架@DataScope注解使用以及碰到的一些问题
ruoyi若依框架@DataScope注解使用以及碰到的一些问题
6501 0
|
监控 Java Nacos
使用Spring Boot集成Nacos
通过上述步骤,Spring Boot应用可以成功集成Nacos,利用Nacos的服务发现和配置管理功能来提升微服务架构的灵活性和可维护性。通过这种集成,开发者可以更高效地管理和部署微服务。
5457 17
|
JSON Java Maven
关于使用Java-JWT的笔记
这篇文章介绍了使用Java-JWT库来生成和验证JSON Web Tokens (JWT) 的方法。文中解释了JWT的组成,包括头部、载荷和签名,并提供了如何使用java-jwt库生成和验证token的示例代码。此外,还提供了Maven依赖和一些关于token的标准声明和自定义声明的解释。
关于使用Java-JWT的笔记
|
XML 前端开发 Java
SpringBoot参数校验@Validated、@Valid(javax.validation)详解
SpringBoot参数校验@Validated、@Valid(javax.validation)
3999 4