【W10】Spring Boot 参数验证详解：从问题引入到源码分析

本次为W10作业本文基于若依(RuoYi)框架深入讲解 Spring Boot 中参数验证的完整流程包括如何触发验证、前后端交互、源码分析以及生产环境的日志排查一、问题引入场景描述假如要在程序里对接口的函数参数进行限制大家有哪些解决方案比如如下SysUser的phonenumber字段限制它每次从前端传过来的长度不超过 20publicclassSysUser{privateStringphonenumber;// 限制长度不超过20}传统做法各种判断在 Controller 或 Service 中写if判断if(user.getPhonenumber()!nulluser.getPhonenumber().length()20){returnAjaxResult.error(手机号长度不能超过20个字符);}缺点当SysUser作为另一个函数的形参时代码冗余每个函数内都需要判断一次维护困难若一个属性判断代码要修改所有涉及到的地方都要改一次二、触发验证实例简介演示入口系统管理 → 角色管理 → 修改操作步骤进入角色修改页面看输入不同长度的数据会有怎样的效果。三、触发验证抛出异常1. 触发方式将角色名称改为超过 30 个字符的字符串1234567890123456789012345678901共 31 个字符超过 30 的限制2. 前端现象点击确定后弹出提示框角色名称长度不能超过 30 个字符3. 后端现象IDEA 的 Run Tab 输出如下 Log22:35:08.308 [http-nio-8080-exec-17] ERROR c.r.f.w.e.GlobalExceptionHandler - [validExceptionHandler,104] - Validation failed for argument [0] in public com.ruoyi.common.core.domain.AjaxResult com.ruoyi.web.controller.system.SysRoleController.edit(com.ruoyi.common.core.domain.entity.SysRole): [Field error in object sysRole on field roleName: rejected value [1234567890123456789012345678901]; codes [Size.sysRole.roleName,Size.roleName,Size.java.lang.String,Size]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [sysRole.roleName,roleName]; arguments []; default message [roleName],30,0]; default message [角色名称长度不能超过30个字符]]Log 关键信息解读序号问题答案1ERROR 关键字说明什么有捕获异常 Exception2谁捕获了异常GlobalExceptionHandler3哪里抛出的异常com.ruoyi.web.controller.system.SysRoleController.edit(...)4具体谁抛出了什么异常Field error in object ‘sysRole’ on field ‘roleName’: rejected value […]5抛出的异常类型MethodArgumentNotValidException四、源码分析1. 前端代码1输入框限制前端对输入框有限制不能为空el-form-item label角色名称 proproleName el-input v-modelform.roleName placeholder请输入角色名称 / /el-form-itemrules:{roleName:[{required:true,message:角色名称不能为空,trigger:blur}]}2发起请求确定后通过updateRole函数对 URI 为/system/role发起 HTTP PUT 操作请求 body 为 data/** 修改角色 */exportfunctionupdateRole(data){returnrequest({url:/system/role,method:put,data:data})}从浏览器开发者工具可以看到整体的 HTTP 请求 URL 为http://localhost/dev-api/system/role请求流程┌─────────────┐ 发起 HTTP 请求 ┌─────────────┐ │ 前端浏览器 │ ─────────────────→ │ 后端服务器 │ │ │ ←───────────────── │ │ └─────────────┘ 回应 HTTP 响应 └─────────────┘3后端返回信息后的前端处理逻辑返回code为 500 时输出错误提示 Message 框request.then(response{if(response.code500){this.$modal.msgError(response.msg)}})2. 后端代码1Controller 代码RestControllerRequestMapping(/system/role)publicclassSysRoleControllerextendsBaseController{AutowiredprivateISysRoleServiceroleService;/** * 修改保存角色 */PreAuthorize(ss.hasPermi(system:role:edit))Log(title角色管理,businessTypeBusinessType.UPDATE)PutMappingpublicAjaxResultedit(ValidatedRequestBodySysRolerole){if(!roleService.checkRoleNameUnique(role)){returnerror(修改角色role.getRoleName()失败角色名称已存在);}elseif(!roleService.checkRoleKeyUnique(role)){returnerror(修改角色role.getRoleName()失败权限字符已存在);}role.setUpdateBy(getUsername());returntoAjax(roleService.updateRole(role));}}关键注解Validated2SysRole 类对属性 roleName 的限制publicclassSysRoleextendsBaseEntity{/** 角色名称 */NotBlank(message角色名称不能为空)Size(min0,max30,message角色名称长度不能超过30个字符)privateStringroleName;// ... 其他属性}当roleName不满足两个注解NotBlank和Size限制时会抛出异常。3异常处理RestControllerAdvicepublicclassGlobalExceptionHandler{privatestaticfinalLoggerlogLoggerFactory.getLogger(GlobalExceptionHandler.class);/** * 自定义验证异常 */ExceptionHandler(MethodArgumentNotValidException.class)publicObjectvalidExceptionHandler(MethodArgumentNotValidExceptione){log.error(e.getMessage(),e);Stringmessagee.getBindingResult().getFieldError().getDefaultMessage();returnAjaxResult.error(message);}}3. 报错分析结合前面后端报错信息当SysRole属性roleName不满足约束时会抛出异常MethodArgumentNotValidException。异常处理链路1. 请求到达 Controller ↓ 2. Validated 触发参数验证 ↓ 3. roleName 长度超过30验证失败 ↓ 4. 抛出 MethodArgumentNotValidException ↓ 5. GlobalExceptionHandler 捕获异常 ↓ 6. 返回错误信息给前端 (code500, msg角色名称长度不能超过30个字符)五、后端持久化 Log 查看报错信息生产环境问题当生产环境时即后台服务部署到服务器上没有开发环境无法看到 IDEA 的 Log 信息需要通过 Log 文件查看出错信息排查问题。Log 文件路径与内容Log 文件路径通常在项目配置的日志目录下如logs/目录/server/ruoyi/logs/ ├── sys-error.log # 错误日志 ├── sys-info.log # 信息日志 └── sys-user/ # 业务模块日志查看sys-error.log文件可看到相同的报错信息。六、小结后端参数验证生效且程序抛出异常不崩溃需要如下4 个条件序号条件代码示例1参数验证注解修饰在所需类属性的 getter 或属性上NotBlank、Size2使用注解Validated修饰接口函数的对应类的形参Validated RequestBody SysRole role3RestControllerAdvice注册全局异常处理类RestControllerAdvice4正确处理类型MethodArgumentNotValidException异常ExceptionHandler(MethodArgumentNotValidException.class)七、踩坑记录踩过的坑有些参数验证注解如NotNull使用在基础类型它自己有默认值上不生效。尽量用基础类型的包装类型。