Springboot中的参数校验

最新推荐文章于 2024-06-05 11:53:18 发布
最新推荐文章于 2024-06-05 11:53:18 发布
阅读量284 收藏
点赞数
分类专栏： Springboot 文章标签： spring boot java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45100881/article/details/128648538
版权
该文展示了如何在SpringBoot应用中创建统一的HTTP响应类用于返回状态码和消息，并实现全局异常处理，捕获MethodArgumentNotValidException和ConstraintViolationException，以处理数据验证错误。同时，文章还提到了使用JSR-303进行实体类字段校验的方法。
摘要由CSDN通过智能技术生成

1.定义统一返回

package com.example.demo.config;

import lombok.Data;
import lombok.Getter;
import lombok.Setter;

@Data
@Getter
@Setter
public class HttpResponse {

    private Integer code;
    private String message;

    private HttpResponse(){

    }

    public static HttpResponse ok(){
        HttpResponse httpResponse = new HttpResponse();
        httpResponse.setCode(200);
        httpResponse.setMessage("成功");
        return httpResponse;
    }

    public static HttpResponse error(){
        HttpResponse httpResponse = new HttpResponse();
        httpResponse.setCode(500);
        httpResponse.setMessage("失败");
        return httpResponse;
    }

    public static HttpResponse setCodeAndMessage(Integer code,String message){
        HttpResponse httpResponse = new HttpResponse();
        httpResponse.setCode(code);
        httpResponse.setMessage(message);
        return httpResponse;
    }


}

2.全局异常处理

package com.example.demo.exception;

import com.example.demo.config.HttpResponse;
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;

@RestControllerAdvice
public class BaseExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public HttpResponse handle(MethodArgumentNotValidException e){
        FieldError fieldError = e.getBindingResult().getFieldError();
        return HttpResponse.setCodeAndMessage(500,fieldError.getDefaultMessage());
    }

}

在使用@Valid注解以及其他JSR-303里面的我们需要先导包

3.依赖

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

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

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
            <scope>provided</scope>
        </dependency>

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

4.实体类

package com.example.demo.entity;



import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotNull;
import lombok.Data;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Data
@Getter
@Setter
@ToString
public class Person {

    @NotNull(message = "请输入姓名")
    private String name;
    @Min(value = 22,message = "最小年龄大于等于22")
    @Max(value = 33,message = "最大年龄小于等于33")
    private Integer age;
    @Email(message = "请输入正确的邮箱格式")
    private String email;
}

5.控制层

package com.example.demo.controller;


import com.example.demo.config.HttpResponse;
import com.example.demo.entity.Person;
import jakarta.validation.Valid;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @PostMapping("/person")
    public HttpResponse getMo(@Valid @RequestBody Person person){
        System.out.println(person);
        return HttpResponse.ok();
    }
}

使用@Valid注解作用在实体类上

package com.example.demo.controller;


import com.example.demo.config.HttpResponse;
import com.example.demo.entity.Person;
import jakarta.validation.Valid;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @PostMapping("/person")
    public HttpResponse getMo(@Valid @RequestBody Person person){
        System.out.println(person);
        return HttpResponse.ok();
    }
}

6.校验某个字段

在全局异常处理中添加捕捉ConstraintViolationException异常

package com.example.demo.exception;

import com.example.demo.config.HttpResponse;
import jakarta.validation.ConstraintViolationException;
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;

@RestControllerAdvice
public class BaseExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public HttpResponse handle(MethodArgumentNotValidException e){
        FieldError fieldError = e.getBindingResult().getFieldError();
        return HttpResponse.setCodeAndMessage(500,fieldError.getDefaultMessage());
    }

    @ExceptionHandler(ConstraintViolationException.class)
    public HttpResponse handle1(ConstraintViolationException e){
        return HttpResponse.setCodeAndMessage(500,e.getMessage());
    }

}

controller加上@Validated注解

package com.example.demo.controller;

import com.example.demo.config.HttpResponse;
import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.Size;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Validated
public class MyController {

