SpringBoot-AOP日志

àì夳堔傛蜴生んèń 2022-04-25 01:08 213阅读 0赞

===========>**maven依赖**

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.54</version>
            <scope>compile</scope>
        </dependency>

===========> **最简单的方式,直接对Controller切点,对所有的方法进行控制**

package com.fuck.don’t CopyMe;  
import com.xxx.edu.admin.entity.TSysLog;  
import org.aspectj.lang.JoinPoint;  
import org.aspectj.lang.annotation.After;  
import org.aspectj.lang.annotation.Aspect;  
import org.aspectj.lang.annotation.Before;  
import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Component;  
import javax.servlet.http.HttpServletRequest;  
import java.util.Date;

@Aspect  
@Component  
public class LoggerHandler \{

@Autowired
    private TSysLogServcice loggerService;//日志逻辑层,增查操作
    @Autowired
    private HttpServletRequest httpServletRequest;
    
     * 记录操作controller之前记录
     * execution(* com.xxx.xxxx.web.*Controller.*(..))
     * ***MMP这个编辑器显示有问题,自行百度下语法,注解里面注意星号/点号的使用,星号(所有的包,所有的controller类下所有方法),点(两点说明参数不限),请把上述"所有"两个字替换为星号***
    @Before("execution(* com.xxx.xxxx.web.*Controller.*(..))")
    public void beforeAddLog(JoinPoint joinPoint) {
        this.addLog(joinPoint, "before");
    }
    
     * 记录操作controller之后记录
    @After("execution(* com.xxx.xxxx.web.*Controller.*(..))")
    public void afterAddLog(JoinPoint joinPoint) {
        this.addLog(joinPoint, "after");
    }
    
     * 记录日志
    public void addLog(JoinPoint joinPoint, String type) {
        TSysLog sysLog = new TSysLog();//日志实例
        sysLog.setVisitTime(new Date());//访问时间
         String username = SecurityContextHolder.getContext().getAuthentication().getName();;//通过springsecurity/shiro获取登录用户
        sysLog.setUsername(username);//登录用户的名称
        String remoteAddr = httpServletRequest.getRemoteAddr();//客户端远程ip地址
        sysLog.setIp(remoteAddr);
        Class declaringType = joinPoint.getSignature().getDeclaringType();
        String methodName = joinPoint.getSignature().getName();
        sysLog.setMethod(type + ":" + declaringType + ":" + methodName);
        loggerService.addLog(sysLog);
    	}
    	}

===========> **实际中日志需要灵活的使用,不是每个controller都要去打印,解决思路是,给日志生成一个注解,把注解设置为切点,所有的通知都以这个切点进行,给需要日志的方法加上注解即可**

package com.xxx.core;  
import java.lang.annotation.\*;  
@Retention(RetentionPolicy.RUNTIME)//什么时候使用该注解，我们定义为运行时；  
@Target(\{ElementType.METHOD\})//注解用于什么地方，我们定义为作用于方法上；  
@Documented//注解是否将包含在 JavaDoc 中；

public @interface WebLog \{

String description() default "";

package com.xxx.config;  
import com.alibaba.fastjson.JSON;  
import com.xxx.core.WebLog;  
import org.aspectj.lang.JoinPoint;  
import org.aspectj.lang.ProceedingJoinPoint;  
import org.aspectj.lang.annotation.\*;  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.context.annotation.Profile;  
import org.springframework.core.annotation.Order;  
import org.springframework.stereotype.Component;  
import org.springframework.web.context.request.RequestContextHolder;  
import org.springframework.web.context.request.ServletRequestAttributes;  
import javax.servlet.http.HttpServletRequest;  
import java.lang.reflect.Method;

@Aspect  
@Component  
@Profile(\{“dev”,“test”\})//指定开发和测试使用,生成不使用  
@Order(1)//优先级最高  
public class WebLogAspect \{

private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
    private static final String LINE_SEPARATPR = System.lineSeparator();
    
    @Pointcut("@annotation(com.xxx.core.WebLog)")//WebLog全路径
    public void WebLog() {
    }
    
    @Around("WebLog()")
    public Object doaround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
    
        long begin = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();//执行切点
        logger.info("Response args  :   {}", JSON.toJSON(result));
        logger.info("Time-consuming :   {} ms", System.currentTimeMillis() - begin);
        return result;
    }
    
    @Before("WebLog()")
    public void doBefore(JoinPoint joinPoint) throws ClassNotFoundException {
        //开始打印请求日志
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
    
        //获取wenlog注解描述的信息
        String methodDecs = getAspectLogDescription(joinPoint);
    
        logger.info("=================================start=================================");
        logger.info("url            : {}", request.getRequestURL().toString());
        logger.info("Description    : {}", methodDecs);
        logger.info("HTTP METHOD    : {}", request.getMethod());
        logger.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
        logger.info("IP             : {}", request.getRemoteAddr());
        logger.info("Request Args   : {}", JSON.toJSON(joinPoint.getArgs()));
    }
    
    /**
     * 获取切面注解的描述
     * @param joinPoint 切点
     * @return 描述信息
     * @throws ClassNotFoundException
     */
    private String getAspectLogDescription(JoinPoint joinPoint) throws ClassNotFoundException {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] args = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] methods = targetClass.getMethods();
        StringBuilder desc = new StringBuilder("");
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
                Class<?>[] classes = method.getParameterTypes();
                if (classes.length == args.length) {
                    desc.append(method.getAnnotation(WebLog.class).description());
                    break;
                }
            }
        }
        return desc.toString();
    }
    
    @After("WebLog()")
    public void doAfter() throws Throwable {
    
        logger.info("==================================end=================================="+LINE_SEPARATPR);
    }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjU1NDM3Mw_size_16_color_FFFFFF_t_70]  
注解类详细说明,转 [https://juejin.im/post/5cc68dee6fb9a0325031bd73?utm\_source=gold\_browser\_extension][https_juejin.im_post_5cc68dee6fb9a0325031bd73_utm_source_gold_browser_extension]  
如有错误,谢谢指正.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjU1NDM3Mw_size_16_color_FFFFFF_t_70]: /images/20220210/9ccb0f172d784f68bf14136be72d179a.png
[https_juejin.im_post_5cc68dee6fb9a0325031bd73_utm_source_gold_browser_extension]: https://juejin.im/post/5cc68dee6fb9a0325031bd73?utm_source=gold_browser_extension