Spring Boot中AOP结合自定义注解保存及打印请求日志

Spring Boot 中引入AOP(面向切面编程)尤为简单,添加AOP依赖即可。AOP的作用在于分离系统中的各种关注点,将核心关注点和横切关注点分离开来。更好的解耦和,提高代码的可重用性。结合注解就更加的灵活方便了。

实现步骤如下:

一、引入AOP的 pom.xml 依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

二、编写自定义注解 @Log

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {

    /**
     * 描述
     * @return
     */
    String value() default "";

    /**
     * 是否保存请求记录
     */
    boolean isRecord() default false;
    

    /**
     * 是否打印返回值
     */
    boolean isWrite() default true;


}

三、定义一个切面LogAspect

//使用@Aspect注解将一个java类定义为切面类
@Aspect
@Component
public class LogAspect {

    private Logger logger = LoggerFactory.getLogger(getClass());

    //保存记录Mapper
    @Autowired
    OperateRecordMapper operateRecordMapper;

    //使用@Pointcut定义一个切入点,可以是一个规则表达式,比如下例中某个package下的所有函数,也可以是一个注解等。
    @Pointcut("@annotation(com.xiduoduo.core.annotation.Log)")
    public void log(){}

    //使用@Before在切入点开始处切入内容
    @Before("log()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        //防止参数转换报错
        try{
            //方法名称
            String methodName = joinPoint.getSignature().getName();
            //方法参数
            String argsJsonStr = JSON.toJSONString(joinPoint.getArgs());
            logger.info("【"+methodName+"】开始执行,参数:"+argsJsonStr);
        }catch (Exception e){
            logger.error("日志参数转换异常,不影响业务逻辑!错误信息:"+e.getMessage());
        }
    }

   //使用@AfterReturning在切入点return内容之后切入内容(可以用来对处理返回值做一些加工处理)
    @AfterReturning(returning = "ret", pointcut = "@annotation(log)")
    public void doAfterReturning(JoinPoint joinPoint, Object ret, Log log) throws Throwable {
        //防止参数转换报错
        try{
            //方法名称
            String methodName = joinPoint.getSignature().getName();
            //方法参数
            String argsJsonStr = JSON.toJSONString(joinPoint.getArgs());
            String retStr = JSON.toJSONString(ret);
            //判断是否输出返回值,列表数据尽量不打印
            if(log.isWrite()){
                logger.info("【"+methodName+"】执行完毕,返回值:"+retStr);
            }else {
                logger.info("【"+methodName+"】执行完毕");
            }
            //是否保存请求记录
            if(log.isRecord()){
                OperateRecord operateRecord = new OperateRecord();
                operateRecord .setAddTime(DateUtil.getCurrentDate());
                operateRecord .setContent("[方法:"+methodName+"],[参数:"+argsJsonStr+"],[返回值:"+retStr+"]");
                operateRecordMapper.insert(operateRecord );
            }
        }catch (Exception e){
            logger.error("日志参数转换异常,不影响业务逻辑!错误信息:"+e.getMessage());
        }
    }
}

四、使用@Log注解输出日志及保存请求记录

     /**
     * 添加用户  保存请求记录,正常打印返回值
     * @param params
     * @return
     */
    @Log(isRecord = true)
    public String  addUser(String params) {
        return userService.addUser(parmas);
    }

     /**
     * 查询所有用户  不保存请求记录,不打印返回值(列表数据过多)
     * @param params
     * @return
     */
    @Log(isWrite = false)
    public String  getUserList(String params) {
        return userService.getUserList(parmas);
    }


     /**
     * 根据用户编号获取用户信息  不保存请求记录,正常打印返回值
     * @param params
     * @return
     */
    @Log
    public String  getUserByUserNo(String params) {
        return userService.getUserByUserNo(parmas);
    }


其他

一、AOP的相关概念

连接点(Joinpoint): 表示需要在程序中插入横切关注点的扩展点,连接点可能是类初始化、方法执行、方法调用、字段调用或处理异常等等,Spring只支持方法执行连接点;在AOP中表示为“在哪里干”;

切入点(Pointcut): 选择一组相关连接点的模式,即可以认为连接点的集合,Spring支持perl5正则表达式和AspectJ切入点模式,Spring默认使用AspectJ语法;在AOP中表示为“在哪里干的集合”;

通知(Advice): 在连接点上执行的行为,通知提供了在AOP中需要在切入点所选择的连接点处进行扩展现有行为的手段;包括前置通知(before advice)、后置通知(after advice)、环绕通知(around advice),在Spring中通过代理模式实现AOP,并通过拦截器模式以环绕连接点的拦截器链织入通知;在AOP中表示为“干什么”;

切面(Aspect):横切关注点的模块化,比如日志组件。可以认为是通知、引入和切入点的组合;在Spring中可以使用Schema和@AspectJ方式进行组织实现;在AOP中表示为“在哪干和干什么集合”;

引入(Introduction): 也称为内部类型声明,为已有的类添加额外新的字段或方法,Spring允许引入新的接口(必须对应一个实现)到所有被代理对象(目标对象);在AOP中表示为“干什么(引入什么)”;

目标对象(Target Object):需要被织入横切关注点的对象,即该对象是切入点选择的对象,需要被通知的对象,从而也可称为“被通知对象”;由于Spring AOP 通过代理模式实现,从而这个对象永远是被代理对象;在AOP中表示为“对谁干”;

AOP代理(AOP Proxy): AOP框架使用代理模式创建的对象,从而实现在连接点处插入通知(即应用切面),就是通过代理来对目标对象应用切面。在Spring中,AOP代理可以用JDK动态代理或CGLIB代理实现,而通过拦截器模型应用切面。

织入(Weaving): 织入是一个过程,是将切面应用到目标对象从而创建出AOP代理对象的过程,织入可以在编译期、类装载期、运行期进行。组装方面来创建一个被通知对象。这可以在编译时完成(例如使用AspectJ编译器),也可以在运行时完成。Spring和其他纯Java AOP框架一样,在运行时完成织入。

二、注解相关概念

@Target 
说明了Annotation所修饰的对象范围
取值(ElementType)有:
    1.CONSTRUCTOR:用于描述构造器
    2.FIELD:用于描述域
    3.LOCAL_VARIABLE:用于描述局部变量
    4.METHOD:用于描述方法
    5.PACKAGE:用于描述包
    6.PARAMETER:用于描述参数
    7.TYPE:用于描述类、接口(包括注解类型) 或enum声明


@Retention
定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
取值(RetentionPoicy)有:
    1.SOURCE:在源文件中有效(即源文件保留)
    2.CLASS:在class文件中有效(即class保留)
    3.RUNTIME:在运行时有效(即运行时保留)

@Documented 
用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。

等你年事稍长,就会发现,要使世界成为一个尚可容忍的生活场所,首先得承认人类的自私是不可避免的。 -- 威廉·萨默赛特·毛姆 《人生的枷锁》

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351

推荐阅读更多精彩内容