【SpringBoot】SpringBoot(2.1.1)日志打印及全局日志处理(六)

1.概述

默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台。

从上图可以看到,日志输出内容元素具体如下:

  • 时间日期:精确到毫秒
  • 日志级别:ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID
  • 分隔符:— 标识实际日志的开始
  • 线程名:方括号括起来(可能会截断控制台输出)
  • Logger名:通常使用源代码的类名
  • 日志内容

1.1添加日志依赖

spring-boot-starter 其中包含了 spring-boot-starter-logging ,该依赖内容就是 Spring Boot 默认的日志框架 logback,

所以实际开发中我们不需要直接添加该依赖。


 
 org.springframework.boot
 
 spring-boot-starter-logging
 

1.2控制台输出

日志级别从低到高分为:

1

TRACE < DEBUG < INFO < WARN < ERROR < FATAL 。

如果设置为 WARN ,则低于 WARN 的信息都不会输出。

Spring Boot 中默认配置 ERROR 、 WARN 和 INFO 级别的日志输出到控制台。

您还可以通过启动您的应用程序 --debug 标志来启用“调试”模式(开发的时候推荐开启),以下两种方式皆可:

  • 在运行命令后加入 --debug 标志,如: $ java -jar springTest.jar --debug
  • 在 application.properties 中配置 debug=true ,该属性置为 true 的时候,核心 Logger (包含嵌入式容器、hibernate、spring)会输出更多内容,但是你 自己应用的日志并不会输出为 DEBUG 级别 。

【SpringBoot】SpringBoot(2.1.1)日志打印及全局日志处理(六)_第1张图片

如果每次都写这行代码会很麻烦,可以使用注解,但是需要使用 lombok :

  • 添加依赖:
 
            org.projectlombok
            lombok
            true
  • idea安装 lombok 的插件:

允许注解处理,Settings -> Compiler -> Annotation Processors

@Sif4相当于

 private  final Logger log= LoggerFactory.getLogger(LoggerTest.class);

@Slf4j
@RestController
public class HelloController {
 
    @RequestMapping("/hello")
    public String hello() {
        //加上@Slf4j,直接使用log变量
        log.info("打印日志");
        return "Hello";
    }
}

1.3 文件输出

默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。

使用 Spring Boot 喜欢在 application.properties 或 application.yml 配置,这样只能配置简单的场景,保存路径、日志格式等,复杂的场景(区分 info 和 error 的日志、每天产生一个日志文件等)满足不了,只能自定义配置,下面会演示。

logging:
  pattern:
    #格式化,只能输出日期和内容
    console: "%d - %msg%n"

配置日志输出位置 比如磁盘 e盘

logging:
  pattern:
    console: "%d - %msg%n"
  path: e:/

默认会在设置的 path 生成一个 spring.log 文件。

配置日志输出文件 ,指定文件名

    logging:
      pattern:
        #格式化,只能输出日期和内容
        console: "%d - %msg%n"
#        配置日志输出位置
      path: e:/
#      配置日志输出文件 ,指定文件名
      file: e:/sell.log

如果要编写除控制台输出之外的日志文件,则需在 application.properties 中设置 logging.file 或 logging.path 属性。

  • logging.file ,设置文件,可以是绝对路径,也可以是相对路径。如: logging.file=my.log
  • logging.path ,设置目录,会在该目录下创建 spring.log 文件,并写入日志内容,如: logging.path=/var/log

如果只配置 logging.file ,会在项目的当前路径下生成一个 xxx.log 日志文件。

如果只配置 logging.path ,在 /var/log 文件夹生成一个日志文件为 spring.log

注:二者不能同时使用,如若同时使用,则只有 logging.file 生效

默认情况下,日志文件的大小达到 10MB 时会切分一次,产生新的日志文件,默认级别为: ERROR、WARN、INFO

1.4 级别控制

所有支持的日志记录系统都可以在 Spring 环境中设置记录级别(例如在 application.properties 中)

格式为: 'logging.level.* = LEVEL'

logging.level :日志级别控制前缀,*为包名或Logger名

LEVEL :选项 TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

制定类名或包名的日志级别举例:

logging.level.com.alen.log=DEBUG:com.alen.log包下所有class以DEBUG级别输出 logging.level.root=WARN:root日志以WARN级别输出

 

2.自定义日志配置

根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:

  • Logback: logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j: log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2: log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging): logging.properties

 

2.1 使用Logback记录日志

Logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块:logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。 Logback是要与SLF4J结合起来用两个组件的官方网站如下:

    logback的官方网站: http://logback.qos.ch

    SLF4J的官方网站:http://www.slf4j.org

    本文章用到的组件如下:请自行到官方网站下载!

    logback-access-1.0.0.jar

    logback-classic-1.0.0.jar

    logback-core-1.0.0.jar

    slf4j-api-1.6.0.jar

Spring Boot 官方推荐优先使用带有 -spring 的文件名作为你的日志配置(如使用 logback-spring.xml ,而不是 logback.xml ),命名为 logback-spring.xml 的日志配置文件, spring boot 可以为它添加一些 spring boot 特有的配置项(下面会提到)。

默认的命名规则,并且放在 src/main/resources 下面即可

如果你即想完全掌控日志配置,但又不想用 logback.xml 作为 Logback 配置的名字, application.yml 可以通过 logging.config 属性指定自定义的名字:

logging.config=classpath:logging-config.xml

虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行时 Profile 使用不同的日志配置,这个功能会很有用。

一般不需要这个属性,而是直接在 logback-spring.xml 中使用 springProfile 配置,不需要 logging.config 指定不同环境使用不同配置文件。 springProfile 配置在下面介绍

根节点包含的属性

  • scan:当此属性设置为 true 时,配置文件如果发生改变,将会被重新加载,默认值为 true 。
  • scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当 scan 为 true 时,此属性生效。默认的时间间隔为1分钟。
  • debug:当此属性设置为 true 时,将打印出 logback 内部日志信息,实时查看 logback 运行状态。默认值为 false

子节点一

root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。

level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。可以包含零个或多个元素,标识这个appender将会添加到这个loger。

子节点二: 设置上下文名称

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过 %contextName 来打印日志上下文名称,一般来说我们不用这个属性,可有可无。

子节点三: 设置变量

用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。

子节点四:

appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。

控制台输出 ConsoleAppender

子节点五

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定 仅有一个 name 属性,一个可选的 level 和一个可选的 addtivity 属性。

name :用来指定受此loger约束的某一个包或者具体的某一个类。

level :用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。

addtivity :是否向上级loger传递打印信息。默认是true。

loger在实际使用的时候有两种情况

 

多环境日志输出


...


    
        
    



    
        
    

 2.1.1使用示例



    
    
    
    
    
    
    
    
    
    
    
    
    
        
            ${CONSOLE_LOG_PATTERN}
            utf8
        
    
 
 
    
    
    
    
        
            
            ${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log
            
            30
        
        
            
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
        
        
        
            10MB
        
    
    
    
    
    
    
    
 
    
    
    
    
    
 
    
    
        
        
    
    
    

2.1.2 logback.xml配置示例

 



    
    SpringBootDemo
    
    
    
 
    
    
        
        ${LOG_PATH}/${APPDIR}/log_error.log
        
        
            
            ${LOG_PATH}/${APPDIR}/error/log-error-%d{yyyy-MM-dd}.%i.log
            
            
                2MB
            
        
        
        true
        
        
            ===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n
            utf-8
        
        
        
            error
            ACCEPT
            DENY
        
    
 
    
    
        
        ${LOG_PATH}/${APPDIR}/log_warn.log
        
        
            
            ${LOG_PATH}/${APPDIR}/warn/log-warn-%d{yyyy-MM-dd}.%i.log
            
            
                2MB
            
        
        
        true
        
        
            ===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n
            utf-8
        
        
        
            warn
            ACCEPT
            DENY
        
    
 
    
    
        
        ${LOG_PATH}/${APPDIR}/log_info.log
        
        
            
            ${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}.%i.log
            
            
                2MB
            
        
        
        true
        
        
            ===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n
            utf-8
        
        
        
            info
            ACCEPT
            DENY
        
    
 
    
        
        
            ===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n
            utf-8
        
        
        
            debug
        
    
 
    
    
 
    
    
        
        
        
 
        
        
    

2.2 使用log4j记录日志

在目录resources新建log4j配置文件log4j.properties

#log4j.rootLogger=CONSOLE,info,error,DEBUG
log4j.rootLogger=info,error,CONSOLE,DEBUG
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm}[%t][%c][%p]-%m%n
log4j.logger.info=info
log4j.appender.info=org.apache.log4j.DailyRollingFileAppender
log4j.appender.info.layout=org.apache.log4j.PatternLayout
log4j.appender.info.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm}[%t][%c][%p]-%m%n
log4j.appender.info.datePattern='.'yyyy-MM-dd
log4j.appender.info.Threshold = info
log4j.appender.info.append=true  
 