    @GetMapping("/my/{id}/{name}")
    public HttpResponse myInfo(@Min (value = 1,message = "id大于等于1")@PathVariable("id")Integer id, @Size(min = 5,max = 10,message = "长度在5-10之间") @PathVariable("name")String name){
        System.out.println(name);
        System.out.println(id);
        return HttpResponse.ok();
    }
}
CaoHao0904
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Springboot中参数校验优雅实践
05-26
Springboot中参数校验优雅实践
详解SpringBoot中的参数校验(项目实战)
08-18
主要介绍了SpringBoot中的参数校验,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
数据校验@Validated（解决javax.validation.ConstraintViolationException问题）
weixin_45688486的博客
07-12 6914
数据校验前言正文单个对象一组对象结束 前言 大多数项目中都需要后台对传过来的对象进行校验，比如手机号的位数，特殊字段不能为空等等。之前我们可能都是使用if…else…,今天我们了解一下validated 正文 单个对象 想要使用validated需要引入Jar包，有两个方式，选择一种即可： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-bo
java实现自定义注解校验ConstraintValidator
weixin_46759354的博客
04-02 680
java实现自定义注解校验ConstraintValidator。
SpringBoot接口参数校验（jakarta.validation.constraints）
qq_32954567的博客
05-15 894
接口参数校验
解决javax.validation.ConstraintViolationException
热门推荐
SnowMultiflora的博客
12-29 1万+
错误信息 Caused by: javax.validation.ConstraintViolationException: Validation failed for classes [com.zxw.pojo.Type] during persist time for groups [javax.validation.groups.Default, ] List of constraint...
【Spring6】数据校验：Validation
Chovy_pyc的博客
04-02 960
java spring6 数据校验 validation
java bean验证 Jakarta Validation与hibernate-validator以及spring-boot-starter-validation区别 自定义验证注解
zlpzlpzyd的专栏
04-14 4175
java bean验证 Jakarta Validation与hibernate-validator以及spring-boot-starter-validation区别
SpringBoot中的异常处理与参数校验的方法实现
08-19
主要介绍了SpringBoot中的异常处理与参数校验的方法实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Spring Boot 参数校验的具体实现方式
08-25
在开发过程中，后台的参数校验是必不可少的。通常，我们会看到类似下面的代码，这样写并没有什么错，只是看起来不是很优雅而已。 Validation 在 Spring Boot 的官网中，关于 Validation 只是简单的提了一句。其实...
SpringBoot中通过实现WebMvcConfigurer参数校验的方法示例
08-25
在Spring Boot应用中，参数校验是确保输入数据正确性和安全性的重要步骤。Spring Boot提供了多种方式来进行参数校验，其中包括使用JSR303/JSR349提供的`javax.validation`规范。本文将深入探讨如何通过实现`...
Hutool 实体类验证工具
fendouweiqian的博客
09-22 2049
但是 ValidationUtil 这个在参考文档介绍中没有发现该工具类。Hutool 工具包封装了很多好用的工具。我使用的的Hutool工具类版本如下。必须是 3.0.0 以上的版本。引入Jakarta包。
【SpringBoot系列】如何优雅地校验参数
Venus's Blog
04-30 2910
Slf4j注意：这里必须要加 @Validated@NotNull(message = "id不能为空", groups = {UserUpdateGroup.class})@NotNull(message = "用户名不能为空", groups = {UserCreateGroup.class, UserUpdateGroup.class})@Slf4j根据需求，我们在 User 的 id 属性上标记上，在 username 属性上标记。
javax.validation.ConstraintViolationException: Validation failed for classes [cn.xxu.english_writing
a2667486939的博客
02-07 1138
问题描述 在使用validation进行表单验证时抛ConstraintViolationException异常 javax.validation.ConstraintViolationException: Validation failed for classes [cn.xxu.english_writing_platform.POJO.DO.UserDO] during persist time for groups [javax.validation.groups.Default, ] List
java--数据校验Validator
qq_34577961的博客
04-06 2017
Constraint(validatedBy={DefineValidationImpl.class}) //表示该注解通过这个类实现校验逻辑// 默认提示的错误信息String message() default "不可以包含空格";Class
Jakarta Bean Validation (jakarta.validation.constraints) 常用注解
最新发布
qq_26370505的博客
06-05 562
Jakarta Bean Validation (jakarta.validation.constraints) 提供了一系列标准的注解，用于简化和标准化JavaBean的数据验证。Jakarta Bean Validation (jakarta.validation.constraints) 标准的注解。
数据校验validation
lonelymanontheway的博客
06-30 3940
数据校验；JSR303；JSR349；JSR380；javax.validation.constraints；hibernate.validator； 自定义校验注解；
JSR303，Hibernate-Validator and Jakarta
MyFreeIT
05-09 654
jakarta.validation是基于Hibernate Validated进行封装，底层实现是基于hibernate-validator。
SpringBoot-Validate优雅的实现参数校验，详细用法~
startqbb的博客
12-12 1237
import com/*** @author ly (个人博客:https://www.cnblogs.com/ybbit)* @tags 喜欢就去努力的争取@NotBlank(message = "name 姓名不能为空") private String name;@NotNull(message = "age 年龄不能为空") @Min(value = 0 , message = "年龄不能小于0") private Integer age;
springboot嵌套参数校验
06-03
在Spring Boot中，可以使用Hibernate Validator库来进行参数校验，包括嵌套参数校验。 首先，在需要进行校验的类中，使用@Valid注解标注需要校验的嵌套对象，例如： ```java public class OuterObject { @Valid private InnerObject innerObject; // other fields and methods } ``` 然后，在嵌套对象内部定义校验规则，例如： ```java public class InnerObject { @NotNull private String name; // other fields and methods } ``` 最后，在Controller层中，使用@Valid注解对需要校验的对象进行标注，例如： ```java @RestController public class MyController { @PostMapping("/api/objects") public void createObject(@Valid @RequestBody OuterObject object) { // handle request } } ``` 这样，在请求创建对象时，如果对象或其嵌套对象的字段不符合校验规则，就会返回400 Bad Request错误，并且返回错误信息。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值