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 相关文章推荐
Java实现多文件上传功能
Jun 30 Java/Android
详解Spring Boot使用系统参数表提升系统的灵活性
Jun 30 Java/Android
Java 语言中Object 类和System 类详解
Jul 07 Java/Android
spring cloud 配置中心native配置方式
Sep 25 Java/Android
解析mybatis-plus中的resultMap简单使用
Nov 23 Java/Android
Java设计模式之享元模式示例详解
Mar 03 Java/Android
详解Spring Security中的HttpBasic登录验证模式
Mar 17 Java/Android
Java 数据结构七大排序使用分析
Apr 02 Java/Android
springboot用户数据修改的详细实现
Apr 06 Java/Android
零基础学java之带返回值的方法的定义和调用
Apr 10 Java/Android
Spring Boot项目如何优雅实现Excel导入与导出功能
Jun 10 Java/Android
Android开发手册TextInputLayout样式使用示例
Jun 10 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
根德YB400的电路分析
2021/03/02 无线电
php页面防重复提交方法总结
2013/11/25 PHP
php ajax异步读取rss文档数据
2016/03/29 PHP
PHP开发之用微信远程遥控服务器
2018/01/25 PHP
js 单引号 传递方法
2009/06/22 Javascript
JS 各种网页尺寸判断实例方法
2013/04/18 Javascript
JavaScript简单修改窗口大小的方法
2015/08/03 Javascript
jQuery+ajax实现文章点赞功能的方法
2015/12/31 Javascript
JavaScript中的继承之类继承
2016/05/01 Javascript
JavaScript每天必学之事件
2016/09/18 Javascript
jquery实现点击页面回到顶部
2016/11/23 Javascript
基于JQuery实现的跑马灯效果(文字无缝向上翻动)
2016/12/02 Javascript
整理关于Bootstrap排版的慕课笔记
2017/03/29 Javascript
node.js 抓取代理ip实例代码
2017/04/30 Javascript
BootStrap 获得轮播中的索引和当前活动的焦点对象
2017/05/11 Javascript
jQuery操作css样式
2017/05/15 jQuery
基于Vue的延迟加载插件vue-view-lazy
2018/05/21 Javascript
Vue 实现列表动态添加和删除的两种方法小结
2018/09/07 Javascript
js实现倒计时器自定义时间和暂停
2019/02/25 Javascript
js实现掷骰子小游戏
2019/10/24 Javascript
使用TS来编写express服务器的方法步骤
2020/10/29 Javascript
JavaScript实现图片放大预览效果
2020/11/02 Javascript
Python生成词云的实现代码
2020/01/14 Python
Python下使用Trackbar实现绘图板
2020/10/27 Python
时尚的CSS3进度条效果
2012/02/22 HTML / CSS
利用css3制作3D样式按钮实现代码
2013/03/18 HTML / CSS
公司JAVA开发面试题
2015/04/02 面试题
财务会计专业毕业生自荐信
2013/10/02 职场文书
营销人才自我鉴定范文
2013/12/25 职场文书
学生党员一帮一活动总结
2014/07/08 职场文书
给校长的建议书作文300字
2015/09/14 职场文书
导游词之江南园林狮子林
2019/09/16 职场文书
Python实战之用tkinter库做一个鼠标模拟点击器
2021/04/27 Python
Pytorch distributed 多卡并行载入模型操作
2021/06/05 Python
Z-Order加速Hudi大规模数据集方案分析
2022/03/31 Servers
win10音频服务未响应怎么解决?win10音频服务未响应未修复的解决方法
2022/08/14 数码科技