#log4j.appender.info.File=/home/admin/pms-api-services/logs/info/api_services_info
log4j.appender.info.File=/Users/dddd/Documents/testspace/pms-api-services/logs/info/api_services_info
log4j.logger.error=error
log4j.appender.error=org.apache.log4j.DailyRollingFileAppender
log4j.appender.error.layout=org.apache.log4j.PatternLayout
log4j.appender.error.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm}[%t][%c][%p]-%m%n
log4j.appender.error.datePattern='.'yyyy-MM-dd
log4j.appender.error.Threshold = error  
 
log4j.appender.error.append=true  
 
#log4j.appender.error.File=/home/admin/pms-api-services/logs/error/api_services_error
log4j.appender.error.File=/Users/dddd/Documents/testspace/pms-api-services/logs/error/api_services_error
log4j.logger.DEBUG=DEBUG
log4j.appender.DEBUG=org.apache.log4j.DailyRollingFileAppender
log4j.appender.DEBUG.layout=org.apache.log4j.PatternLayout
log4j.appender.DEBUG.layout.ConversionPattern=%d{yyyy-MM-dd-HH-mm}[%t][%c][%p]-%m%n
log4j.appender.DEBUG.datePattern='.'yyyy-MM-dd
log4j.appender.DEBUG.Threshold = DEBUG
log4j.appender.DEBUG.append=true  
 
#log4j.appender.DEBUG.File=/home/admin/pms-api-services/logs/debug/api_services_debug
log4j.appender.DEBUG.File=/Users/dddd/Documents/testspace/pms-api-services/logs/debug/api_services_debug

使用

private static Logger log = Logger.getLogger(IndexController.class);
log.info("test log");
log.error("test log");
log.debug("test log");

2.3 springboot 中 log4j2的使用

https://blog.csdn.net/sdlyjzh/article/details/79416607

 

3. 使用AOP统一处理Web请求日志

 3.1 POM文件新增依赖



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

3.2 使用示例代码

package com.ljl.spring.boot;
 
import java.util.Enumeration;
 
import javax.servlet.http.HttpServletRequest;
 
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
 
@Component
@Aspect
public class WebLogAspect {
 
   private Logger logger = LoggerFactory.getLogger(getClass());
 
   @Pointcut("execution(public * com.ljl.spring.boot.controller..*.*(..))")
   public void webLog() {
   }
 
   @Before("webLog()")
   public void doBefore(JoinPoint joinPoint) throws Throwable {
      // 接收到请求,记录请求内容
      ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
      HttpServletRequest request = attributes.getRequest();
      // 记录下请求内容
      logger.info("URL : " + request.getRequestURL().toString());
      logger.info("HTTP_METHOD : " + request.getMethod());
      logger.info("IP : " + request.getRemoteAddr());
      Enumeration enu = request.getParameterNames();
      while (enu.hasMoreElements()) {
         String name = (String) enu.nextElement();
         logger.info("name:{},value:{}", name, request.getParameter(name));
      }
   }
 
   @AfterReturning(returning = "ret", pointcut = "webLog()")
   public void doAfterReturning(Object ret) throws Throwable {
      // 处理完请求,返回内容
      logger.info("RESPONSE : " + ret);
   }
 
}

 

你可能感兴趣的:(SpringBoot,日志,spring,boot,日志)