SpringBoot Validation入参校验国际化的项目实践

 更新时间:2023年10月03日 11:46:32   作者:无语堵上西楼  
在Spring Boot中,可以使用Validation和国际化来实现对入参的校验,本文就来介绍一下SpringBoot Validation入参校验国际化,具有一定的参考价值,感兴趣的可以了解一下

在 Spring Boot 中,可以使用 Validation 和国际化来实现对入参的校验。

常用的校验 

@NotNull验证字段值不能为 null
@NotEmpty验证字段值不能为 null 或空字符串
@NotBlank验证字符串字段值不能为空、null,并且必须至少包含一个非空白字符
@Size验证字符串、集合或数组的大小是否在指定范围内
@Min验证数值字段值必须大于等于指定的最小值
@Max验证数值字段值必须小于等于指定的最大值
@Email验证字段值必须是有效的电子邮件地址格式
@Pattern验证字段值必须匹配指定的正则表达式模式
@Past验证日期字段值必须是过去的日期
@Future验证日期字段值必须是将来的日期

引入依赖

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

创建properties文件

安装插件 

创建文件 

添加语言 

添加配置 

语言配置 

非空配置

长度配置 

解决properties文件中文乱码

mode添加注解

@NotBlank 注解用于验证字符串类型字段不为空或不为 null。如果验证失败,则使用 message 属性中定义的错误消息提示用户输入不能为空或 null 值。

@Length 注解用于验证字符串类型字段的长度是否符合指定的范围。如果验证失败,就会使用 message 属性中定义的错误消息提示用户输入的长度非法。

    /**
     * 学生姓名
     */
    @NotBlank(message = "{name.notBlank}")
    @Length(min = 2,max = 19,message="{name.length}")
    private String name;

controller添加注解

@Validated 是 Spring Framework 提供的一个注解,用于在控制器方法级别或类级别上启用方法参数验证,以对请求参数进行验证。

@Valid 是 Java 标准库中的一个注解,它与 Bean Validation 规范(JSR 380)一起使用,用于启用对象级别验证。 

@RestController
@RequestMapping("/test")
@Validated
public class TestController {
    @PostMapping("/user")
    public ResponseResult<String> user(@Valid @RequestBody Student student) {
        return new ResponseResult<>("userToken");
    }
}

添加异常捕捉

这个类捕获参数异常 

import com.example.demo.util.HttpCodeEnum;
import com.example.demo.util.ResponseResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.util.CollectionUtils;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.servlet.http.HttpServletRequest;
import java.util.List;
@RestControllerAdvice
public class GlobalExceptionHandler {
    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    @Autowired
    private HttpServletRequest httpServletRequest;
    private final String sysError="系统出错";
    // get请求的对象参数校验异常
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MissingServletRequestParameterException.class})
    public ResponseResult bindExceptionHandler(MissingServletRequestParameterException e) {
        String requestURI = httpServletRequest.getRequestURI();
        log.error("请求地址'{}',get方式请求参数'{}'必传", requestURI,e.getParameterName());
        return ResponseResult.errorResult(HttpCodeEnum.SYSTEM_ERROR.getCode(), e.getMessage());
    }
    // post请求的对象参数校验异常
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public ResponseResult methodArgumentNotValidHandler(MethodArgumentNotValidException e) {
        String requestURI = httpServletRequest.getRequestURI();
        log.error("请求地址'{}',post方式请求参数异常'{}'", requestURI, e.getMessage());
        List<ObjectError> allErrors = e.getBindingResult().getAllErrors();
        return ResponseResult.errorResult(HttpCodeEnum.SYSTEM_ERROR.getCode(), getValidExceptionMsg(allErrors));
    }
    private String getValidExceptionMsg(List<ObjectError> errors) {
        if(!CollectionUtils.isEmpty(errors)){
            StringBuilder sb = new StringBuilder();
            errors.forEach(error -> {
                if (error instanceof FieldError) {
                    sb.append(((FieldError)error).getField()).append(":");
                }
                sb.append(error.getDefaultMessage()).append(";");
            });
            String msg = sb.toString();
            msg = msg.substring(0, msg.length() -1);
            return msg;
        }
        return null;
    }
}

测试

name为空 

name长度不符合 

切换为英文 

到此这篇关于SpringBoot Validation入参校验国际化的文章就介绍到这了,更多相关SpringBoot Validation入参校验国际化内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家! 

相关文章

  • servlet上传文件实现代码详解(四)

    servlet上传文件实现代码详解(四)

    这篇文章主要为大家详细介绍了servlet上传文件的实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09
  • Spring MVC注解式开发使用详解

    Spring MVC注解式开发使用详解

    本篇文章主要介绍了Spring MVC注解式开发使用详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • Java中的ArrayList类常用方法和遍历

    Java中的ArrayList类常用方法和遍历

    这篇文章主要介绍了Java中的ArrayList类常用方法和遍历,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Properties操作如何保存到属性文件

    Properties操作如何保存到属性文件

    这篇文章主要介绍了Properties操作保存到属性文件的相关知识,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-06-06
  • Java中Runnable和Thread的区别分析

    Java中Runnable和Thread的区别分析

    在java中可有两种方式实现多线程,一种是继承Thread类,一种是实现Runnable接口,下面就拉分别介绍一下这两种方法的优缺点
    2013-03-03
  • Java并发包之CopyOnWriteArrayList类的深入讲解

    Java并发包之CopyOnWriteArrayList类的深入讲解

    这篇文章主要给大家介绍了关于Java并发包之CopyOnWriteArrayList类的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • 关于Java8新特性Optional类的详细解读

    关于Java8新特性Optional类的详细解读

    Optional类是一个容器类,它可以保存类型T的值,代表这个值存在。或者仅仅保存null,表示这个值不存在,原来用 null 表示一个值不存在,现在Optional 可以更好的表达这个概念。并且可以避免空指针异常,需要的朋友可以参考下
    2023-05-05
  • mybatis输出SQL格式化方式

    mybatis输出SQL格式化方式

    这篇文章主要介绍了mybatis输出SQL格式化方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • 深度解析Java常量池中的Integer缓冲池和String常量池

    深度解析Java常量池中的Integer缓冲池和String常量池

    为了减少对象重复创建、提升运行时效率,Java 内部提供了两种重要的优化机制Integer 缓冲池(IntegerCache)和 String 常量池(String Pool),本文将深入剖析两大常量池的底层实现、工作流程、适用范围,并通过流程图和代码示例帮助你彻底掌握
    2026-05-05
  • 解决SpringBoot @value注解取不到值的问题

    解决SpringBoot @value注解取不到值的问题

    这篇文章主要介绍了解决SpringBoot @value注解取不到值的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07

最新评论