首页 > 其他分享 >SpringBoot 依赖之Validation

SpringBoot 依赖之Validation

时间:2024-07-28 16:24:31浏览次数:16  
标签:依赖 SpringBoot springframework validation org import Validation public

Validation

Validation
  • 依赖名称: Validation
  • 功能描述: Bean Validation with Hibernate validator.
  • 使用 Hibernate 验证器进行 Bean 验证。
<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

我们在 IntelliJ IDEA 中创建一个 Spring Boot 项目并使用 Validation 依赖来进行数据验证,可以按照以下步骤进行操作:
写在前面,创建项目这一步几乎每个依赖都有相似点,记住一个通吃全关,重点是理解各个依赖的引入和使用方式,再结合自己的业务场景恰如其分的使用它,才是程序员该做的事情。

1. 创建 Spring Boot 项目

  1. 打开 IntelliJ IDEA 并点击 “New Project”

  2. 选择 “Spring Initializr”,然后点击 “Next”

  3. 填写项目的基本信息

    • Group: com.dependencies
    • Artifact: demo
    • Name: validation
    • Description: validation Demo project for Spring Boot
    • Package name: com.dependencies.validation
    • Packaging: Jar
    • Java: 17
  4. 选择依赖

    • Spring Web
    • Validation
  5. 点击 “Next”,然后点击 “Finish”,等待 IDEA 下载依赖并初始化项目。
    在这里插入图片描述

2. 添加 Validation 依赖

pom.xml 文件中添加 Validation 依赖,项目在创建的时候勾选需要的依赖,都会自动生成下面的依赖配置xml:

<properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

3. 创建数据模型类User

创建一个简单的数据模型类 User,并使用注解进行数据验证:

package com.dependencies.validation.model;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

/**
 * @author zhizhou   2024/7/28 15:46
 */
public class User {
    
    @NotNull(message = "id不能为null")
    private Integer id;
    
    @NotBlank(message = "姓名不能为空")
    @Size(min = 2, max = 30, message = "姓名长度必须在2到30个字符之间")
    private String name;
    
    @NotBlank(message = "邮箱不能为空")
    @Email(message = "邮箱格式不正确")
    private String email;
    
    public Integer getId() {
        return id;
    }
    
    public void setId(Integer id) {
        this.id = id;
    }
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    public String getEmail() {
        return email;
    }
    
    public void setEmail(String email) {
        this.email = email;
    }
}

4. 创建控制器类UserController

创建一个控制器类 UserController,处理 HTTP 请求并进行数据验证:

package com.dependencies.validation.controller;

import com.dependencies.validation.model.User;
import jakarta.validation.Valid;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

/**
 * @author zhizhou   2024/7/28 15:45
 */
@RestController
@RequestMapping("/users")
@Validated
public class UserController {
    
    @PostMapping
    public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
        //这里通常你可以定制逻辑 保存用户信息导数据库 咱就不延展了 重点看validation功能
        return ResponseEntity.ok("User is valid");
    }
    
    @GetMapping("/{id}")
    public ResponseEntity<User> getUser(@PathVariable @Min(119) Integer id) {
        // 这里咱们就下发一个demo数据好了
        User user = new User();
        user.setId(id);
        user.setName("ZhiZhou");
        user.setEmail("[email protected]");
        return ResponseEntity.ok(user);
    }
}

5. 全局异常处理 GlobalExceptionHandler

为了处理验证错误并返回友好的错误信息,可以创建一个全局异常处理类:

package com.dependencies.validation.exception;

import jakarta.validation.ConstraintViolationException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

