【springboot系列】springboot整合aop实现日志记录

WalkerShen

已于 2022-07-26 17:50:49 修改

阅读量1k

点赞数

分类专栏： springboot系列文章标签： spring boot java spring

于 2022-01-28 11:45:55 首次发布

本文链接：https://blog.csdn.net/Think_and_work/article/details/122729080

版权

springboot系列专栏收录该内容

33 篇文章 2 订阅

订阅专栏

大家好，我是walker
一个从文科自学转行的程序员~
爱好编程，偶尔写写编程文章和生活
欢迎关注公众号【I am Walker】，回复“电子书”，就可以获得200多本编程相关电子书哈~
我的gitee：https://gitee.com/shen-chuhao/walker.git 里面很多技术案例！

知识概况

定义：在软件业，AOP为Aspect Oriented Programming的缩写，意为：面向切面编程，通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

处理时机

@Around

@Around注解用于修饰Around增强处理，Around增强处理非常强大，表现在：

@Around可以自由选择增强动作与目标方法的执行顺序，也就是说可以在增强动作前后，甚至过程中执行目标方法。这个特性的实现在于，调用ProceedingJoinPoint参数的procedd()方法才会执行目标方法。
@Around可以改变执行目标方法的参数值，也可以改变执行目标方法之后的返回值。

@Before

@Before 注解指定的方法在切面切入目标方法之前执行，可以做一些 Log 处理，也可以做一些信息的统计，比如获取用户的请求 URL 以及用户的 IP 地址等等，这个在做个人站点的时候都能用得到，都是常用的方法。

@After

@After 注解和 @Before 注解相对应，指定的方法在切面切入目标方法之后执行，也可以做一些完成某方法之后的 Log 处理。

@AfterReturning

@AfterReturning 注解和 @After 有些类似，区别在于 @AfterReturning 注解可以用来捕获切入方法执行完之后的返回值，对返回值进行业务逻辑上的增强处理

@AfterThrowing

当被切方法执行过程中抛出异常时，会进入 @AfterThrowing 注解的方法中执行，在该方法中可以做一些异常的处理逻辑。要注意的是 throwing 属性的值必须要和参数一致，否则会报错。该方法中的第二个入参即为抛出的异常。

场景

给指定的controller添加日志

1、导入依赖

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

这里不需要在启动类添加@EnableXXX,，因为spring.aop.auto属性默认是开启的，也就是说只要引入了AOP依赖后，默认已经增加了@EnableAspectJAutoProxy。

2、配置切面类

package com.walker.config.aspect;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

@Aspect //切面类注解
@Component //容器类注解
@Slf4j
public class WebLogAspect {

    //切入点   
    @Pointcut("execution(public * com.walker.interfaces.client.*.*(..))")
    public void controllerLog() {  //签名  切入点名称
    }
    
    

    //切入前
    @Before("controllerLog()") 
    //参数 JoinPoint
    public void beforeLog(JoinPoint joinPoint) throws Throwable {
        log.info("getSignature{}", joinPoint.getSignature());
        log.info("getTarget{}", joinPoint.getTarget());
        log.info("getStaticPart{}", joinPoint.getStaticPart());
        log.info("getArgs{}", joinPoint.getArgs());
        log.info("getKind{}", joinPoint.getKind());
        log.info("getSourceLocation{}", joinPoint.getSourceLocation());
        log.info("getThis{}", joinPoint.getThis());


        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
        log.info("getRequestURL:{}", request.getRequestURL());
        log.info("getMethod:{}", request.getMethod());
        log.info("getAuthType:{}", request.getAuthType());
        log.info("getRemoteAddr:{}", request.getRemoteAddr());

    }

}

使用注解添加日志

1、定义注解

package com.walker.common.config;

import java.lang.annotation.*;

@Target(ElementType.METHOD) //目标作用于方法
@Retention(RetentionPolicy.RUNTIME) //运行时
@Documented //生成文档，也可以不加
public @interface LogAno {
    
    
    //这里可以添加参数，可以用来记录来自哪些类型的日志
    String desc() default ""; //描述
}

2、定义切面类

package com.walker.common.config;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.aspectj.lang.reflect.SourceLocation;
import org.springframework.stereotype.Component;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedType;
import java.lang.reflect.Method;


@Aspect //1、定义切面类
@Component
@Slf4j
public class LogAspect {


    //2、定义切入点
    /**
     *  切入点可以定义controller
     *  也可以定义注解
     */
    @Pointcut("@annotation(com.walker.common.config.LogAno)")
    public void logPointCut(){

    }

    //3、定义处理事件,这里是before事件
    @Before(value ="logPointCut()")
    public void logTest(JoinPoint joinPoint){

        //JoinPoint: 连接点  可以在这个类中获取对应的注解参数和方法参数 
        log.info("=======使用注解aop输出日志========");
        Object[] args = joinPoint.getArgs();
        log.info("方法参数：{}",args);
        /**
         * 普通Signature
         */
        Signature signature = joinPoint.getSignature();
        String declaringTypeName = signature.getDeclaringTypeName();
        String name = signature.getName();
        log.info("调用类名：{}",declaringTypeName);
        log.info("方法名称: {}",name);


        /**
         * methodSignature
         */
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method method = methodSignature.getMethod();
        LogAno annotation = method.getAnnotation(LogAno.class);
        String desc = annotation.desc();
        log.info("注解参数: {}",desc);
        String name1 = method.getName();
        log.info("方法名称：{}",name1);
    }
}

3、使用测试

package com.walker.controller;

import com.walker.common.config.LogAno;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/log")
@Slf4j
public class LogAspectController {

    @GetMapping("/test")
    @LogAno(desc = "你好好哈哈哈哈")
    public String test(String name){
      log.info("hello {}",name);
      return "hello";
    }
}

参考文章
https://blog.csdn.net/q982151756/article/details/80513340
https://www.cnblogs.com/FuYingju/p/14371969.html

WalkerShen

关注

0
点赞
踩
4

收藏

觉得还不错? 一键收藏
打赏
2
评论
【springboot系列】springboot整合aop实现日志记录

知识概况定义：在软件业，AOP为Aspect Oriented Programming的缩写，意为：面向切面编程，通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。相关概念Aspect（切面）Aspect 声明类似于 Java 中的类声明，在 Asp
复制链接

扫一扫