使用Spring Validation实现数据校验详解

🕗 发布于 2024-11-06 11:57 spring boot validated 校验

前言

在现代Web应用开发中，数据校验是不可忽视的重要环节。Spring提供了强大的数据校验框架——Spring Validation，可以有效提升数据输入的安全性与应用的稳定性。本文将介绍如何使用Spring Validation进行数据校验，从依赖引入、注解使用到完整示例，帮助您深入理解和灵活应用这一技术。
在这里插入图片描述

1. Spring Validation概述

数据校验是保证应用程序数据安全和稳定运行的基础。Spring Validation基于Java Bean Validation框架，实现了灵活且便捷的校验机制。通过一系列注解，我们可以轻松地对数据进行格式、长度、范围等校验，同时减少冗余代码，提升代码的可维护性。
在这里插入图片描述

2. 配置Spring Validation

要在Spring Boot项目中启用Spring Validation，需要进行依赖引入和基本配置。

2.1 引入依赖

在Spring Boot项目中，可以通过spring-boot-starter-validation依赖包来实现数据校验功能。该依赖包含了Bean Validation API和Hibernate Validator，后者是最常用的Bean Validation实现。

在pom.xml文件中添加以下依赖：

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

引入依赖后，Spring Boot会自动配置Validation功能。

2.2 启用全局校验

Spring Validation可以在多个层次进行应用：控制器层、服务层和数据层。通常推荐在控制器层对数据进行校验，以尽早发现错误并返回用户友好的提示信息。要启用校验功能，可以在控制器类上使用@Validated注解。

例如，在控制器类上添加如下代码：

@RestController
@Validated
public class UserController {
    // 控制器逻辑
}

添加@Validated注解后，控制器方法中的参数就可以被校验框架识别和处理。

3. 使用注解进行参数校验

Spring Validation支持多种校验注解，如@NotNull、@Size、@Pattern等。这些注解可以直接应用于控制器方法参数、请求体中的字段或实体类的属性上，确保数据符合预期格式。

3.1 基本校验注解

以下是常用的校验注解介绍：

@NotNull：确保字段不为空。例如，用户注册时用户名不能为空。
@Size：限制字符串、数组等集合的长度或数量。例如，密码长度限制在8到20个字符之间。
@Pattern：通过正则表达式校验字段格式。例如，验证邮箱格式、手机号格式等。

3.2 使用@Pattern进行正则校验

@Pattern注解通过正则表达式来校验字段的格式，可以用于校验手机号、邮箱、密码复杂性等场景。以下是一个使用@Pattern校验手机号格式的示例：

public class User {

    @Pattern(regexp = "^1[3-9]\\d{9}$", message = "手机号格式不正确")
    private String phoneNumber;

    // 其他字段和方法
}

在此示例中，regexp属性指定了手机号的正则表达式，而message属性定义了校验失败时返回的提示信息。

3.3 综合示例

在用户注册表单中，通常会涉及多个字段的校验需求。以下代码演示了如何在User类中综合应用多个校验注解：

public class User {

    @NotNull(message = "用户名不能为空")
    private String username;

    @Size(min = 8, max = 20, message = "密码长度应在8到20位之间")
    private String password;

    @Pattern(regexp = "^1[3-9]\\d{9}$", message = "手机号格式不正确")
    private String phoneNumber;

    @Email(message = "邮箱格式不正确")
    private String email;

    // Getters和Setters方法
}

在此类中，username不能为空，password长度必须符合要求，phoneNumber必须符合手机号格式，而email则必须是合法的邮箱地址。

4. 在控制器层应用校验

