SpringAOP 日志打印记录

SpringAOP 日志记录

1、log4j2.yml文件配置

# 共有8个级别，按照从低到高为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF。
Configuration:
  status: warn
  monitorInterval: 30
  Properties: # 定义全局变量
    Property: # 缺省配置（用于开发环境）。其他环境需要在VM参数中指定，如下：
      #测试：-Dlog.level.console=warn -Dlog.level.xjj=trace
      #生产：-Dlog.level.console=warn -Dlog.level.xjj=info
      - name: log.level.console
        value: info
      - name: log.path
#        value: /Users/wul/logs/command-server
        value: /opt/logs/command-server
      - name: project.name
        value: command-server
      - name: log.pattern
        #   value: "%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-30.30C{1.} : %m%n"
        value: "%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-30.30C{1.} %c{1}:%L : %m%n"
  Appenders:
    Console:  #输出到控制台
      name: CONSOLE
      target: SYSTEM_OUT
      PatternLayout:
        pattern: ${log.pattern}
    #   启动日志
    RollingFile:
      - name: ROLLING_FILE
        fileName: ${log.path}/${project.name}.log
        filePattern: "${log.path}/historyRunLog/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: ${log.pattern}
        Filters:
          #        一定要先去除不接受的日志级别，然后获取需要接受的日志级别
          ThresholdFilter:
            - level: error
              onMatch: DENY
              onMismatch: NEUTRAL
            - level: info
              onMatch: ACCEPT
              onMismatch: DENY
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100个
          max: 7
      #   业务日志
      - name: BUSSINESS_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/bussiness/${project.name}_bussiness.log
        filePattern: "${log.path}/bussiness/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100个
          max: 7
      #   错误日志
      - name: EXCEPTION_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/exception/${project.name}_exception.log
        filePattern: "${log.path}/exception/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        ThresholdFilter:
          level: error
          onMatch: ACCEPT
          onMismatch: DENY
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100个
          max: 7
      #   DB 日志
      - name: DB_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/db/${project.name}_db.log
        filePattern: "${log.path}/db/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100个
          max: 7
      #   odps 日志
      - name: ODPS_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/odps/${project.name}_odps.log
        filePattern: "${log.path}/odps/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: "%m%n"
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
          SizeBasedTriggeringPolicy:
            size: "800 MB"
        DefaultRolloverStrategy:     # 文件最多100个
          max: 7
      - name: METHOD_LOG_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/methodLog/${project.name}_methodLog.log
        filePattern: "${log.path}/methodLog/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: "%m%n"
        Policies:
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
          SizeBasedTriggeringPolicy:
            size: "500 MB"
        DefaultRolloverStrategy:     # 文件最多7个
          max: 7
  Loggers:
    Root:
      level: info
      AppenderRef:
        - ref: CONSOLE
        - ref: ROLLING_FILE
        - ref: EXCEPTION_ROLLING_FILE
    Logger:
      - name: bussiness
        level: info
        additivity: false
        AppenderRef:
          - ref: BUSSINESS_ROLLING_FILE
      - name: exception
        level: debug
        additivity: true
        AppenderRef:
          - ref: EXCEPTION_ROLLING_FILE
      - name: db
        level: info
        additivity: false
        AppenderRef:
          - ref: DB_ROLLING_FILE
      - name: odps
        level: info
        additivity: false
        AppenderRef:
          - ref: ODPS_ROLLING_FILE
      - name: method_log
        level: info
        additivity: false
        AppenderRef:
          - ref: METHOD_LOG_ROLLING_FILE

#    监听具体包下面的日志
#    Logger: # 为com.xjj包配置特殊的Log级别，方便调试
#      - name: com.xjj
#        additivity: false
#        level: ${sys:log.level.xjj}
#        AppenderRef:
#          - ref: CONSOLE
#          - ref: ROLLING_FILE

2、日志实体类

import com.alibaba.fastjson.JSON;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;
import java.util.Date;

/**
 * 执行方法log
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class MtkMethodLog implements Serializable {

    /**
     * 服务名字
     */
    private String serverName;

    /**
     * 方法名称
     */
    private String methodName;

    /**
     * 接口参数
     */
    private String params;


    /**
     * 请求耗时
     */
    private Long costTime;

    /**
     * 异常
     */
    private String exception;

    /**
     * 创建时间
     */
    private Date createTime=new Date();

}

