百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 热门文章 > 正文

Spring Boot中如何实现数据校验?(spring boot 数据校验)

bigegpt 2025-02-04 12:50 8 浏览

在 Spring Boot 中实现数据校验通常使用 Spring 的验证框架(如 Hibernate Validator)结合注解来实现。以下是实现数据校验的一般步骤

引入相关依赖

在Spring Boot项目中引入POM相关依赖。

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

创建校验规则

根据需求来创建自己的数据校验规则,如下所示。

public class User {
    
    @NotBlank(message = "用户名不能为空")
    private String username;
    
    @Size(min = 6, max = 20, message = "密码长度必须在6到20之间")
    private String password;
    
    @Email(message = "邮箱格式不正确")
    private String email;
    
    // Getters and setters
}

在控制器中使用数据校验规则

在需要进行数据校验的控制器方法参数前添加 @Valid 注解,Spring Boot 会自动对参数进行校验。

@RestController
@RequestMapping("/users")
@Validated
public class UserController {
    
    @PostMapping("/register")
    public String registerUser(@Valid @RequestBody User user) {
        // 处理注册用户的逻辑
        return "User registered successfully";
    }
}

验证处理结果

校验结果会被自动存储在BindingResult对象中,可以通过判断是否有错误来决定如何处理校验结果。

@RestController
@RequestMapping("/users")
@Validated
public class UserController {
    
    @PostMapping("/register")
    public String registerUser(@Valid @RequestBody User user, BindingResult result) {
        if (result.hasErrors()) {
            StringBuilder errorMessage = new StringBuilder();
            for (FieldError error : result.getFieldErrors()) {
                errorMessage.append(error.getDefaultMessage()).append("\n");
            }
            return errorMessage.toString();
        }
        
        // 处理注册用户的逻辑
        return "User registered successfully";
    }
}

通过以上步骤,我们就可以在 Spring Boot 中实现数据校验了。Spring Boot 会自动根据定义的校验规则进行校验,并将校验结果返回给控制器方法。

自定义数据校验

有时候,我们可能需要自定义校验规则。这时可以通过创建自定义注解和对应的校验器来实现,如下所示。

定义一个自定义校验的注解

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = MyConstraintValidator.class)
public @interface MyConstraint {
    String message() default "自定义校验失败";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

编写注解处理器

public class MyConstraintValidator implements ConstraintValidator<MyConstraint, String> {
    
    @Override
    public void initialize(MyConstraint constraintAnnotation) {
        // 初始化操作
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 自定义校验逻辑,返回 true 表示通过校验,返回 false 表示校验失败
        // 这里假设校验逻辑为字符串长度必须大于等于5
        return value != null && value.length() >= 5;
    }
}

使用自定义注解

public class User {

    @MyConstraint(message = "用户名长度必须大于等于5")
    private String username;

    // other fields and methods
}

这样,就可以使用自定义的校验注解和校验器进行数据校验了。在控制器中使用@Valid注解进行校验时,Spring Boot 会自动调用对应的校验器执行校验逻辑。

利用全局异常处理对接校验规则

在实际应用中,我们可能需要统一处理校验错误,并返回统一格式的错误信息给客户端。可以通过全局异常处理器来实现。

定义一个自定义的全局异常处理器

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BindException.class)
    public ResponseEntity<String> handleBindException(BindException ex) {
        StringBuilder errorMessage = new StringBuilder();
        ex.getFieldErrors().forEach(error -> 
                                    errorMessage.append(error.getDefaultMessage()).append("\n"));
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorMessage.toString());
    }
}

这个全局异常处理器会捕获校验过程中抛出的BindException异常,并将校验错误信息封装成统一格式的响应体返回给客户端。

总结

可以使用 Postman 等工具发送请求并观察响应结果。可以尝试发送一个不符合校验规则的请求,例如用户名长度不足的请求,应该能够收到校验错误的响应。

通过以上步骤,我们实现了在 Spring Boot 中的数据校验功能,并且通过全局异常处理器统一处理了校验错误。这样可以确保输入数据的合法性,提高了应用的健壮性和安全性。

相关推荐

【Docker 新手入门指南】第十章:Dockerfile

