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 实现自定义注解的资料请关注脚本之家其它相关文章!

相关文章

  • Spring RestTemplate简化HTTP通信实现功能探究

    Spring RestTemplate简化HTTP通信实现功能探究

    这篇文章主要为大家介绍了Spring框架中的RestTemplate,如果你是个Java程序员,那么你肯定知道Spring框架的重要性,在Spring的众多工具中,RestTemplate是用来简化HTTP通信的一个强大工具
    2024-01-01
  • 详解Java中JSON数据的生成与解析

    详解Java中JSON数据的生成与解析

    今天给大家带来的是关于Java的相关知识,文章围绕着Java中JSON数据的生成与解析展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • 如何将默认的maven仓库改为阿里的maven仓库

    如何将默认的maven仓库改为阿里的maven仓库

    这篇文章主要介绍了如何将默认的maven仓库改为阿里的maven仓库,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • Java NIO 中 Selector 解析

    Java NIO 中 Selector 解析

    这篇文章主要介绍了Java NIO 中 Selector,Selector即选择器,选择器提供选择执行已经就绪的任务的能力即为翻译为多路复用,下面文章对Selector详细介绍内容,需要的小伙伴可以参考一下
    2022-02-02
  • JAVA递归与非递归实现斐波那契数列

    JAVA递归与非递归实现斐波那契数列

    这篇文章主要为大家详细介绍了JAVA递归与非递归实现斐波那契数列,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-02-02
  • 浅谈java object对象在heap中的结构

    浅谈java object对象在heap中的结构

    本文主要介绍了浅谈java object对象在heap中的结构,感兴趣的同学,可以参考下。
    2021-06-06
  • @Autowired注解以及失效的几个原因图文详解

    @Autowired注解以及失效的几个原因图文详解

    在微服务项目中,会遇到@Autowired注解失效的情况,下面这篇文章主要给大家介绍了关于@Autowired注解以及失效的几个原因的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-03-03
  • java数据库连接池的特点及步骤

    java数据库连接池的特点及步骤

    大家好,本篇文章主要讲的是数据库连接池的特点及步骤,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下,方便下次浏览
    2021-12-12
  • SpringBoot项目中集成Apollo的方法步骤

    SpringBoot项目中集成Apollo的方法步骤

    本文主要介绍了SpringBoot项目中集成Apollo的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-10-10
  • Java 调整格式日志输出

    Java 调整格式日志输出

    本文主要介绍Java 的日志输出格式,在开发java的时候会经常看日志进行调试或者查看错误,这里给大家介绍日志输出调整格式,以便大家看日志的时候更加方便,
    2016-07-07

最新评论