在实际开发中，我们通常在控制器层对数据进行校验，以便在接收请求时进行参数检查并及时返回校验错误信息。要实现这一点，可以使用@Valid或@Validated注解配合@RequestBody`注解进行参数绑定和校验。

4.1 方法参数校验

在控制器方法中，可以直接将需要校验的对象作为参数，并添加@Valid注解。当请求中的数据不符合约定的格式时，Spring会自动抛出MethodArgumentNotValidException异常。

@PostMapping("/register")
public ResponseEntity<String> registerUser(@Valid @RequestBody User user) {
    // 注册逻辑
    return ResponseEntity.ok("注册成功");
}

当校验不通过时，Spring会将校验错误自动包装在BindingResult中，我们可以通过捕获这些错误来返回具体的错误信息。

4.2 自定义错误处理

可以通过编写一个全局异常处理器来处理校验失败的情况。下面是一个示例，展示了如何在控制器层捕获并处理校验异常：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return ResponseEntity.badRequest().body(errors);
    }
}

此全局异常处理器捕获了MethodArgumentNotValidException异常，并将每个字段的错误信息返回给前端，以便用户及时进行修改。

5. 高级应用：自定义校验注解

Spring Validation还支持自定义校验注解，用于实现更复杂或个性化的校验需求。自定义注解通常包括三个部分：注解定义、校验器类和注解应用。

5.1 定义自定义注解

例如，我们可以定义一个校验年龄的注解@ValidAge，确保用户年龄在18至60岁之间：

@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = AgeValidator.class)
public @interface ValidAge {
    String message() default "年龄必须在18至60岁之间";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

5.2 创建校验器

校验器实现ConstraintValidator接口，在isValid方法中定义具体的校验逻辑：

public class AgeValidator implements ConstraintValidator<ValidAge, Integer> {

    @Override
    public void initialize(ValidAge constraintAnnotation) {
    }

    @Override
    public boolean isValid(Integer age, ConstraintValidatorContext context) {
        return age != null && age >= 18 && age <= 60;
    }
}

5.3 使用自定义注解

在User类中，可以通过@ValidAge注解来校验用户的年龄是否符合要求：

public class User {

    @ValidAge
    private Integer age;

    // 其他字段和方法
}

6. 总结

Spring Validation提供了灵活、丰富的校验机制，适用于数据输入安全要求较高的场景。在本文中，我们详细介绍了Spring Validation的配置、注解使用和自定义注解的实现。通过结合实际应用示例，您可以根据需求灵活调整校验规则，为用户提供更加安全友好的数据交互体验。

Spring Validation不仅能减少手动校验代码量，提升应用安全性，还能通过简洁的注解语法提高代码的可读性和可维护性。在实际开发中，掌握并灵活使用Spring Validation将为您的项目带来更高的开发效率和更好的用户体验。

原文地址：https://blog.csdn.net/cooldream2009/article/details/143514668

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：Go 语言的错误处理
下一篇：phpstudy 使用php8.2.9版本报错问题

【青牛科技】GC4931P替代A4931/Allegro在水泵、筋膜枪、吸尘器和电动工具中的应用
随着电动设备技术的不断发展，对电机驱动控制器的需求也在不断增加。GC4931P作为一种新型的电机驱动控制器，逐渐被视为A4931/Allegro的替代品。本文将探讨GC4931P在水泵、筋膜枪、吸尘器
阅读更多2024-11-06
软件测试：测试用例详解
一般是数字和字符组合成的字符串，可以包括（下划线、单词缩写、数字等等），但是需要注意的是，尽量不要写汉语拼音，因为拼音的意义可能有好几种，有可能会导致乱码；
阅读更多2024-11-06
通过自然语言表达你的想法。GitHub Spark让任何人都能使用人工智能，为自己创建软件...
我们能否让任何人都能使用人工智能，为自己创建软件？尽管开发者喜欢定制自己的开发环境以提高效率和趣味性，但创建个性化应用程序的复杂性常常阻止他们这样做。如何使个性化软件的创建变得像定制开发环境一样简单?
阅读更多2024-11-06
好看的超清4K视频素材去哪儿找？下载素材资源网站推荐
这个网站的视频素材有详细介绍，包括4K和1080P的标识，且许多素材都可以通过网盘直接下载，特别适合新手创作者。在这个高清、4K视频盛行的时代，要制作出让人眼前一亮的视频内容，超清4K视频素材必不可少
阅读更多2024-11-06
QML项目实战：自定义TextField
1.activeFocusOnPress ：当用户点击 TextField 时，自动将焦点设置到该控件上。2.antialiasing：启用抗锯齿功能，使文本显示更加平滑。3.readOnly：将
阅读更多2024-11-06
架构学习第四周--高可用与NoSQL数据库
负载均衡（），简称LB，是一种服务或基于硬件设备等实现的高可用反向代理技术，负载均衡将特定的业务(web服务、网络流量等分担给指定的一个或多个后端特定的服务器或设备，从而提高了公司业务的并发处理能力、
阅读更多2024-11-06
函数对象笔记
将函数指针传入compare时，编译器并不知道函数是什么。代码中使用C++中的模板，调用使用函数指针调用函数。指向一个函数的指针，可以动态调用不同的函数。，可以如同函数一样被调用。
阅读更多2024-11-06
【Unity基础】粒子系统与VFX Graph的区别
本文介绍了Unity中粒子系统与VFX Graph之间的区别
阅读更多2024-11-06
动态ip如何自动更换ip
在探讨如何自动更换动态IP地址时，我们首先需要理解动态IP的基本概念。IP地址，即互联网协议地址，分配给每台连接到互联网的设备的唯一标识符。与传统静态IP地址不同，动态IP地址是由网络服务提供商（IS
阅读更多2024-11-06
知识课堂——高匿ip在不同业务中的重要作用
高匿IP在网络数据采集、网络营销与推广、在线游戏以及隐私保护与安全等业务中都有着重要的作用。
阅读更多2024-11-06