@param注解的用法解析_Spring AOP 使用注解进行校验实例（valid）

最新推荐文章于 2023-05-31 11:42:35 发布
最新推荐文章于 2023-05-31 11:42:35 发布
阅读量897 收藏
点赞数
文章标签： @param注解的用法解析 @valid注解 getmapping注解用法 jquery validate表单校验 pathvariable注解用法 requestparam注解

点击上方“Java知音”，选择“置顶公众号”

技术文章第一时间送达！

作者：CatalpaFlat

juejin.im/post/5a6301e051882573315c769d

先说明一下@PathVariable和@RequestParam两个注解的用法。

1.原版本讲解

1.1 @PathVariable

1.1.1 RESTful风格

格式：path/1/catalpaFlat eg:

@GetMapping("path/{isInt}/{isString}")
public ResponseVO pathGet(@PathVariable Integer isInt,
                          @PathVariable String isString) {
   log.info("int:" + isInt);
   log.info("String:" + isString);
  JSONObject resultJson = new JSONObject();
  resultJson.put("isInt", isInt);
  resultJson.put("isString", isString);
  return new ResponseVO(HttpStatus.OK.value(), "pathGet", resultJson);
}

request：http://localhost:8888/path/3/dadas

1.1.2 校验

代码式校验

if(isInt 2){
  return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "pathGet", "isInt must be more than 2");
}

代码式校验的话，个人觉得就有点儿不必要，除非是一些特殊需求

1.2 @RequestParam

1.2.1 表单提交(query)

格式：query?isInt=2&isString=catalpaFlat

@GetMapping("query?")
public ResponseVO queryGet(@RequestParam Integer isInt,
                           @RequestParam String isString) {
    log.info("int:" + isInt);
    log.info("String:" + isString);
    JSONObject resultJson = new JSONObject();
    resultJson.put("isInt", isInt);
    resultJson.put("isString", isString);
    return new ResponseVO(HttpStatus.OK.value(), "queryGet", resultJson);
}
1.2.2 校验

同样也需要代码式校验

if(isInt 2){
  return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "queryGet", "isInt must be more than 2");
}

因为@Valid + BindingResult只能用于@ResponseBody这种类型注解。

2. AOP改良版

可以感受到原版本都得在代码中进行校验，只要使用到@PathVariable和@RequestParam的都得进行一波参数校验，因此就想能不能像@Valid一样，为其添加注解式校验，这样代码量就减少并让代码优雅了很多。

2.1 接口层(IDAL)

以下代码再则是改良之后的代码：

  • @ParameterValid 相当于@Valid，并且在其属性中进行配置参数校验规则

  • @PathAndQueryParamValid 相当于AOP的切入点

@PathAndQueryParamValid
@GetMapping("path/{isInt}/{isString}")
public ResponseVO pathGet(@PathVariable @ParameterValid(type = Integer.class, msg = "isInt must be more than 2", isMin = true, min = 2) Integer isInt,
                          @PathVariable @ParameterValid(type = String.class, msg = "isString is empty") String isString) {
    log.info("int:" + isInt);
    log.info("String:" + isString);
    JSONObject resultJson = new JSONObject();
    resultJson.put("isInt", isInt);
    resultJson.put("isString", isString);
    return new ResponseVO(HttpStatus.OK.value(), "pathGet", resultJson);
}
@GetMapping("query")
@PathAndQueryParamValid
public ResponseVO queryGet(@RequestParam @ParameterValid(type = Integer.class, msg = "isInt must be more than 2 ", isMin = true, min = 2) Integer isInt,
                          @RequestParam @ParameterValid(type = String.class, msg = "isString is empty") String isString) {
   log.info("int:" + isInt);
   log.info("String:" + isString);
   JSONObject resultJson = new JSONObject();
   resultJson.put("isInt", isInt);
   resultJson.put("isString", isString);
   return new ResponseVO(HttpStatus.OK.value(), "queryGet", resultJson);
}

2.2 自定义注解(annotation)

2.2.1 @PathAndQueryParamValid

只是简单的用于方法类型注解：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public  @interface  PathAndQueryParamValid {
}
2.2.2 @ParameterValid

@ParameterValid 可以根据实际业务需求添加属于你的校验规则:

@Documented
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface ParameterValid {
    Class> type();

    String msg();

    boolean request() default true;

    boolean isEmpty() default true;

    boolean isBlank() default true;

    boolean isNull() default false;

    int min() default 0;
    int max() default 0;
    int[] section() default {0,0};
    boolean isMin() default false;
    boolean isMax() default false;
    boolean isSection() default false;
}

