Spring Boot项目传参校验的最佳实践指南


Posted in Java/Android onApril 05, 2022

场景还原

简单业务场景模拟:

假如你现在在做一个成绩录入系统,你愉快地用Spring Boot框架写了一个后台接口,用于接收前台浏览器传过来的 Student对象,并插入后台数据库。

我们将传入的 Student对象定义为:

public class Student {
    private String name;    // 姓名
    private Integer score;  // 考试分数(满分100分)
    private String mobile;  // 电话号码(11位)
}

然后写一个Post请求的后台接口,来接收网页端传过来的 Student对象:

@RestController
public class TestController {

    @Autowired
    private StudentService studentService;

    @PostMapping("/add")
    public String addStudent( @RequestBody Student student ) {
        studentService.addStudent( student ); // 将student对象存入数据库
        return "SUCCESS";
    }
}

此时我想你一定看出来了上面这段代码的漏洞,因为我们并没有对传入的 Student对象做任何数据校验,比如:

Student对象里三个字段的某一个忘传了,为 null怎么办?Student的 score分数,假如写错了,写成 101分怎么办?Student的 mobile11位手机号码,假如填错了,多写了一位怎么办?...等等

这些数据虽然在前端页面一般会做校验,但我们作为一个严谨且良心的后端开发工程师,我们肯定要对传入的每一项数据做严格的校验,所以我们应该怎么写?

@PostMapping("/add")
public String addStudent( @RequestBody Student student ) {
    if( student == null )
        return "传入的Student对象为null,请传值";
    if( student.getName()==null || "".equals(student.getName()) )
        return "传入的学生姓名为空,请传值";
    if( student.getScore()==null )
        return "传入的学生成绩为null,请传值";
    if( (student.getScore()<0) || (student.getScore()>100) )
        return "传入的学生成绩有误,分数应该在0~100之间";
    if( student.getMobile()==null || "".equals(student.getMobile()) )
        return "传入的学生电话号码为空,请传值";
    if( student.getMobile().length()!=11 )
        return "传入的学生电话号码长度有误,应为11位";
    studentService.addStudent( student ); // 将student对象存入MySQL数据库
    return "SUCCESS";
}

写是写完了,就是感觉手有点酸,并且心有点累,这个 Student对象倒还好,毕竟内部仅3个字段,假如一个复杂的对象有30个字段怎么办?简直不敢想象!

神注解加持

其实Spring框架很早版本开始,就通过注解的方式,来方便地为我们提供了各项交互数据的校验工作,比如上面的例子,我们只需要在传入的 Student实体类的字段中加入对应注解即可方便的解决问题:

public class Student {
    @NotNull(message = "传入的姓名为null,请传值")
    @NotEmpty(message = "传入的姓名为空字符串,请传值")
    private String name;    // 姓名

    @NotNull(message = "传入的分数为null,请传值")
    @Min(value = 0,message = "传入的学生成绩有误,分数应该在0~100之间")
    @Max(value = 100,message = "传入的学生成绩有误,分数应该在0~100之间")
    private Integer score;  // 分数

    @NotNull(message = "传入的电话为null,请传值")
    @NotEmpty(message = "传入的电话为空字符串,请传值")
    @Length(min = 11, max = 11, message = "传入的电话号码长度有误,必须为11位")
    private String mobile;  // 电话号码
}

当然,于此同时,我们还需要在对象入口处,加上注解 @Valid来开启对传入 Student对象的验证工作:

@PostMapping("/add")
public String addStudent( @RequestBody  @Valid Student student ) {
    // 棒棒哒!原先各种繁杂的参数校验工作统统都省了!一行代码不用写
    studentService.addStudent( student ); // 将student对象存入MySQL数据库
    return "SUCCESS";
}

这时候,如果某个字段传入错误,比如我传数据的时候,将学生的成绩误传为 101分,则接口返回结果便会提示出错误详情:

Spring Boot项目传参校验的最佳实践指南

 

当然,关于这个事情的原理,既然用到了注解,无非用的也就是Java里的各种反射等知识来实现的,感兴趣的小伙伴可以借此机会研究一下!

数据异常统一拦截

上面利用注解的方式做统一数据校验感觉十分美好,但唯一美中不足的就是返回的结果太过繁杂,不一定使我们需要的格式,我们需要做统一处理,比如:我只想将具体参数校验的错误提示信息给抠出来返回给前端即可。

为此,我们为项目配置全局统一异常拦截器来格式化所有数据校验的返回结果。

@ControllerAdvice
@ResponseBody
public class GlobalExceptionInterceptor {
  @ExceptionHandler(value = Exception.class)
  public String exceptionHandler(HttpServletRequest request, Exception e) {
    String failMsg = null;
    if (e instanceof MethodArgumentNotValidException) {
      // 拿到参数校验具体异常信息提示
      failMsg = ((MethodArgumentNotValidException) e).getBindingResult().getFieldError().getDefaultMessage();
    }
    return failMsg; // 直接吐回给前端
  }
}

