Spring Boot使用JSR-380进行校验的示例

 更新时间:2021年03月01日 11:44:39   投稿:mrr  
这篇文章主要介绍了Spring Boot使用JSR-380进行校验,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

介绍

JSR-380 是 J2EE 的一个规范,用于校验实体属性,它是 JSR-303 的升级版,在 Spring Boot 中可以基于它优雅实现参数校验。

<!--more-->

示例

在没有使用 JSR-380 之前,我们一般都会将参数校验硬编码在 controller 类中,示例:

public Result add(@RequestBody User user){
  if(StringUtils.isBlank(user.getName())){
    return Result.error("用户名不能为空");
  }
  // ...
}

而使用 JSR-380 只需要通过添加对应的注解即可实现校验,示例:

@Data
public class User{
  @NotBlank
  private String name;
  private Integer age;
}
public Result register(@Validated @RequestBody User user){
  // ...
}

这样看起来代码是不是清爽了很多,只需要在需要校验的字段上加上对应的校验注解,然后对需要校验的地方加上 @Validated 注解,然后框架就会帮我们完成校验。

通过全局异常自定义错误响应

框架校验失败之后会抛出异常,需要捕获这个异常然后来自定义校验不通过的错误响应,这里直接贴代码,兼容 @RequestBody@ModelAttribute@RequestParam 三种入参的校验:

@ControllerAdvice
public class GlobalExceptionHandler {

  @ExceptionHandler(value = {MethodArgumentNotValidException.class, BindException.class})
  public ResponseEntity<Result> methodArgumentNotValidHandler(HttpServletRequest request, Exception e) {
    BindingResult bindingResult;
    if (e instanceof MethodArgumentNotValidException) {
      //@RequestBody参数校验
      bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
    } else {
      //@ModelAttribute参数校验
      bindingResult = ((BindException) e).getBindingResult();
    }
    FieldError fieldError = bindingResult.getFieldError();
    return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + fieldError.getField() + "]" + fieldError.getDefaultMessage()));
  }

  //@RequestParam参数校验
  @ExceptionHandler(value = {ConstraintViolationException.class, MissingServletRequestParameterException.class})
  public ResponseEntity<Result> constraintViolationHandler(Exception e) {
    String field;
    String msg;
    if (e instanceof ConstraintViolationException) {
      ConstraintViolation<?> constraintViolation = ((ConstraintViolationException) e).getConstraintViolations().stream().findFirst().get();
      List<Path.Node> pathList = StreamSupport.stream(constraintViolation.getPropertyPath().spliterator(), false)
          .collect(Collectors.toList());
      field = pathList.get(pathList.size() - 1).getName();
      msg = constraintViolation.getMessage();
    } else {
      // 这个不是JSR标准返回的异常,要自定义提示文本
      field = ((MissingServletRequestParameterException) e).getParameterName();
      msg = "不能为空";
    }
    return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + field + "]" + msg));
  }
}

然后再访问一下接口,可以看到错误提示已经按自定义的规范显示了:

可以看到都不需要写任何提示文本就可以完成校验和提示,上图的 不能为空 是框架内置的 I18N 国际化支持,每个注解都内置相应的提示模板。

常用校验注解

注解 描述
@NotNull 验证值不为 null
@AssertTrue 验证值为 true
@Size 验证值的长度介于 min 和 max 之间,可应用于 String、Collection、Map 和数组类型
@Min 验证值不小于该值
@Max 验证值不大于该值
@Email 验证字符串是有效的电子邮件地址
@NotEmpty 验证值不为 null 或空,可应用于 String、Collection、Map 和数组类型
@NotBlank 验证字符串不为 null 并且不是空白字符
@Positive 验证数字为正数
@PositiveOrZero 验证数字为正数(包括 0)
@Negative 验证数字为负数
@NegativeOrZero 验证数字为负数(包括 0)
@Past 验证日期值是过去
@PastOrPresent 验证日期值是过去(包括现在)
@Future 验证日期值是未来
@FutureOrPresent 验证日期值是未来(包括现在)

本文完整代码放在 github

Java Bean Validation Basics

JSR-380 规范

到此这篇关于Spring Boot使用JSR-380进行校验的文章就介绍到这了,更多相关Spring Boot使用JSR-380校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 深入理解SpringBoot的配置环境属性

    深入理解SpringBoot的配置环境属性

    SpringBoot的配置环境属性是一种强大的工具,可以帮助我们配置和管理我们的应用程序,这篇文章主要介绍了SpringBoot的配置环境属性,需要的朋友可以参考下
    2023-07-07
  • java数据结构和算法中哈希表知识点详解

    java数据结构和算法中哈希表知识点详解

    在本篇文章里小编给大家分享了关于java数据结构和算法中哈希表的相关知识点内容,需要的朋友们学习下。
    2019-06-06
  • SpringBoot实现异步消息处理的代码示例

    SpringBoot实现异步消息处理的代码示例

    在现代应用程序中,异步消息处理是一项至关重要的任务。它可以提高应用程序的性能、可伸缩性和可靠性,同时也可以提供更好的用户体验,本文将介绍如何使用Spring Boot实现异步消息处理,并提供相应的代码示例
    2023-06-06
  • 关于springboot整合swagger问题及解决方法

    关于springboot整合swagger问题及解决方法

    这篇文章主要介绍了关于springboot整合swagger问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • java使用SFTP上传文件到资源服务器

    java使用SFTP上传文件到资源服务器

    这篇文章主要介绍了java使用SFTP上传文件到资源服务器,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-12-12
  • 反编译jar实现的三种方式

    反编译jar实现的三种方式

    本文主要介绍了反编译jar实现的三种方式,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • 每日六道java新手入门面试题,通往自由的道路第二天

    每日六道java新手入门面试题,通往自由的道路第二天

    这篇文章主要为大家分享了最有价值的6道java面试题,涵盖内容全面,包括数据结构和算法相关的题目、经典面试编程题等,对hashCode方法的设计、垃圾收集的堆和代进行剖析,感兴趣的小伙伴们可以参考一下
    2021-06-06
  • 带你了解Java中Static关键字的用法

    带你了解Java中Static关键字的用法

    这篇文章主要介绍了JAVA Static关键字的用法,文中讲解非常细致,代码帮助大家更好的理解和学习,感兴趣的朋友可以了解下,希望能给你带来帮助
    2021-08-08
  • Spring中的retry重试组件详解

    Spring中的retry重试组件详解

    这篇文章主要介绍了Spring中的retry重试组件详解,Retry重试组件是一个处理重试逻辑的工具,可以在出现异常或失败情况下自动进行重试操作,从而提高程序的稳定性和可靠性,需要的朋友可以参考下
    2023-10-10
  • GSON实现Java对象的JSON序列化与反序列化的实例教程

    GSON实现Java对象的JSON序列化与反序列化的实例教程

    GSON是Google开发并开源的一个Java的JSON转换库,这里我们将来讲解GSON实现Java对象的JSON序列化与反序列化的实例教程,需要的朋友可以参考下
    2016-06-06

最新评论