2.3 AOP切面(重点-1)

  • 通过joinPoint获取切点方法名以及类名，后续(重点)有大用

  • 通过JoinPoint获取方法的参数

  • 调用(重点2)ParamValidSupport

@Aspect
@Component
public class PathAndQueryParamValidAspect {

  private static final Logger log = LoggerFactory.getLogger(PathAndQueryParamValidAspect.class);

  @Before("@annotation(paramValid)")
  public void paramValid(JoinPoint joinPoint, PathAndQueryParamValid paramValid) {
      String className = joinPoint.getTarget().getClass().getName();
      String methodName = joinPoint.getSignature().getName();
      Object[] param = joinPoint.getArgs();
      try {
          List<String> errorLists = ParamValidSupport.get().validate(className, methodName,
                  ParameterValid.class, param);
          if (errorLists != null) {
              AdvanceResponseSupport.advanceResponse(
                      new ResponseVO(HttpStatus.BAD_REQUEST.value(), "parameter empty", errorLists));
          }
      } catch (NotFoundException | NoSuchMethodException | ClassNotFoundException e) {
          log.error("e-name：" + e.getClass().getName() + "：message：" + e.getMessage());
      }
  }
}

2.4 校验(重点-2)

  • 通过方法名和类名，根据ClassPool获取CtClass和CtMethod

  • 从而获取参数注解，解析参数注解规则进行校验参数

(这里还可以重构的，只是对int和string两种类型进行校验，还可以添加其他需求。把主要内容先呈现出来)

public class ParamValidSupport {
private static final Logger logger = LoggerFactory.getLogger(ParamValidSupport.class);

private static final String PARAM_TYPE_ERROR = "param type error";
private static final String INT_PARAM_ERROR = "Invalid interva";
private static final int INT_PARAM_TYPE_MAX_SIZE = 2;
private static final int INT_PARAM_SIZE_SUBSCRIPT_MIN = 0;
private static final int INT_PARAM_SIZE_SUBSCRIPT_MAX = 0;

private static final int STRING_SIZE = 2;
private static final char STRING_TYPE_END = '}';
private static final char STRING_TYPE_BEGIN = '{';
private static final char STRING_EMPTY_DOUBLE_CHARACTER = '"';
private static final char STRING_EMPTY_SINGLE_CHARACTER = '\'';

private static ParamValidSupport mInstance;

private ParamValidSupport() {
}

public static ParamValidSupport get() {
    if (mInstance == null) {
        synchronized (ParamValidSupport.class) {
            if (mInstance == null) {
                mInstance = new ParamValidSupport();
            }
        }
    }
    return mInstance;
}