Dockerfile是Docker镜像构建的核心配置文件,通过预定义的指令集实现镜像的自动化构建。以下从核心概念、指令详解、最佳实践三方面展开说明,帮助你系统掌握Dockerfile的使用逻...

Windows下最简单的ESP8266_ROTS_ESP-IDF环境搭建与腾讯云SDK编译

前言其实也没啥可说的,只是我感觉ESP-IDF对新手来说很不友好,很容易踩坑,尤其是对业余DIY爱好者搭建环境非常困难,即使有官方文档,或者网上的其他文档,但是还是很容易踩坑,多研究,记住两点就行了,...

python虚拟环境迁移(python虚拟环境conda)

主机A的虚拟环境向主机B迁移。前提条件:主机A和主机B已经安装了virtualenv1.主机A操作如下虚拟环境目录:venv进入虚拟环境:sourcevenv/bin/active(1)记录虚拟环...

Python爬虫进阶教程(二):线程、协程

简介线程线程也叫轻量级进程,它是一个基本的CPU执行单元,也是程序执行过程中的最小单元,由线程ID、程序计数器、寄存器集合和堆栈共同组成。线程的引入减小了程序并发执行时的开销,提高了操作系统的并发性能...

基于网络安全的Docker逃逸(docker)

如何判断当前机器是否为Docker容器环境Metasploit中的checkcontainer模块、(判断是否为虚拟机,checkvm模块)搭配学习教程1.检查根目录下是否存在.dockerenv文...

Python编程语言被纳入浙江高考,小学生都开始学了

今年9月份开始的新学期,浙江省三到九年级信息技术课将同步替换新教材。其中,新初二将新增Python编程课程内容。新高一信息技术编程语言由VB替换为Python,大数据、人工智能、程序设计与算法按照教材...

CentOS 7下安装Python 3.10的完整过程

1.安装相应的编译工具yum-ygroupinstall"Developmenttools"yum-yinstallzlib-develbzip2-develope...

如何在Ubuntu 20.04上部署Odoo 14

Odoo是世界上最受欢迎的多合一商务软件。它提供了一系列业务应用程序,包括CRM,网站,电子商务,计费,会计,制造,仓库,项目管理,库存等等,所有这些都无缝集成在一起。Odoo可以通过几种不同的方式进...

Ubuntu 系统安装 PyTorch 全流程指南

当前环境:Ubuntu22.04,显卡为GeForceRTX3080Ti1、下载显卡驱动驱动网站:https://www.nvidia.com/en-us/drivers/根据自己的显卡型号和...

spark+python环境搭建(python 环境搭建)

最近项目需要用到spark大数据相关技术,周末有空spark环境搭起来...目标spark,python运行环境部署在linux服务器个人通过vscode开发通过远程python解释器执行代码准备...

centos7.9安装最新python-3.11.1(centos安装python环境)

centos7.9安装最新python-3.11.1centos7.9默认安装的是python-2.7.5版本,安全扫描时会有很多漏洞,比如:Python命令注入漏洞(CVE-2015-2010...

Linux系统下,五大步骤安装Python

一、下载Python包网上教程大多是通过官方地址进行下载Python的,但由于国内网络环境问题,会导致下载很慢,所以这里建议通过国内镜像进行下载例如:淘宝镜像http://npm.taobao.or...

centos7上安装python3(centos7安装python3.7.2一键脚本)

centos7上默认安装的是python2,要使用python3则需要自行下载源码编译安装。1.安装依赖yum-ygroupinstall"Developmenttools"...

利用本地数据通过微调方式训练 本地DeepSeek-R1 蒸馏模型

网络上相应的教程基本都基于LLaMA-Factory进行,本文章主要顺着相应的教程一步步实现大模型的微调和训练。训练环境:可自行定义,mac、linux或者window之类的均可以,本文以ma...

【法器篇】天啦噜,库崩了没备份(天啦噜是什么意思?)

背景数据库没有做备份,一天突然由于断电或其他原因导致无法启动了,且设置了innodb_force_recovery=6都无法启动,里面的数据怎么才能恢复出来?本例采用解析建表语句+表空间传输的方式进行...