如上面代码所示,我们全局统一拦截了参数校验异常 MethodArgumentNotValidException,并仅仅只拿到对应异常的详细 Message信息吐给前端,此时返回给前端的数据就清楚得多:

Spring Boot项目传参校验的最佳实践指南

可以的,非常优雅!

总结

到此这篇关于Spring Boot项目传参校验的文章就介绍到这了,更多相关SpringBoot项目传参校验内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Java/Android 相关文章推荐
Spring boot应用启动后首次访问很慢的解决方案
Jun 23 Java/Android
Feign调用全局异常处理解决方案
Jun 24 Java/Android
一篇文章带你学习Mybatis-Plus(新手入门)
Aug 02 Java/Android
mybatis中注解与xml配置的对应关系和对比分析
Aug 04 Java/Android
关于springboot配置druid数据源不生效问题(踩坑记)
Sep 25 Java/Android
Java异常处理try catch的基本用法
Dec 06 Java/Android
Java9新特性之Module模块化编程示例演绎
Mar 16 Java/Android
InterProcessMutex实现zookeeper分布式锁原理
Mar 21 Java/Android
Android Studio实现简易进制转换计算器
May 20 Java/Android
Java实现超大Excel文件解析(XSSF,SXSSF,easyExcel)
Jul 15 Java/Android
app场景下uniapp的扫码记录
Jul 23 Java/Android
Spring boot admin 服务监控利器详解
Aug 05 Java/Android
springboot入门 之profile设置方式
Apr 04 #Java/Android
Java实现经典游戏泡泡堂的示例代码
Dubbo+zookeeper搭配分布式服务的过程详解
SpringBoot整合minio快速入门教程(代码示例)
Apr 03 #Java/Android
SpringBoot整合Minio文件存储
Apr 03 #Java/Android
Java中Quartz高可用定时任务快速入门
Apr 03 #Java/Android
Spring Security使用单点登录的权限功能
You might like
一步一步学习PHP(7) php 字符串相关应用
2010/03/05 PHP
php获取用户IPv4或IPv6地址的代码
2012/11/15 PHP
php中preg_replace_callback函数简单用法示例
2016/07/21 PHP
PHP实现四种基础排序算法的运行时间比较(推荐)
2016/08/11 PHP
Symfony2创建基于域名的路由相关示例
2016/11/14 PHP
PHP编程获取图片的主色调的方法【基于Imagick扩展】
2017/08/02 PHP
PHP使用PDO操作sqlite数据库应用案例
2019/03/07 PHP
PHP数组对象与Json转换操作实例分析
2019/10/22 PHP
Aster vs Newbee BO3 第三场2.18
2021/03/10 DOTA
Jquery工作常用实例 使用AJAX使网页进行异步更新
2011/07/26 Javascript
一个Action如何调用两个不同的方法
2014/05/22 Javascript
简单的jquery左侧导航栏和页面选中效果
2014/08/21 Javascript
Bootstrop实现多级下拉菜单功能
2016/11/24 Javascript
小程序实现发表评论功能
2018/07/06 Javascript
搭建vue开发环境
2018/07/19 Javascript
Angular4.x Event (DOM事件和自定义事件详解)
2018/10/09 Javascript
Vue 中的受控与非受控组件的实现
2018/12/17 Javascript
解决微信小程序中转换时间格式IOS不兼容的问题
2019/02/15 Javascript
原生js实现日期选择插件
2020/05/21 Javascript
浅要分析Python程序与C程序的结合使用
2015/04/07 Python
python基于Tkinter库实现简单文本编辑器实例
2015/05/05 Python
Python如何通过subprocess调用adb命令详解
2017/08/27 Python
Python与R语言的简要对比
2017/11/14 Python
Django分页查询并返回jsons数据(中文乱码解决方法)
2018/08/02 Python
python实现单链表中删除倒数第K个节点的方法
2018/09/28 Python
Python3 导入上级目录中的模块实例
2019/02/16 Python
Python字典fromkeys()方法使用代码实例
2020/07/20 Python
HTML5新增form控件和表单属性实例代码详解
2019/05/15 HTML / CSS
创业计划书——互联网商机
2014/01/12 职场文书
给护士表扬信
2014/01/19 职场文书
品牌宣传方案
2014/03/21 职场文书
重大事项社会稳定风险评估方案
2014/06/15 职场文书
防灾减灾日活动总结
2014/08/26 职场文书
青年文明号申报材料
2014/12/23 职场文书
2015年国庆节演讲稿范文
2015/07/30 职场文书
java如何实现获取客户端ip地址的示例代码
2022/04/07 Java/Android