 /**
 * 校验
 */
public List validate(String className, String methodName,
                             Class> annotationClass, Object[] args)
        throws NotFoundException, NoSuchMethodException, ClassNotFoundException {

    if (StringUtils.isBlank(className)) {
        return null;
    }
    if (StringUtils.isBlank(methodName)) {
        return null;
    }
    if (annotationClass == null) {
        return null;
    }

    ClassPool pool = ClassPool.getDefault();
    CtClass ct = pool.get(className);
    CtMethod ctMethod = ct.getDeclaredMethod(methodName);
    Object[][] parameterAnnotations = ctMethod.getParameterAnnotations();

    List errorLists = new ArrayList<>();for (int i = 0; i         Object[] parameterAnnotation = parameterAnnotations[i];
        Object param = args[i];for (Object object : parameterAnnotation) {
            Annotation annotation = (Annotation) object;
            Class extends Annotation> aClass = annotation.annotationType();if (aClass.equals(annotationClass)) {
                boolean isEmpty = ((ParameterValid) object).isEmpty();if (isEmpty) {
                    ParameterValid parameterValid = (ParameterValid) object;
                    String errorMsg = parameterValid.msg();if (Integer.class.isAssignableFrom(param.getClass())){int paramInt = (int) param;if (parameterValid.isMin() && paramInt                             errorLists.add(errorMsg);
                        }if (parameterValid.isMax() && paramInt                             errorLists.add(errorMsg);
                        }if (parameterValid.isSection()) {int[] section = parameterValid.section();if (section.length != INT_PARAM_TYPE_MAX_SIZE) {
                                logger.error(INT_PARAM_ERROR);throw new ParameterValidException(INT_PARAM_ERROR);
                            }if (!(paramInt > section[INT_PARAM_SIZE_SUBSCRIPT_MIN] && paramInt                                 errorLists.add(errorMsg);
                            } else if (!(paramInt > section[INT_PARAM_SIZE_SUBSCRIPT_MAX] && paramInt                                 errorLists.add(errorMsg);
                            }
                        }
                    }if (String.class.isAssignableFrom(param.getClass())){
                        String paramStr = (String) param;if (parameterValid.isNull()) {if (StringUtils.isEmpty(paramStr)) {
                                errorLists.add(errorMsg);
                            }
                        } else {if (parameterValid.isBlank()) {if (StringUtils.isBlank(paramStr)) {
                                    errorLists.add(errorMsg);
                                } else {int length = paramStr.length();char begin = paramStr.charAt(0);char end = paramStr.charAt(length - 1);if (STRING_TYPE_BEGIN == begin &&
                                            STRING_TYPE_END == end) {
                                        errorLists.add(errorMsg);
                                    }if (length == STRING_SIZE && STRING_EMPTY_DOUBLE_CHARACTER == begin
                                            && STRING_EMPTY_DOUBLE_CHARACTER == end) {
                                        errorLists.add(errorMsg);
                                    }if (length == STRING_SIZE && STRING_EMPTY_SINGLE_CHARACTER == begin
                                            && STRING_EMPTY_SINGLE_CHARACTER == end) {
                                        errorLists.add(errorMsg);
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }if (errorLists.size() != 0) {return errorLists;
    }return null;
}
}

2.4 测试结果

521b55f45a6a3c7ec6e171f734e80ce7.png

92f6f4f7607d884f82018ccd6be58396.png

15508990d09a372490e55e63fd16f088.png

be142a444c2819de54d1e8a29660dafd.png

END

Java面试题专栏

【30期】说一下HashMap的实现原理？ 【29期】Java集合框架 10 连问，你有被问过吗？ 【28期】ZooKeeper面试那些事儿 【27期】Dubbo面试八连问，这些你都能答上来吗？ 【26期】如何判断一个对象是否存活?(或者GC对象的判定方法)? 【25期】这三道常见的面试题，你有被问过吗？ 【24期】请你谈谈单例模式的优缺点,注意事项,使用场景 【23期】请你谈谈关于IO同步、异步、阻塞、非阻塞的区别 【22期】为什么需要消息队列？使用消息队列有什么好处？ 【21期】你能说说Java中Comparable和Comparator的区别吗

8e0d660ae19f2d034bd7e2a8328a34fe.png

我知道你 “在看”ddc24d641207cc4fdad55193c4d4eedb.png

weixin_39854681
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
小议Java中@param注解与@see注解的作用
09-03
主要介绍了Java中@param注解与@see注解的作用,注解的功能类似于通常代码中的注释,需要的朋友可以参考下
Loadrunner中web_reg_save_param的使用详解
02-04
应用范围　　在使用Loadrunner进行性能测试时，经常遇到一种情况，需要通过web页面修改某事务的状态。于是需要首先读出当前的事务的状态，再进行修改，此时便可以使用到web_reg_save_param了。可以通过它先将事务的状态读出写入一个自定义的变量中，根据变量的值来决定下一步的动作。　简要说明　　语法：intweb_reg_save_param(constchar*ParamName,<listofAttributes>,LAST);　参数说明:ParamName:存放得到的动态内容的参数名称listofAttributes:其它属性，包括：Notfound,LB,RB,RelFra
Mybatis使用@param注解四种情况解析
09-07
主要介绍了Mybatis使用@param注解四种情况解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Java中使用注解校验参数
BruceBupt的博客
02-09 9169
一、参数校验的注解 Java中参数校验的注解来自三方面，分别是 javax.validation:validation-api，对应包javax.validation.constraints org.springframework:spring-context，对应包org.springframework.validation org.hibernate:hibernate-validator，对应包org.hibernate.validator.constraints 1.啊 validatio
自定义注解实现参数校验
qq_62939743的博客
12-19 2489
为什么要进行参数校验、如何进行参数校验、如何里用注解进行参数校验、自定义注解实现参数校验，由浅入深，基于SpringBoot实现
@ParamsValidate 一 入门
CodingSoldier的博客
01-20 2930
@ParamsValidate系列教程 https://blog.csdn.net/u010606397/article/category/7689866 web后端校验请求参数是一个很常用的功能，java web普遍使用spring validation来校验。我自己也写了一个校验请求参数的库params-validate，跟spring validation相比还是有些小优点的，比如： 1...
实现@RequestParam参数值校验
Jeffrey_oWang的博客
11-29 3755
需求描述： 在项目的实际的编写过程当中，通过JSR303针对于@RequestBody 可以进行参数的数据校验，但是如果是通过@RequestParam 或者是@PathVeriable 进行传值却没有什么很好的数据校验方式，通常只能通过： if("".equals(message) || message == null){ ​ throw new RuntimeException(“Bad Request”); } 进行校验，所以想要编写一套注解实现对于@RequestParam 和@RequestPa
@param详解注解
SOBE_rrr的博客
03-30 7025
这是最常见的需要添加 @Param 注解的场景。
java valid_详解Spring AOP 实现“切面式”valid校验
weixin_36256361的博客
02-20 481
why:为什么要用aop实现校验？answer:spring mvc 默认自带的校验机制 @Valid + BindingResult, 但这种默认实现都得在Controller方法的中去接收BindingResult，从而进行校验.eg:if (result.hasErrors()) {List allErrors = result.getAllErrors();List errorlists ...
JAVA 反射+注解实现参数必输项校验 -- 不让框架成为瓶颈
haizhuang_bu的博客
09-27 646
背景: 日常开发中,会经常遇到参数校验的问题. 大量的if _ else 会使代码可读性变差,后期维护变得异常艰难. 对于开发者而言,不仅仅是单纯的功能实现.设计出简洁通熟易懂的代码更应该是开发者不可推卸的责任.
mybatis多个接口参数的注解使用方式（@Param)
08-26
主要介绍了mybatis多个接口参数的注解使用方式（@Param),小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Spring Boot中Spring data注解的使用
12-14
文章目录Spring Data Annotations@Transactional@NoRepositoryBean@Param@Id@...Spring Boot中Spring data注解的使用 Sring data JPA为我们提供了很多有用的注解，方便我们来实现各种复杂的功能。本文我们将会从Spr
SpringBoot整合Validation进行参数校验
chy1984的博客
11-22 3361
可以用正则表达式进行校验，示例@Pattern(regexp = "^[1][3-9][0-9]{9}$", message = "手机号为空或格式错误")
Spring Boot 参数校验终极指南，写得太好了！
m0_73311735的博客
05-31 1017
作为后端来讲，对于前端传来的数据，需要保持高度的警惕。避免出现异常数据，导致系统异常。统一参数校验和自定义校验注解，可以帮助我们更加优雅和严格的完成参数校验，减少出错的概率。/*** 账户名*/@Email(message = "邮箱格式有误")@NotBlank(message = "账户名称不能为空")@ApiModelProperty(notes = "账户名", required = true)随着业务的发展碰上了多语言，多区域，原本的参数错误提示语就不太够用了。
Springboot中接口参数校验N种方法你会几个？
asoklove的专栏
08-04 1416
环境：springboot2.2.10.RELEASE Spring Validation验证框架对参数的验证机制提供了@Validated（Spring's JSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），结合BindingResult对象可以直接获取错误信息。 JSR是什么？ JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新
FastAPI入门篇一Query参数与字符串验证
qczxl520的博客
10-23 1261
让我们看下面的例①： from typing import Optional from fastapi import FastAPI app = FastAPI() @app.get("/items/") async def read_items(q: Optional[str] = None): results = {"items": [{"item_id": "apple"}]} if q: results.get('items').append({"item_i
@Param和 @PathParam
Mr. Ding的小博客
06-08 3975
前言 后端接受前端传递的参数，有常用的两种方式，@Param和 @PathParam, post请求------@Param get请求-----@PathParam 一、 @Param 1.关于@Param @Param是MyBatis所提供的(org.apache.ibatis.annotations.Param)，作为Dao层的注解，作用是用于传递参数，从而可以与SQL中的的字段名相对应，一般在2=<参数数<=5时使用最佳。 2.使用@Param 2.1 方式一 /** *
@Param注解原理
weixin_38954520的博客
02-05 2475
大部分文章告诉你在Mapper接口的方法参数上使用@Param注解，可是有的时候不用也没有问题，还有的时候用了@Param注解也还是报错，今天我们探究下这个注解原理，以后你碰到这个问题就不再懵逼了。
keil5安装程序（包含keygen）
最新发布
05-21
keil5安装程序（包含keygen）适用于单片机学习
@Param注解的用法解析
05-17
除此之外，@Param注解还可以用于描述参数的类型、默认值、是否必填等信息，具体使用方法可以根据实际需求来进行设置。 除了方法参数上使用@Param注解，它还可以用于类的属性上，用来描述属性的信息。例如： ```...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值