展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 PDF教程 IOS软件 Android AI seko中国官网 二狗PPT官网入口在哪 updream官网入口 updream生成工具下载 laper.ai官网 lovart官网首页入口 lovartAI工具 lovartai官网 蛙蛙写作是免费的吗 蛙蛙写作app 火山引擎控制台入口 火山引擎官方入口 Flowith seko计量泵官网 码上飞官网 码上飞官网登录入口 花生ai剪辑 花生AI官网下载 花生AI官网 flowith官网入口 flowith网页版 FLOWith官网 讯飞智文ppt 讯飞智文网页版 讯飞智文官网 up简历网站 小橡皮官网 咔片PPT anishort官网 蛙蛙写作网站 PixTV官网 音述ai官网入口 小橡皮官网首页 ATOMS官网 墨刀ai网页版 墨刀aippt 超级简历免费模板 超级简历模板官网 loomy官网入口有手机端吗 up简历模板 讯飞智作app官方网站入口 讯飞智作官网入口免费 剧云录官网入口 剧云录网页版进入 剧云官网入口登录 skildart.cn 讯飞绘文官网App下载 vibeknow官网入口 anishort官网下载 loomy官网下载最新版 专题
全部分类

当前位置:

首页 > 编程开发 > SpringBoot参数怎么校验

SpringBoot参数怎么校验