/**
 * @author zhizhou   2024/7/28 15:51
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
    
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException e) {
        Map<String, String> errors = new HashMap<>();
        e.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
    
    @ExceptionHandler(ConstraintViolationException.class)
    public ResponseEntity<Map<String, String>> handleConstraintViolationException(ConstraintViolationException e) {
        Map<String, String> errors = new HashMap<>();
        e.getConstraintViolations().forEach(violation -> {
            String fieldName = violation.getPropertyPath().toString();
            String errorMessage = violation.getMessage();
            errors.put(fieldName, errorMessage);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
}

6. 启动项目

在 IntelliJ IDEA 中,右键点击主类(通常是带有 @SpringBootApplication 注解的类),选择 “Run”“Debug”。项目启动后,可以使用 Postman 或 curl 进行 HTTP 请求测试,验证数据验证功能。

示例请求

创建用户

在这里插入图片描述
在这里插入图片描述
校验注解@Validated 和 @Min的实际执行效果,对于代码管理也是很不错的实践方式。
在这里插入图片描述

通过上述步骤,我们可以在 IDEA 中成功创建一个 Spring Boot 项目,并且使用 Validation 依赖进行数据验证。Validation 依赖简化了数据验证逻辑,并提供了强大的验证功能,适合各种数据验证场景。

标签:依赖,SpringBoot,springframework,validation,org,import,Validation,public
From: https://blog.csdn.net/ahauedu/article/details/140752164

相关文章

  • 如何在 FastAPI 中间件中以不同方式捕获或处理 RequestValidationError 异常?
    如何正确组合RequestValidationError异常处理程序,如:@app.exception_handler(RequestValidationError)asyncdefvalidation_exception_handler(request,exc):response=prepare_response({},g_ERROR__INCORRECT_PARAMS)returnJSONResponse(content=re......
  • 简易版:在 SpringBoot 中设计一个订单号生成系统
     ​博客主页:   南来_北往系列专栏:SpringBoot实战引言要在SpringBoot中设计一个订单号生成系统,你可以按照以下步骤进行:创建一个SpringBoot项目,添加必要的依赖,如spring-boot-starter-web。创建一个订单号生成器类,实现订单号的生成逻辑。可以使用时间戳、随机数......
  • 微信小程序图书馆座位预约管理系统(SpringBoot后端+Vue管理端)附项目源码与配套文档
    目的和意义微信小程序图书馆座位预约管理系统可以对微信小程序图书馆座位预约管理系统信息进行集中管理,可以真正避免传统管理的缺陷。微信小程序图书馆座位预约管理系统是一款运用软件开发技术设计实现的应用系统,在信息处理上可以达到快速的目的,不管是针对数据添加,数据维护和......
  • SpringBoot+Vue电影院售票系统 - 附源码与配套文档
    1.1 研究背景随着互联网技术的迅速发展和普及,人们的生活方式发生了深刻变革,对于文化娱乐消费的需求日益增长,而作为文化消费重要组成部分的电影行业也迎来了前所未有的发展机遇。然而,传统的电影院售票模式,如现场购票、电话预定等,已难以满足现代消费者对便捷性、灵活性和个性......
  • 深入剖析循环依赖产生与解决的原理前戏
    深入剖析循环依赖产生与解决的原理前戏方式一:通过构造函数方式进行注入创建两个类:packagecom.coding.spring.practies;publicclassTestCircularBeanA{ privateTestCircularBeanBtestCircularBeanB; publicTestCircularBeanA(TestCircularBeanBtestCircularBeanB)......
  • ECCV 2024|是真看到了,还是以为自己看到了?多模态大模型对文本预训练知识的过度依赖该解
    随着大型语言模型(LLMs)的进步,多模态大型语言模型(MLLMs)迅速发展。它们使用预训练的视觉编码器处理图像,并将图像与文本信息一同作为Token嵌入输入至LLMs,从而扩展了模型处理图像输入的对话能力。这种能力的提升为自动驾驶和医疗助手等多种潜在应用领域带来了可能性。点击访问......
  • 毕业设计:基于Springboot的在线小说阅读平台【代码+论文+PPT】
    全文内容包括:1、采用技术;2、系统功能;3、系统截图;4、配套内容。索取方式见文末微信号,欢迎关注收藏!一、采用技术语言:Java1.8框架:SpringBoot数据库:MySQL5.7、8.0开发工具:IntelliJIDEA旗舰版其他:Maven3.8以上二、系统功能会员管理:负责用户注册、登录、会员等级划分及用户信......
  • 字段已填满,但我仍然收到 ValidationError
    我想使用User.objects.create_user和表单Utilisateurs的字段来创建用户。图像和用户名字段也用于填充模型UserProfile.views.py:defsign_in(request):form=Utilisateur(request.GET)ifrequest.method=="POST":form=Utilis......
  • 【免费领源码】Java/Mysql数据库+springboot驾校预约管理系统 25540,计算机毕业设计项
    摘 要随着科学技术的飞速发展,各行各业都在努力与现代先进技术接轨,通过科技手段提高自身的优势;对于驾校预约管理系统当然也不能排除在外,随着网络技术的不断成熟,带动了驾校预约管理系统,它彻底改变了过去传统的管理方式,不仅使服务管理难度变低了,还提升了管理的灵活性。这种......
  • 基于SpringBoot+Vue的二手手机交易平台的详细设计和实现(源码+lw+部署文档+讲解等)
    文章目录前言详细视频演示项目运行截图技术框架后端采用SpringBoot框架前端框架Vue可行性分析系统测试系统测试的目的系统功能测试数据库表设计代码参考数据库脚本为什么选择我?获取源码前言......