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-Integration执行过程
Jun 11 Java/Android
java设计模式--原型模式详解
Jul 21 Java/Android
SpringBoot整合RabbitMQ的5种模式实战
Aug 02 Java/Android
Java面试题冲刺第十九天--数据库(4)
Aug 07 Java/Android
OpenCV实现反阈值二值化
Nov 17 Java/Android
SSM项目使用拦截器实现登录验证功能
Jan 22 Java/Android
关于ObjectUtils.isEmpty() 和 null 的区别
Feb 28 Java/Android
Spring this调用当前类方法无法拦截的示例代码
Mar 20 Java/Android
MybatisPlus EntityWrapper如何自定义SQL
Mar 22 Java/Android
Android自定义双向滑动控件
Apr 19 Java/Android
Android中View.post和Handler.post的关系
Jun 05 Java/Android
基于Android10渲染Surface的创建过程
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中的mb_detect_encoding函数使用方法
2015/08/18 PHP
php读取本地json文件的实例
2018/03/07 PHP
Yii1.1框架实现PHP极光推送消息通知功能
2018/09/06 PHP
PHP实现的操作数组类库定义与用法示例
2019/05/24 PHP
又一个小巧的图片预加载类
2007/05/05 Javascript
jQuery 类twitter的文本字数限制带提示效果插件
2010/04/16 Javascript
关于jquery动态增减控件的一些想法和小插件
2010/08/01 Javascript
JQUBar 基于JQUERY的柱状图插件
2010/11/23 Javascript
Node.js生成HttpStatusCode辅助类发布到npm
2013/04/09 Javascript
window.open()详解及浏览器兼容性问题示例探讨
2014/05/29 Javascript
js实现网页收藏功能
2015/12/17 Javascript
基于jquery实现下拉框美化特效
2016/02/02 Javascript
javascript创建对象、对象继承的实用方式详解
2016/03/08 Javascript
AngularJS 工作原理详解
2016/08/18 Javascript
jQuery中animate()的使用方法及解决$(”body“).animate({“scrollTop”:top})不被Firefox支持的问题
2017/04/04 jQuery
基于Vuejs和Element的注册插件的编写方法
2017/07/03 Javascript
微信小程序实现鼠标拖动效果示例
2017/12/01 Javascript
简单两步使用node发送qq邮件的方法
2019/03/01 Javascript
详解JavaScript 的变量
2019/03/08 Javascript
小程序云函数调用API接口的方法
2019/05/17 Javascript
基于webpack4+vue-cli3项目实现换肤功能
2019/07/17 Javascript
Element el-button 按钮组件的使用详解
2021/02/01 Javascript
Python语法快速入门指南
2015/10/12 Python
Python定义二叉树及4种遍历方法实例详解
2018/07/05 Python
对numpy中数组转置的求解以及向量内积计算方法
2018/10/31 Python
Python对象转换为json的方法步骤
2019/04/25 Python
python多进程读图提取特征存npy
2019/05/21 Python
Python 串口读写的实现方法
2019/06/12 Python
python中树与树的表示知识点总结
2019/09/14 Python
Python如何实现后端自定义认证并实现多条件登陆
2020/06/22 Python
python向企业微信发送文字和图片消息的示例
2020/09/28 Python
雅诗兰黛澳大利亚官网:Estée Lauder澳大利亚
2019/05/31 全球购物
Quiksilver荷兰官方网站:冲浪和滑雪板
2019/11/16 全球购物
Java面试题汇总
2015/12/06 面试题
医科学校毕业生自荐信
2013/11/09 职场文书
个性车贴标语
2014/06/24 职场文书