使用传统方式的弊端publicStringaddUser(Useruser){if(user==null||user.getId()==null||user.getAccount()==null||user.getPassword()==null||user.getEmail()==null){return"对象或者对象字段不能为空";}if(StringUtils.isEmpty(user.getAccount())||StringUtils.isEmpty(user.getPassword())||S

本文目录

      使用传统方式的弊端

      public String addUser(User user) {
           if (user == null || user.getId() == null || user.getAccount() == null || user.getPassword() == null || user.getEmail() == null) {
               return "对象或者对象字段不能为空";
           }
           if (StringUtils.isEmpty(user.getAccount()) || StringUtils.isEmpty(user.getPassword()) || StringUtils.isEmpty(user.getEmail())) {
               return "不能输入空字符串";
           }
           if (user.getAccount().length() < 6 || user.getAccount().length() > 11) {
               return "账号长度必须是6-11个字符";
           }
           if (user.getPassword().length() < 6 || user.getPassword().length() > 16) {
               return "密码长度必须是6-16个字符";
           }
           if (!Pattern.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$", user.getEmail())) {
               return "邮箱格式不正确";
           }
           // 参数校验完毕后这里就写上业务逻辑
           return "success";
       }

      这样做确实没有什么问题,而且排版也工整,但代码太繁琐了,如果有几十个字段要校验,那这个方法里面将会变得非常臃肿,实在不够优雅。下面我们就来讲讲如何使用最优雅的方式来解决。

      引入依赖

      
      		org.springframework.boot
      		spring-boot-starter-validation
      

      注解说明

      注解说明
      @AssertFalse被注解的元素必须为 false
      @AssertTrue被注解的元素必须为 true
      @DecimalMax(value)被注解的元素必须是一个数字,其值必须小于等于指定的最大值
      @DecimalMin(value)被注解的元素必须是一个数字,其值必须大于等于指定的最小值
      @Digits (integer, fraction)被注解的元素必须是一个数字,其值必须在可接受的范围内
      @Null被注解的元素必须为空
      @NotNull被注解的元素必须不为空
      @Min(value)被注解的元素必须是一个数字,其值必须大于等于指定的最大值
      @Max(value)被注解的元素必须是一个数字,其值必须小于等于指定的最大值
      @Size(max, min)被注解的元素的长度必须在指定的范围内
      @Past被注解的元素必须是一个过去的日期
      @Future被注解的元素必须是一个未来的日期
      @Pattern(value)被注解的元素必须符合指定的正则表达式

      下面我们以此来在业务中实现

      一、对实体类进行校验

      1、entity

      @Data
      public class User {
          @NotNull(message = "用户id不能为空")
          private Long id;
          @NotNull(message = "用户账号不能为空")
          @Size(min = 6, max = 11, message = "账号长度必须是6-11个字符")
          private String account;
          @NotNull(message = "用户密码不能为空")
          @Size(min = 6, max = 11, message = "密码长度必须是6-16个字符")
          private String password;
          @NotNull(message = "用户邮箱不能为空")
          @Email(message = "邮箱格式不正确")
          private String email;
      }

      2、controller

      @RestController
      public class UserController {
          @PostMapping("/addUser")
          public void addUser(@RequestBody @Valid User user) {
      		//业务
          }
      }

      3、编写全局统一异常处理

      import org.springframework.validation.ObjectError;
      import org.springframework.web.bind.MethodArgumentNotValidException;
      import org.springframework.web.bind.annotation.ExceptionHandler;
      import org.springframework.web.bind.annotation.RestControllerAdvice;
      import javax.validation.ConstraintViolation;
      import javax.validation.ConstraintViolationException;
      import java.util.stream.Collectors;
      /**
       * 全局异常处理
       *
       * @author master
       */
      @RestControllerAdvice
      public class ExceptionConfig {
          /**
           * 参数为实体类
           * @param e
           * @return
           */
          @ExceptionHandler(value = MethodArgumentNotValidException.class)
          public String handleValidException(MethodArgumentNotValidException e) {
              // 从异常对象中拿到ObjectError对象
              ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
              // 然后提取错误提示信息进行返回
              return objectError.getDefaultMessage();
          }
          /**
           * 参数为单个参数或多个参数
           * @param e
           * @return
           */
          @ExceptionHandler(value = ConstraintViolationException.class)
          public String handleConstraintViolationException(ConstraintViolationException e) {
              // 从异常对象中拿到ObjectError对象
              return e.getConstraintViolations()
                      .stream()
                      .map(ConstraintViolation::getMessage)
                  	.collect(Collectors.toList()).get(0);
          }
      }

      然后我们使用apipost测试

      SpringBoot参数怎么校验

      二、针对单个参数进行校验

      import org.springframework.validation.annotation.Validated;
      import org.springframework.web.bind.annotation.GetMapping;
      import org.springframework.web.bind.annotation.PostMapping;
      import org.springframework.web.bind.annotation.RestController;
      import javax.validation.constraints.NotNull;
      @RestController
      @Validated
      public class TestController {
          @GetMapping("/test")
          public void test(@NotNull(message = "id不能为空") Integer id) {
          }
      }

      然后我们使用apipost测试

      SpringBoot参数怎么校验

      三、分组校验

      场景:在新增时我们需要id为空,但修改时我们又需要id不为空,总不可能搞两个类吧,这时候分组校验的用处就来了

      1、entity

      import lombok.Data;
      import javax.validation.constraints.Email;
      import javax.validation.constraints.NotNull;
      import javax.validation.constraints.Size;
      @Data
      public class User {
          public interface Insert{
          }
          public interface Update{
          }
          @NotNull(message = "用户id不能为空",groups = Update.class)
          @Null(message = "用户id必须为空",groups = Integer.class)
          private Long id;
          private String account;
          private String password;
          private String email;
      }

      2、controller

      @PostMapping("/add")
      public void add(@RequestBody @Validated(User.Insert.class) User user) {
      }

      添加时就用User.Insert.class,修改时就用User.Update.class

      四、自定义分组校验

      场景:当type为1时,需要参数a不为空,当type为2时,需要参数b不为空。

      1、entity

      import com.example.demo.provider.CustomSequenceProvider;
      import lombok.Data;
      import org.hibernate.validator.group.GroupSequenceProvider;
      import javax.validation.constraints.NotEmpty;
      import javax.validation.constraints.Pattern;
      @Data
      @GroupSequenceProvider(value = CustomSequenceProvider.class)
      public class CustomGroup {
          /**
           * 类型
           */
          @Pattern(regexp = "[A|B]" , message = "类型不必须为 A|B")
          private String type;
          /**
           * 参数A
           */
          @NotEmpty(message = "参数A不能为空" , groups = {WhenTypeIsA.class})
          private String paramA;
          /**
           * 参数B
           */
          @NotEmpty(message = "参数B不能为空", groups = {WhenTypeIsB.class})
          private String paramB;
          /**
           * 分组A
           */
          public interface WhenTypeIsA {
          }
          /**
           * 分组B
           */
          public interface WhenTypeIsB {
          }
      }

      2、CustomSequenceProvider

      import com.example.demo.controller.CustomGroup;
      import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;
      import java.util.ArrayList;
      import java.util.List;
      public class CustomSequenceProvider implements DefaultGroupSequenceProvider {
          @Override
          public List> getValidationGroups(CustomGroup form) {
              List> defaultGroupSequence = new ArrayList<>();
              defaultGroupSequence.add(CustomGroup.class);
              if (form != null && "A".equals(form.getType())) {
                  defaultGroupSequence.add(CustomGroup.WhenTypeIsA.class);
              }
              if (form != null && "B".equals(form.getType())) {
                  defaultGroupSequence.add(CustomGroup.WhenTypeIsB.class);
              }
              return defaultGroupSequence;
          }
      }

      3、controller

      @PostMapping("/add")
      public void add(@RequestBody @Validated CustomGroup user) {
      }

      五、自定义校验

      虽然官方提供的校验注解已经满足很多情况了,但还是无法满足我们业务的所有需求,比如校验手机号码,下面我就以校验手机号码来做一个示例。

      1、定义校验注解

      @Target({ElementType.FIELD})
      @Retention(RetentionPolicy.RUNTIME)
      @Constraint(validatedBy = PhoneValidator.class)
      public @interface Phone {
          String message() default "手机号码格式有误";
          Class[] groups() default {};
          Class[] payload() default {};
      }

      注:groups和payload是必须要写的,Constraint是使用哪个类来进行校验。

      2、实现注解

      import javax.validation.ConstraintValidator;
      import javax.validation.ConstraintValidatorContext;
      import java.util.regex.Pattern;
      /**
       * @author master
       */
      public class PhoneValidator implements ConstraintValidator {
          @Override
          public boolean isValid(Object telephone, ConstraintValidatorContext constraintValidatorContext) {
              String pattern = "^1[3|4|5|6|7|8|9]\\d{9}$";
              return Pattern.matches(pattern, telephone.toString());
          }
      }

      最后直接用到参数前面或者实体类变量上面即可。

      六、嵌套校验

      当某个对象中还包含了对象需要进行校验,这个时候我们需要用嵌套校验。

      @Data
      public class TestAA {
          @NotEmpty(message = "id不能为空")
          private String id;
          @NotNull
          @Valid
          private Job job;
          @Data
          public class Job {
              @NotEmpty(message = "content不能为空")
              private String content;
          }
      }

      七、快速失败

      Spring Validation默认会校验完所有字段,然后才抛出异常。可以通过配置,开启Fali Fast模式,一旦校验失败就立即返回。

      import org.hibernate.validator.HibernateValidator;
      import org.springframework.context.annotation.Bean;
      import org.springframework.context.annotation.Configuration;
      import javax.validation.Validation;
      import javax.validation.Validator;
      import javax.validation.ValidatorFactory;
      @Configuration
      public class FailFastConfig {
          @Bean
          public Validator validator() {
              ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                      .configure()
                      // 快速失败模式
                      .failFast(true)
                      .buildValidatorFactory();
              return validatorFactory.getValidator();
          }
      }

      注意事项

      SpringBoot 2.3.x 移除了validation依赖需要手动引入依赖。

      本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
      作者最新文章
      编程开发
      下一篇: ChatGPT的狂飙之路
      相关文章 更多
      精品专题 更多
      装机必备

      正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

      Windows

      正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

      PDF教程

      正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

      macOS软件

      正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

      IOS软件

      正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

      AI

      正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

      Mac软件 更多
      讯飞智作 网页版
      讯飞智作 网页版

      讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

      火山引擎 网页版
      火山引擎 网页版

      火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

      Aperty macOS版
      Aperty macOS版

      Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

      立刻MV 网页版
      立刻MV 网页版

      立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

      蛙蛙写作 网页版
      蛙蛙写作 网页版

      蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

      超级简历WonderCV 网页版
      超级简历WonderCV 网页版

      超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

      音述AI 网页版
      音述AI 网页版

      音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

      AionClaw macOS版
      AionClaw macOS版

      AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

      Loomy macOS版
      Loomy macOS版

      Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

      AirBuddy 3 macOS版
      AirBuddy 3 macOS版

      AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

      AirServer macOS版
      AirServer macOS版

      AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

      AnyDesk macOS版
      AnyDesk macOS版

      AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

      WINDOWS 更多
      讯飞智作 网页版
      讯飞智作 网页版

      讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

      火山引擎 网页版
      火山引擎 网页版

      火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

      PixTV 网页版
      PixTV 网页版

      PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。

      讯飞绘文 网页版
      讯飞绘文 网页版

      讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

      Maya(Autodesk Maya) Windows版
      Maya(Autodesk Maya) Windows版

      Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

      Aperty Windows版
      Aperty Windows版

      Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

      立刻MV 网页版
      立刻MV 网页版

      立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

      蛙蛙写作 网页版
      蛙蛙写作 网页版

      蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

      超级简历WonderCV 网页版
      超级简历WonderCV 网页版

      超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

      音述AI 网页版
      音述AI 网页版

      音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

      AionClaw Windows版
      AionClaw Windows版

      AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

      Loomy Windows版
      Loomy Windows版

      Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。