Spring AOP 实现自定义注解的示例

 更新时间:2021年03月31日 10:12:39   作者:bridgeli  
这篇文章主要介绍了Spring AOP 实现自定义注解的示例,帮助大家更好的理解和学习使用spring框架,感兴趣的朋友可以了解下

自工作后,除了一些小项目配置事务使用过 AOP,真正自己写 AOP 机会很少,另一方面在工作后还没有写过自定义注解,一直很好奇注解是怎么实现他想要的功能的,刚好做项目的时候,经常有人日志打得不够全,经常出现问题了,查日志的才发现忘记打了,所以趁此机会,搜了一些资料,用 AOP + 自定义注解,实现请求拦截,自定义打日志,玩一下这两个东西,以下是自己完的一个小例子,也供需要的同学参考。

1. 注解如下:

package cn.bridgeli.demo.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * @author bridgeli
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    /**
     * 方法描述
     *
     * @return
     */
    String desc() default "";
}

2. 切面

package cn.bridgeli.demo.annotation;
 
import cn.bridgeli.utils.AuthorizeUtil;
import cn.bridgeli.entity.Principal;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
 
/**
 * @author bridgeli
 * 1. 这是一个切面类
 */
@Aspect
@Component
@Slf4j
public class MyLogAspect {
 
    /**
     * 2. PointCut表示这是一个切点,@annotation表示这个切点切到一个注解上,后面带该注解的全类名
     * 切面最主要的就是切点,所有的故事都围绕切点发生
     * logPointCut()代表切点名称
     */
    @Pointcut("@annotation(cn.bridgeli.demo.annotation.MyLog)")
    public void logPointCut() {
    }
 
    /**
     * 3. 环绕通知
     *
     * @param joinPoint
     * @param myLog
     * @return
     */
    @Around(value = "logPointCut() && @annotation(myLog)", argNames = "joinPoint,myLog")
    public Object logAround(ProceedingJoinPoint joinPoint, MyLog myLog) {
        // 获取方法名
        String methodFullPathName = joinPoint.getTarget().getClass().getName() + "#" + joinPoint.getSignature().getName();
 
        // 获取参数
        String params = StringUtils.join(joinPoint.getArgs(), ";");
 
        Principal currentUser = AuthorizeUtil.getCurrentUser();
        log.info("当前登陆用户:" + (null == currentUser ? "" : currentUser.toString()) + ",进入 [ " + methodFullPathName + " ] 方法, 方法的描述:" + myLog.desc() + ",参数为:" + params);
 
        // 继续执行方法
        long startTime = System.currentTimeMillis();
        Object result = null;
        try {
            result = joinPoint.proceed();
        } catch (Throwable e) {
            log.error("切面执行报错,参数:" + params, e);
        }
        long elapsed = System.currentTimeMillis() - startTime;
 
        log.info("[ " + methodFullPathName + " ] 方法执行结束,返回值为:" + (null == result ? "" : result.toString()) + ",用时:" + elapsed);
 
        return result;
    }
}

然后只需要在想使用的地方 @MyLog 就可以了,当然也可以加上 @MyLog(desc = “这是方法描述”),这样打出来的日志还会有方法是做什么的,别人看日志的时候能够一目了然。

需要说明的是,我在写这个切面的时候遇到的一个小问题,在网上看 AOP 的注解,很多人在举例子的时候都是不关注 @Around 的返回值,所以方法的返回值都写的 void,因为我对 AOP 也不是很熟,所以当时同样写了一个 void,结果写好一测试,返回拦截也正常,日志也打印了,被拦截的方法执行也挺正常,但是就是没有了返回值,当时还很奇怪,然后随便试了下返回值改成 Object,竟然对了,所以这是一个小坑,也是很多人没有说明的一点,大家可以注意下,其实这个问题也很容易想到,@Around 是环绕拦截,在执行完被拦截的方法之后,会继续执行切面方法,如果切面方法没有返回值,那么自然而然就没有返回值了,同理 @After 拦截个人猜测也应该有同样的问题,大家可以测试下。

以上就是Spring AOP 实现自定义注解的示例的详细内容,更多关于Spring AOP 实现自定义注解的资料请关注脚本之家其它相关文章!

相关文章

  • IDEA Reformat Code 格式化代码(详解)

    IDEA Reformat Code 格式化代码(详解)

    平时使用Ctrl+Alt+L可以格式化代码,idea帮你整理空格,换行等,让代码看起来更整洁,今天通过本文给大家分享IDEA Reformat Code 格式化 的过程,感兴趣的朋友一起看看吧
    2023-11-11
  • 深入解析Java编程中方法的参数传递

    深入解析Java编程中方法的参数传递

    这篇文章主要介绍了Java编程中方法的参数传递,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-10-10
  • SpringBoot超详细讲解@Value注解

    SpringBoot超详细讲解@Value注解

    在使用spring框架的项目中,@Value是经常使用的注解之一。作用是将配置文件中的键对应的值分配给某类内带注解的属性。本文使您系统地了解@Value的用法。在使用Spring框架的项目中@Value是经常使用的注解之一,其作用是将配置文件中的键对应的值分配给某类内带注解的属性
    2022-07-07
  • Java8中LocalDateTime与时间戳timestamp的互相转换

    Java8中LocalDateTime与时间戳timestamp的互相转换

    这篇文章主要给大家介绍了关于Java8中LocalDateTime与时间戳timestamp的互相转换,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • Dependency ‘XXX:‘ not found问题的三步解决

    Dependency ‘XXX:‘ not found问题的三步解决

    这篇文章主要介绍了Dependency ‘XXX:‘ not found问题的三步解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • 通过代理类实现java连接数据库(使用dao层操作数据)实例分享

    通过代理类实现java连接数据库(使用dao层操作数据)实例分享

    java通过代理类实现数据库DAO操作代码分享,大家参考使用吧
    2013-12-12
  • Spring与bean有关的生命周期示例详解

    Spring与bean有关的生命周期示例详解

    这篇文章主要给大家介绍了关于Spring与bean有关的生命周期的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者使用Spring具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2020-07-07
  • 详解Spring框架下向异步线程传递HttpServletRequest参数的坑

    详解Spring框架下向异步线程传递HttpServletRequest参数的坑

    这篇文章主要介绍了详解Spring框架下向异步线程传递HttpServletRequest参数的坑,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • 解决线程并发redisson使用遇到的坑

    解决线程并发redisson使用遇到的坑

    这篇文章主要介绍了解决线程并发redisson使用遇到的坑,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • java BigDecimal精度丢失及常见问分析

    java BigDecimal精度丢失及常见问分析

    这篇文章主要为大家介绍了java BigDecimal精度丢失及常见问分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02

最新评论