SpringBoot基于Aop自定义Slf4j日志输出格式

需求

当线上服务或者接口出现异常之后，第一时间需要做的就是追踪日志，找出问题到底出现在哪里，但是在现有的分布式及微服务的背景下，一个请求的调用链往往比较的长，所以一般情况下会选择使用一个请求的唯一ID输出为日志，然后便于日常运维过程的问题追踪，如何优雅自如的自定义一个log输出呢？下面使用AOP加上logback来给一个简单优雅的方式；解放双手，告别体力活。

Aop

这里不做AOP的介绍。除了使用AOP也可以使用Filter去做，不管是AOP还是Filter，目的就是在请求来的时候将其拦住，然后往MDC中塞入自定义的一一些属性，即可实现自定义的变量输出

何为MDC？

这里的MDC就是一个工具类，其本质就是使用ThreadLocal将自定义的变量存储起来，这么一说相信各位就知道这个自定义参数的套路了；请求之前将请求拦截，将自定义的属性值存进去；业务过程中，如果打印日志，就将本地ThreadLocal中自定义的属性一起输出。其实原理就这么简单，具体要如何输出，要输出什么，就得看你自己的骚操作了！！！

配置

• logback-spring.xml

  
  
  
      
  
      
      
      
      
  
      
      
      
      encoder
  
      
          
              ${PATTERN}
              UTF-8
          
      
  
      
      
          
          
          
          
              
              ${OPEN_FILE_PATH}/${APP_NAME}/all/${APP_NAME}.%d{yyyy-MM-dd}-%i.log.zip
              
              30
              10GB
              
                  
                  100MB
              
          
  
          
              ${PATTERN}
          
      
  
      
      
          
              ${OPEN_FILE_PATH}/${APP_NAME}/debug/${APP_NAME}.%d{yyyy-MM-dd}-%i.log.zip
              30
              10GB
              
                  100MB
              
          
          true
          
              ${PATTERN}
              utf-8
          
          
              DEBUG
              ACCEPT
              DENY
          
      
  
      
      
          
              ${OPEN_FILE_PATH}/${APP_NAME}/info/${APP_NAME}.%d{yyyy-MM-dd}-%i.log.zip
              30
              10GB
              
                  100MB
              
          
          true
          
              ${PATTERN}
              utf-8
          
          
              INFO
              ACCEPT
              DENY
          
      
  
      
      
          
              ${OPEN_FILE_PATH}/${APP_NAME}/error/${APP_NAME}.%d{yyyy-MM-dd}-%i.log.zip
              30
              10GB
              
                  100MB
              
          
          true
          
              ${PATTERN}
              utf-8
          
          
              ERROR
              ACCEPT
              DENY
          
      
  
      
      
          
              ${OPEN_FILE_PATH}/${APP_NAME}/warn/${APP_NAME}.%d{yyyy-MM-dd}-%i.log.zip
              30
              10GB
              
                  100MB
              
          
          true
          
              ${PATTERN}
              utf-8
          
          
              WARN
              ACCEPT
              DENY
          
      
  
      
          
          
          
          
          
          
      
  
  

• 要关注的配置

  // 将此日志拷贝到resources目录下
  // 此文只需要关注下面这一行配置，其他的可以忽略不用看
  
  // 
  //
  // [%X{IP}]  自定义的IP输出
  // [%X{RequestId}] 自定义的请求唯一ID
  // [%X{RequestURI}] 自定义的请求地址输出
  // [%X{ThreadId}] 自定义的线程Id的输出
  // 这里可以根据自己的需要，做任何自己想要的自定义参数配置
  

配置切面

• 引入aop的jar

  
       org.springframework.boot
       spring-boot-starter-aop
  
  

• 拦截所有的controller

  @Aspect
  @Component
  @Order(0) // 切面的顺序，越小越优先，对于多个切面Spring是使用责任链的模式 为了一开始将日志相关的参数初始化好，这里设置为最优先执行
  public class LogInfoInitAspect
  {
      // 请求唯一ID
      private final String RequestId = "RequestId";
      // 请求的地址
      private final String RequestURI = "RequestURI";
      // 请求的线程ID
      private final String ThreadId = "ThreadId";
      // 请求的IP
      private final String IP = "IP";
  
      // 这里最好使用环绕通知，在执行完之后 将MDC中设置的值清空
      // 如果不使用环绕通知的话，可以使用Before设置值；使用After来清除值
      // 意思是将com.你的包路径.controller目录下以Controller结尾类的方法调用全部织入下面的代码块
      @Around("within(com.你的包路径.controller..*Controller)")
      public Object initLogInfoController(ProceedingJoinPoint joinPoint) throws Throwable
      {
          // 请求对象
          HttpServletRequest request = ((ServletRequestAttributes) getRequestAttributes()).getRequest();
          // 响应对象
          HttpServletResponse response = ((ServletRequestAttributes) getRequestAttributes()).getResponse();
  
          // 获取客户端的IP
          String clientIP = getClientIP(request);
          if (StringUtils.isNotBlank(clientIP))
          {
              MDC.put(IP, clientIP);
          }
  
          // 获取执行当前创作的 线程
          Thread thread = Thread.currentThread();
          // 设置线程ID
          MDC.put(ThreadId, String.valueOf(thread.getId()));
  
          // 获取请求地址
          String requestURI = request.getRequestURI();
          // 设置请求地址
          MDC.put(RequestURI, requestURI);
  
          // 生成当前请求的一个唯一UUID
          String requestId = UUID.randomUUID().toString();
          // 设置请求的唯一ID
          MDC.put(RequestId, requestId);
          // 将次唯一ID设置为响应头
          response.setHeader(RequestId, requestId);
  
          Object object = null;
          try
          {
              // 调用目标方法
              object = joinPoint.proceed();
              return object;
          }
          catch (Throwable throwable)
          {
              throwable.printStackTrace();
              throw throwable;
          }
          finally
          {
              // 注意，这里一定要清理掉
              // 否则可能会出现OOM的情况
              MDC.clear();
          }
      }
  
      /**
       * 在request中获取到客户端的IP
       *
       * @param request
       * @return
       */
      public String getClientIP(HttpServletRequest request)
      {
          String ip = request.getHeader("x-forwarded-for");
          if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
          {
              ip = request.getHeader("Proxy-Client-IP");
          }
          if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
          {
              ip = request.getHeader("WL-Proxy-Client-IP");
          }
          if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
          {
              ip = request.getRemoteAddr();
          }
          return ip;
      }
  }
  

• 测试

  @RestController
  @RequestMapping("/test")
  @Slf4j
  public class TestController
  {
  
      @GetMapping("/lt")
      public String logTest()
      {
          log.info("我是测试日志");
          return "1";
      }
  }
  

  

  file

END！！！