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 相关文章推荐
手把手教你用SpringBoot将文件打包成zip存放或导出
Jun 11 Java/Android
解析Java异步之call future
Jun 14 Java/Android
新手入门Jvm-- JVM对象创建与内存分配机制
Jun 18 Java/Android
Java 中的 Unsafe 魔法类的作用大全
Jun 26 Java/Android
Java中CyclicBarrier和CountDownLatch的用法与区别
Aug 23 Java/Android
springboot入门 之profile设置方式
Apr 04 Java/Android
IDEA 2022 Translation 未知错误 翻译文档失败
Apr 24 Java/Android
Java 定时任务技术趋势简介
May 04 Java/Android
springboot读取nacos配置文件
May 20 Java/Android
Java实现扫雷游戏详细代码讲解
May 25 Java/Android
Java实现注册登录跳转
Jun 16 Java/Android
OpenFeign实现远程调用
Aug 14 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二分法查找数组是否包含某一元素
2013/05/23 PHP
深入解析PHP 5.3.x 的strtotime() 时区设定 警告信息修复
2013/08/05 PHP
php bootstrap实现简单登录
2016/03/08 PHP
php实现网页端验证码功能
2017/07/11 PHP
用js实现的仿sohu博客更换页面风格(简单版)
2007/03/22 Javascript
本地对象Array的原型扩展实现代码
2010/12/04 Javascript
Node.js中的事件驱动编程详解
2014/08/16 Javascript
JS实现合并两个数组并去除重复项只留一个的方法
2015/12/17 Javascript
PHP抓取HTTPS内容和错误处理的方法
2016/09/30 Javascript
利用js来实现缩略语列表、文献来源链接和快捷键列表
2016/12/16 Javascript
浅谈JS中的反柯里化( uncurrying)
2017/08/17 Javascript
详解从Vue-router到html5的pushState
2018/07/21 Javascript
微信小程序第三方框架对比 之 wepy / mpvue / taro
2019/04/10 Javascript
vue中filters 传入两个参数 / 使用两个filters的实现方法
2019/07/15 Javascript
修改vue源码实现动态路由缓存的方法
2020/01/21 Javascript
微信小程序自定义胶囊样式
2020/12/27 Javascript
[01:20:47]DOTA2-DPC中国联赛 正赛 Ehome vs Magma BO3 第一场 1月19日
2021/03/11 DOTA
python列表操作使用示例分享
2014/02/21 Python
python 日期操作类代码
2018/05/05 Python
对python制作自己的数据集实例讲解
2018/12/12 Python
Python通过paramiko远程下载Linux服务器上的文件实例
2018/12/27 Python
Python OpenCV利用笔记本摄像头实现人脸检测
2020/08/20 Python
浅谈pytorch池化maxpool2D注意事项
2020/02/18 Python
Python制作简单的剪刀石头布游戏
2020/12/10 Python
CAT鞋英国官网:坚固耐用的靴子和鞋
2016/10/21 全球购物
安全教育心得体会
2013/12/29 职场文书
幼儿园庆六一游园活动方案
2014/01/29 职场文书
消防安全检查制度
2014/02/04 职场文书
行政工作个人的自我评价
2014/02/13 职场文书
校园标语大全
2014/06/19 职场文书
最美护士演讲稿
2014/08/27 职场文书
信息与计算机科学职业规划范文:成为一艘有方向的船
2014/09/11 职场文书
车辆转让协议书
2014/09/24 职场文书
优秀班主任材料
2014/12/16 职场文书
舌尖上的中国观后感
2015/06/02 职场文书
Python可视化学习之seaborn调色盘
2022/02/24 Python