iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >SpringAOP如何获取方法参数上的注解
  • 951
分享到

SpringAOP如何获取方法参数上的注解

2024-04-02 19:04:59 951人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

springaop获取方法参数上的注解 一、示例 ① 如下代码,自定义一个参数注解@Test,并将其使用到方法参数上,用于标注需要检验的参数 @Target(PARAMETER

springaop获取方法参数上的注解

一、示例

① 如下代码,自定义一个参数注解@Test,并将其使用到方法参数上,用于标注需要检验的参数



@Target(PARAMETER)
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Test{
}

@RestController
@RequestMapping("/v1/test")
public class TestController {
    @PostMapping(value = "/email", produces = "application/JSON")
    public String send(@RequestBody @Test MailSendDTO mailSendDTO) {
        //TODO 业务处理
        return "SUCCESS";
    }
}

② 通过切面拦截该方法,从连接点获取signature,并将signature强转为MethodSignature,从而从MethodSignature对象可以获取拦截的方法对象以及方法参数注解


@Aspect
@Configuration
public class ValidateAop {
 
    
    @Pointcut("execution(public * com.laoxi.test.controller.*.*(..))")
    public void validate(){}
 
    @Before("validate()")
    public void doBefore(JoinPoint joinPoint){
        Object[] params = joinPoint.getArgs();
        if(params.length == 0){
            return;
        }
        //获取方法,此处可将signature强转为MethodSignature
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
 
        //参数注解,1维是参数,2维是注解
        Annotation[][] annotations = method.getParameterAnnotations();
        for (int i = 0; i < annotations.length; i++) {
            Object param = params[i];
            Annotation[] paramAnn = annotations[i];
            //参数为空,直接下一个参数
            if(param == null || paramAnn.length == 0){
                continue;
            }
            for (Annotation annotation : paramAnn) {
                //这里判断当前注解是否为Test.class
                if(annotation.annotationType().equals(Test.class)){
                    //校验该参数,验证一次退出该注解
                    //TODO 校验参数
                    break;
                }
            }
        }
    }
}

二、debug

通过debug代码:

可发现连接点实际为MethodInvocationProceedingJoinPoint对象,连接点中的signature则为MethodSignatureImpl对象,是MethodInvocationProceedingJoinPoint的内部类。

三、类图及源码

MethodInvocationProceedingJoinPoint类图,顶级实现了JoinPoint(以后再使用切面的时候,可以看看其他类里面都扩展了哪些方法可以直接使用)

MethodSignatureImpl类图,顶级实现了Signature(以后再使用切面的时候,可以看看其他类里面都扩展了哪些方法可以直接使用)

用AOP拦截自定义注解并获取注解属性与上下文参数(基于SpringBoot框架

AOP可以用于日志的设计,这样话就少不了要获取上下文的信息,博主在设计日志模块时考虑了一下此法,整理了一下如何用AOP来拦截你自定义的注解。

自定义注解

首先先自定义一个注解


@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Axin {
    
    String module()  default "日志模块";
 
    
    String desc()  default "无动作";
}

@Documented:注解表明制作javadoc时,是否将注解信息加入文档。如果注解在声明时使用了@Documented,则在制作javadoc时注解信息会加入javadoc。

@Target:用来说明该注解可以被声明在那些元素之前

  • @Target(ElementType.TYPE) //接口、类、枚举、注解
  • @Target(ElementType.FIELD) //字段、枚举的常量
  • @Target(ElementType.METHOD) //方法
  • @Target(ElementType.PARAMETER) //方法参数
  • @Target(ElementType.CONSTRUCTOR) //构造函数
  • @Target(ElementType.LOCAL_VARIABLE)//局部变量
  • @Target(ElementType.ANNOTATION_TYPE)//注解
  • @Target(ElementType.PACKAGE) ///包

@Retention:用来说明该注解类的生命周期。

  • @Retention(RetentionPolicy.SOURCE) —— 这种类型的Annotations只在源代码级别保留,编译时就会被忽略
  • @Retention(RetentionPolicy.CLASS) —— 这种类型的Annotations编译时被保留,在class文件中存在,但JVM将会忽略
  • @Retention(RetentionPolicy.RUNTIME) —— 这种类型的Annotations将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用.

定义切面



@Aspect
@Component
public class AxinAspect {
 
    
    @Pointcut("@annotation(Axin)")
    public void log() {
    }
 
    @Before("log()&&@annotation(axin)")
    public void doBefore(JoinPoint joinPoint,Axin axin) {
        System.out.println("******拦截前的逻辑******");
        System.out.println("目标方法名为:" + joinPoint.getSignature().getName());
        System.out.println("目标方法所属类的简单类名:" + joinPoint.getSignature().getDeclaringType().getSimpleName());
        System.out.println("目标方法所属类的类名:" + joinPoint.getSignature().getDeclaringTypeName());
        System.out.println("目标方法声明类型:" + Modifier.toString(joinPoint.getSignature().getModifiers()));
        //获取传入目标方法的参数
        Object[] args = joinPoint.getArgs();
        for (int i = 0; i < args.length; i++) {
            System.out.println("第" + (i + 1) + "个参数为:" + args[i]);
        }
        System.out.println("被代理的对象:" + joinPoint.getTarget());
        System.out.println("代理对象自己:" + joinPoint.getThis());
 
        System.out.println("拦截的注解的参数:");
        System.out.println(axin.module());
        System.out.println(axin.desc());
    }
 
    @Around("log()&&@annotation(axin)")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint,Axin axin) throws Throwable {
        System.out.println("环绕通知:");
        System.out.println(axin.module());
        System.out.println(axin.desc());
        Object result = null;
        result = proceedingJoinPoint.proceed();
        return result;
    }
 
    @After("log()")
    public void doAfter() {
        System.out.println("******拦截后的逻辑******");
    }
}

匹配规则:


//匹配AOP对象的目标对象为指定类型的方法,即DemoDao的aop的代理对象
@Pointcut("this(com.hhu.DemaoDao)")
public void thisDemo() {
    ...
}

通知类别:

前置通知(Before advice)- 在目标方便调用前执行通知

后置通知(After advice)- 在目标方法完成后执行通知

返回通知(After returning advice)- 在目标方法执行成功后,调用通知

异常通知(After throwing advice)- 在目标方法抛出异常后,执行通知

环绕通知(Around advice)- 在目标方法调用前后均可执行自定义逻辑

获取上下文信息JoinPoint

JoinPoint对象封装了SpringAop中切面方法的信息,在切面方法中添加JoinPoint参数,就可以获取到封装了该方法信息的JoinPoint对象. 注意:这用于非环绕通知

方法名 功能
Signature getSignature(); 获取封装了署名信息的对象,在该对象中可以获取到目标方法名,所属类的Class等信息
Object[] getArgs(); 获取传入目标方法的参数对象
Object getTarget(); 获取被代理的对象
Object getThis(); 获取代理对象

方法使用模板:


public void doBefore(JoinPoint joinPoint) {
System.out.println("******拦截前的逻辑******");
System.out.println("目标方法名为:" + joinPoint.getSignature().getName());
System.out.println("目标方法所属类的简单类名:" + joinPoint.getSignature().getDeclaringType().getSimpleName());
    System.out.println("目标方法所属类的类名:" + joinPoint.getSignature().getDeclaringTypeName());
    System.out.println("目标方法声明类型:" + Modifier.toString(joinPoint.getSignature().getModifiers()));
    //获取传入目标方法的参数
    Object[] args = joinPoint.getArgs();
    for (int i = 0; i < args.length; i++) {
        System.out.println("第" + (i + 1) + "个参数为:" + args[i]);
    }
    System.out.println("被代理的对象:" + joinPoint.getTarget());
    System.out.println("代理对象自己:" + joinPoint.getThis());
}

ProceedingJoinPoint

ProceedingJoinPoint对象是JoinPoint的子接口,该对象只用在@Around的切面方法中

方法名 功能
Object proceed() throws Throwable 执行目标方法
Object proceed(Object[] var1) throws Throwable 传入的新的参数去执行目标方法

定义测试方法


//Service接口
public interface AxinService {
    String axinRun(String arg1, User user);
} 
//实现类

@Component
public class AxinServiceImpl implements AxinService { 
    @Axin(module = "print",desc = "打印")
    @Override
    public String axinRun(String arg1, User user) {
        String res = arg1 + user.getName() + user.getAge();
        return res;
    }
 
    public String axinRun(String arg1, Person person) {
        String res = arg1 + person.getName() + person.getAge();
        return res;
    }
}
 
//控制类

@RestController
public class HelloController {
    @Autowired
    AxinService axinService;
 
    @RequestMapping("/hello")
    public String hello() {
        User user = new User();
        user.setAge(10);
        user.setName("张三");
        String res = axinService.axinRun("Test:", user); 
        return "Hello Spring Boot!<br>"+res;
    }
}

测试结果

环绕通知:
print
打印
******拦截前的逻辑******
目标方法名为:axinRun
目标方法所属类的简单类名:AxinService
目标方法所属类的类名:com.axin.springboot.service.AxinService
目标方法声明类型:public abstract
第1个参数为:Test:
第2个参数为:User(id=null, name=张三, age=10, date=null)
被代理的对象:com.axin.springboot.service.AxinServiceImpl@ac2ddcc
代理对象自己:com.axin.springboot.service.AxinServiceImpl@ac2ddcc
拦截的注解的参数:
print
打印
******拦截后的逻辑******

小结

通过上述的代码演示,我们可以自定义一个注解,然后配置切面来拦截有注解的方法,同时也可以获得方法传入的参数来完成你的业务需求。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。

--结束END--

本文标题: SpringAOP如何获取方法参数上的注解

本文链接: https://www.lsjlt.com/news/132095.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • SpringAOP如何获取方法参数上的注解
    SpringAOP获取方法参数上的注解 一、示例 ① 如下代码,自定义一个参数注解@Test,并将其使用到方法参数上,用于标注需要检验的参数 @Target(PARAMETER...
    99+
    2024-04-02
  • java如何获取方法上的注解
    要获取方法上的注解,可以使用Java的反射机制。以下是一种常见的方法:1. 首先,使用`Class`类的`getMethod`或`g...
    99+
    2023-09-20
    java
  • SpringAOP 如何通过JoinPoint获取参数名和值
    SpringAOP 通过JoinPoint获取参数名和值 在Java8之前,代码编译为class文件后,方法参数的类型固定,但是方法名称会丢失,方法名称会变成arg0、arg1….。...
    99+
    2024-04-02
  • SpringAOP切入点规范及获取方法参数的实现
    切入点规范 @Pointcut("execution(* com.example.server.service.TeacherService.*(..))") 上面的切入点会切...
    99+
    2024-04-02
  • springAOP中用joinpoint获取切入点方法的参数操作
    springAOP joinpoint获取切入点方法的参数 概念: 访问目标方法即用jointpoint(@around用poceedingjointpoint) 1.获取他们的目标...
    99+
    2024-04-02
  • java怎么获取方法上的注解
    在 Java 中,可以使用反射来获取方法上的注解。可以按照以下步骤获取方法上的注解: 使用 Class 对象的 getMethod...
    99+
    2023-10-24
    java
  • vue如何获取路由上的参数
    具体方法如下:通过query获取路由参数#配置路由<router-link :to="{ name:'login',query:{id:1} }">登录</...
    99+
    2024-04-02
  • Spring MVC如何使用@RequestParam注解获取参数
    目录使用@RequestParam注解获取参数@RequestParam无法获取参数使用@RequestParam注解获取参数 创建Hello控制器类 package com.c...
    99+
    2024-04-02
  • 关于aop切面注解、参数如何获取
    目录aop切面 注解、参数如何获取定义需要切面的注解在需要进行切面的方法标注注解定义切面aop中获取自定义注解的属性值自定义注解用在方法上获取注解的属性值aop切面 注解、参数如何获...
    99+
    2024-04-02
  • php如何获取类方法的参数列表
    这篇文章主要介绍“php如何获取类方法的参数列表”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“php如何获取类方法的参数列表”文章能帮助大家解决问题。php中,可用func_get_args()函数...
    99+
    2023-06-29
  • Spring spel获取自定义注解参数值方式
    目录spel获取自定义注解参数值1.注解类2.注解使用3.aop中处理 spel在注解中的使用1 语法说明2. 基本用法4 #{…}和${…}s...
    99+
    2024-04-02
  • php获取get参数乱码的解决方法
    本文将为大家详细介绍“php获取get参数乱码的解决方法”,内容步骤清晰详细,细节处理妥当,而小编每天都会更新不同的知识点,希望这篇“php获取get参数乱码的解决方法”能够给你意想不到的收获,请大家跟着小编的思路慢慢深入,具体内容如下,一...
    99+
    2023-06-06
  • Vue3获取地址栏参数方法详解
    目录一、查询参数二、路径参数三、注意点Vue3 获取地址栏参数有两个方式:查询参数和路径参数。 Vue3获取地址栏参数是从路由router中获取,查询参数和路径参数获取方式不一样。 ...
    99+
    2023-05-17
    Vue3获取地址栏参数 Vue3地址栏参数 Vue3参数
  • SpringMVC@DeleteMapping注解无法获取参数值问题及解决
    目录示例1示例2示例3示例4示例5总而言之最近在试试使用springboot编写一个demo进行测试,测试过程中发现@DeleteMapping注解有一些问题,现在汇总如下...
    99+
    2023-01-12
    SpringMVC @DeleteMapping注解 @DeleteMapping注解参数值 SpringMVC 注解
  • springmvc之获取参数的方法(必看)
    1、导包,四大核心包,一个切面包(AOP),logging,web,springmvc2、配置文件,核心代码如下:web.xml<servlet> <servlet-name>springDispatcherSer...
    99+
    2023-05-31
    springmvc 获取参数 sprin
  • JavaScript获取URL参数的方法分享
    目录一、字符串 split 方法二、使用 URLSearchParams 方法1、解析搜索字符串2、生成搜索字符串3、Node.js 代码三、使用正则匹配方法四、使用第三方库 qs一...
    99+
    2024-04-02
  • SpringMVC中的参数怎么利用注解获取
    SpringMVC中的参数怎么利用注解获取?很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。SpringMVC可以通过RequestParam注解来映射获得参数,具...
    99+
    2023-05-31
    springmvc
  • java怎么获取注解标注的方法
    可以使用反射机制来获取注解标注的方法。 首先,需要获得要获取注解的类的Class对象,可以通过类名.class或者对象.getCla...
    99+
    2023-10-26
    java
  • Java注解怎么获取请求参数值
    在Java中,可以使用反射来获取方法中的请求参数值。以下是一个示例代码:```javaimport java.lang.annota...
    99+
    2023-09-27
    Java
  • aop切面、注解和参数怎么获取
    本篇内容介绍了“aop切面、注解和参数怎么获取”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!在工作中会经常使用aop,这里将aop使用基本方...
    99+
    2023-06-26
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作