【Java中如何优雅地校验项目中请求入参】

无岸之舟

已于 2024-09-19 17:00:56 修改

阅读量1k

点赞数 31

分类专栏：优雅设计tips 文章标签： java spring spring boot

于 2024-09-12 00:04:33 首次发布

本文链接：https://blog.csdn.net/weixin_44585177/article/details/142151515

版权

优雅设计tips 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

文章目录

项目中如何优雅的搞定请求入参校验

项目中如何优雅的搞定请求入参校验

业务场景：比如说咱们项目里面某个微服务下多个请求接口都要对手机号校验，项目里面一般大家都是协同开发，可能会存在这人写一套正则，另一个牛逼的同事写一套自己的校验算法等…巴拉巴拉，最终都能实现对这个手机号校验，本身没问题，这样项目上可能会显得比较臃肿，那如何优雅的统一做入参校验呢？
接下来就一起看个demo吧~

第一步：定义自定义注解@Mobile

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = MobileValidator.class)
public @interface Mobile {
  boolean required() default true;
  /**
   * 校验不通过返回的提示信息
   */
  String message() default "不是一个手机号码格式";
  /**
   * Constraint要求的属性，用于分组校验和扩展，留空就好
   */
  Class<?>[] groups() default {};
  Class<? extends Payload>[] payload() default {};
}

第二步：实现校验器

public class MobileValidator implements ConstraintValidator<Mobile, CharSequence> {

  private boolean required = false;

  private final Pattern pattern = Pattern.compile("^1[34578][0-9]{9}$"); // 验证手机号

  /**
   * 在验证开始前调用注解里的方法，从而获取到一些注解里的参数,required 默认为true也就是开启手机号校验
   * @param constraintAnnotation
   */
  @Override
  public void initialize(Mobile constraintAnnotation) {
    this.required = constraintAnnotation.required();
  }

  /**
   * 真正执行的校验方法 true? 开启校验 ： 直接不校验=>通过
   * @param value object to validate
   * @param context context in which the constraint is evaluated
   * @return
   */
  @Override
  public boolean isValid(CharSequence value, ConstraintValidatorContext context) {
      return this.required ? isMobile(value) : Boolean.TRUE;
  }

  /**
   * 正则校验手机号
   * @param str
   * @return
   */
  private boolean isMobile(final CharSequence str) {
    return pattern.matcher(str).matches();
  }
}

第三步接下来就可以开始愉快的测试啦

1.创建Controller控制器层接收请求

required 的布尔值属性指定要不要做校验，true ? 需要 : 不需要

/**
 * 测试自定义注解
 * @param phone
 * @return
 */
@GetMapping("/test-customValidation")
public CommonResult<String> testCustomValidation(@Mobile(required= true) String phone) {
    return CommonResult.success(phone);
}

2.使用ApiPost测试请求

required = true 需要校验的情况下测试：
输入错误的手机号->失败

输入正确的手机号->成功
required = false 不需要校验的情况下测试：
输入错误的手机号，成功->因为咱们设置了注解值对参数不校验

好啦，今天的分享就到这，相信大家对类似场景都可以实现自己的校验器啦，小小拿捏。

内心os：把平凡的代码写完再优化好，像写诗一样，真的特别舒心。

今天在协助筛选求职者简历，同事发现有求职者有写csdn的好习惯，我以前一直是归纳总结到了github上孤芳自赏，针对国内环境感觉还是写csdn上好点，今天是第一天，后续会开启持续分享哒^_

怀念以前：记得刚毕业实现那会儿我组长叫我去学下vue,接触过半年多的前端知识，css/js/vue组件、路由、vuex、axios等等以前拿着代码一行一个注释，学的老认真了哈哈哈，那时候也真是无忧无虑好欢乐。
在这里插入图片描述
面对当下：下班健身完真的能去班味，轻松太多了，睡觉咯，明天又是新的打工day…