3、日志工具类

import com.zhexinit.score.enums.LogEnum;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


public class LogUtils {
    /**
     * 获取业务日志logger
     *
     * @return
     */
    public static Logger getBussinessLogger() {
        return LoggerFactory.getLogger(LogEnum.BUSSINESS.getCategory());
    }

    /**
     * 获取数据库日志logger
     *
     * @return
     */
    public static Logger getDBLogger() {
        return LoggerFactory.getLogger(LogEnum.DB.getCategory());
    }
    /**
     * 获取异常日志logger
     *
     * @return
     */
    public static Logger getExceptionLogger() {
        return LoggerFactory.getLogger(LogEnum.EXCEPTION.getCategory());
    }

    /**
     * 获取odps日志logger
     *
     * @return
     */
    public static Logger getOdpsLogger() {
        return LoggerFactory.getLogger(LogEnum.ODPS.getCategory());
    }


    public static Logger getMethodLogger(){return LoggerFactory.getLogger(LogEnum.METHOD_LOG.getCategory());}
}

4、日志枚举类

public enum LogEnum {

    BUSSINESS("bussiness"),

    DB("db"),

    EXCEPTION("exception"),

    ODPS("odps"),

    METHOD_LOG("method_log")
    ;

    private String category;

    LogEnum(String category) {
        this.category = category;
    }

    public String getCategory() {
        return category;
    }

    public void setCategory(String category) {
        this.category = category;
    }
}

5、通知切面

import com.alibaba.fastjson.JSON;
import com.zhexinit.score.log.entity.MtkMethodLog;
import com.zhexinit.score.utils.LogUtils;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.util.Arrays;

@Aspect
@Component
@Slf4j
public class AspectConfig {

    private Logger methodLogger = LogUtils.getMethodLogger();


    @Value("${spring.application.name}")
    private String serverName;

    // 切点    execution表达式
    @Pointcut(
            "execution(public * com.zt.score.filter.*.*.*(..))" +
            "||execution(public * com.zt.score.redisDao.*.*(..))" +
            "||execution(public * com.zt.score.mapper.*.*(..))" +
            "||execution(public * com.zt.score.smsparser.*.*.*(..))" +
            "||execution(public * com.zt.score.config.RedisClient.*(..))")
    private void controllerAspect() {

    }

    /**
     * 记录方法耗时和执行结果
     * @param joinPoint
     * @return
     * @throws Throwable
     */
    @Around(value = "controllerAspect()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        long beginTime = System.currentTimeMillis();
        MtkMethodLog mtkMethodLog =genMethodLog(joinPoint);
        Object result = null;
        result = joinPoint.proceed();
        long endTime = System.currentTimeMillis();
        long costTime = endTime - beginTime;
        mtkMethodLog.setCostTime(costTime);
        methodLogger.info(JSON.toJSONString(mtkMethodLog));
        return result;
    }

    /**
     * 记录异常信息
     * @param joinPoint
     * @param e
     */
    @AfterThrowing(pointcut = "controllerAspect()", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
        long beginTime = System.currentTimeMillis();
        MtkMethodLog mtkMethodLog=genMethodLog(joinPoint);
        mtkMethodLog.setException(e.toString());
        long endTime = System.currentTimeMillis();
        long costTime = endTime - beginTime;
        mtkMethodLog.setCostTime(costTime);
        methodLogger.info(JSON.toJSONString(mtkMethodLog));
    }


    private MtkMethodLog genMethodLog(JoinPoint joinPoint){
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        //全方法名
        String methodName = methodSignature.getDeclaringTypeName() + "." + methodSignature.getName();
        //接口参数
        String params = Arrays.toString(joinPoint.getArgs());

        MtkMethodLog mtkMethodLog = new MtkMethodLog();
        mtkMethodLog.setParams(params);
        mtkMethodLog.setMethodName(methodName);
        //服务名称
        mtkMethodLog.setServerName(serverName);
        return mtkMethodLog;
    }
}