本文共 14526 字，大约阅读时间需要 48 分钟。

一、前言

在Spring Boot的官方文档中，我们发现关于日志的描述还是比较详细的： 。Spring Boot使用Commons Logging进行所有内部日志记录，但是默认配置也提供了对常用日志框架的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每种日志框架都可以通过配置使用控制台或者文件输出日志内容。如果我们使用了Spring Boot的starters，那么Spring Boot会用Logback来记录日志并用INFO级别输出到控制台。

.   ____          _            __ _ _ /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/  ___)| |_)| | | | | || (_| |  ) ) ) )  '  |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot ::        (v1.5.2.RELEASE)2018-08-07 21:29:38.556  INFO 4384 --- [           main] com.dudu.Application                     : Starting Application on DESKTOP-GVTQ3ND with PID 4384 (E:\IntelliProject\springboot_springclould\SpringBootDemo-master\chapter7-1\target\classes started by acer in E:\IntelliProject\springboot_springclould\SpringBootDemo-master\chapter7-1)2018-08-07 21:29:38.560  INFO 4384 --- [           main] com.dudu.Application                     : No active profile set, falling back to default profiles: default2018-08-07 21:29:39.045  INFO 4384 --- [           main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@5e57643e: startup date [Tue Aug 07 21:29:39 CST 2018]; root of context hierarchy2018-08-07 21:29:40.770  INFO 4384 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat initialized with port(s): 8080 (http)2018-08-07 21:29:40.779  INFO 4384 --- [           main] o.apache.catalina.core.StandardService   : Starting service Tomcat2018-08-07 21:29:40.780  INFO 4384 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/8.5.112018-08-07 21:29:40.877  INFO 4384 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext2018-08-07 21:29:40.877  INFO 4384 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1836 ms2018-08-07 21:29:41.099  INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean  : Mapping servlet: 'dispatcherServlet' to [/]2018-08-07 21:29:41.104  INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'characterEncodingFilter' to: [/*]2018-08-07 21:29:41.104  INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]2018-08-07 21:29:41.104  INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'httpPutFormContentFilter' to: [/*]2018-08-07 21:29:41.104  INFO 4384 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'requestContextFilter' to: [/*]2018-08-07 21:29:41.465  INFO 4384 --- [           main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@5e57643e: startup date [Tue Aug 07 21:29:39 CST 2018]; root of context hierarchy2018-08-07 21:29:41.521  INFO 4384 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/learn]}" onto public org.springframework.web.servlet.ModelAndView com.dudu.controller.LearnController.index()2018-08-07 21:29:41.524  INFO 4384 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/login],methods=[POST]}" onto public java.util.Map
   
     com.dudu.controller.LearnController.login(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)2018-08-07 21:29:41.527  INFO 4384 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity
    
     
      > org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)2018-08-07 21:29:41.527  INFO 4384 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)2018-08-07 21:29:41.544  INFO 4384 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/toLogin] onto handler of type [class org.springframework.web.servlet.mvc.ParameterizableViewController]2018-08-07 21:29:41.556  INFO 4384 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/my/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]2018-08-07 21:29:41.557  INFO 4384 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]2018-08-07 21:29:41.557  INFO 4384 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]2018-08-07 21:29:41.599  INFO 4384 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]2018-08-07 21:29:42.031  INFO 4384 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup2018-08-07 21:29:42.099  INFO 4384 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)2018-08-07 21:29:42.103  INFO 4384 --- [           main] com.dudu.Application                     : Started Application in 3.941 seconds (JVM running for 5.251)
     
    
   

通过控制台日志输出我们发现：

• 日期时间：精确到毫秒
• 日志级别：ERROR, WARN, INFO, DEBUG or TRACE
• 进程id
• 分隔符：---
• 线程名：方括号中的内容（可能会截断控制台输出）
• Logger名：通常使用源代码的类名
• 日志内容

二、使用默认日志Lockback

2.1 添加依赖

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

添加这个依赖之后，Spring Boot应用将自动使用logback作为应用日志框架，Spring Boot启动的时候，由org.springframework.boot.logging.Logging-Application-Listener根据情况初始化并使用。但是一般在开发的时候我们没必要引入这个依赖，因为spring-boot-starter其中包含了 spring-boot-starter-logging,例如下面的两个依赖就包含此日志包：

        
    
     org.springframework.boot
         
    
     spring-boot-starter-thymeleaf
    
   
        
    
     org.springframework.boot
         
    
     spring-boot-starter-web
    
   

具体的依赖关系我们可以通过IDEA工具去查看。

2.2 默认配置属性

我们只需要引入相关的依赖，Spring Boot就默认做了很多的配置，一般情况下我们直接使用就可以了。当然我们也可以在配置文件中去修改，相关属性如下：

# LOGGINGlogging.config= # Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback.logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions.logging.file= # Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory.logging.file.max-history=0 # Maximum of archive log files to keep. Only supported with the default logback setup.logging.file.max-size=10MB # Maximum log file size. Only supported with the default logback setup.logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`.logging.path= # Location of the log file. For instance, `/var/log`.logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup.logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS # Appender pattern for log date format. Supported only with the default Logback setup.logging.pattern.file= # Appender pattern for output to a file. Supported only with the default Logback setup.logging.pattern.level=%5p # Appender pattern for log level. Supported only with the default Logback setup.logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.

下面我们介绍几个常用属性的使用。

2.2.1 控制台输出

日志的级别从低到高依次为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。默认情况下Spring Boot使用Lockback(Lockback没有FATAL级别),控制台会输出INFO及INFO以上的日志,我们可以在配置文件中配置debug=true或在启动时运行$ java -jar demo.jar --debug核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。

2.2.2 文件输出

默认情况下Spring Boot只会输出日志到控制台，如果我们想要把日志输出到文件中，我们可以通过设置logging.file或logging.path这两个属性来实现，二者不能同时使用，如若同时使用，则只有logging.file生效。

• logging.file：设置文件，绝对路径或相对路径都可以，例如：logging.file=mylog.log
• logging.path: 设置目录，会在该目录下创建spring.log文件，并写入日志内容,例如：logging.path=/my/log/,会在这个目录下生成名为spring.log的日志文件

2.2.3 日志级别控制

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

#com.simon.controller包下所有class以DEBUG级别输出logging.level.com.simon.controller=DEBUG#root日志以WARN级别输出logging.level.root=WARN

2.2.4 日志输出格式

%d：表示日期时间%thread：表示线程名%‐5level：级别从左显示5个字符宽度      %logger{50}：表示logger名字最长50个字符，否则按照句点分割。   %msg：日志消息%n：是换行符

示例：

# 设置在控制台输出的日志的格式logging.pattern.console=[%d{yyyy‐MM‐dd}]-[%level]-[%msg]-%logger{50}%n# 指定文件中日志输出的格式logging.pattern.file=%d{yyyy‐MM‐dd} === [%thread] === %level === %logger{50} ==== %msg%n

2.3 自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

• 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

Spring Boot官方推荐优先使用带有-spring的文件名作为日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项。上面是默认的命名规则，并且放在src/main/resources下面即可。如果想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以在application.properties配置文件里面通过logging.config属性指定自定义的名字：

logging.config=classpath:logging-config.xml

下面我们通过一个简单的例子来说明自定义Lockback日志：

   
       
    
     demo
        
        
        
           
             
                 
      
       %d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
              
         
        
        
            
                 
      
       ${log.path}/logback.%d{yyyy-MM-dd}.log
              
             
                 
      
       %d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
              
         
        
            
             
         
        
        
        
        
            
         
    
   

2.3.1 根节点<configuration>包含的属性

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

根节点<configuration>下面一共有2个属性，3个子节点，分别是：

1. 设置上下文名称<contextName>

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

   
    logback
   

1. 设置变量<property>

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

1. 子节点一<appender>

• 控制台输出ConsoleAppender

   
       
            
     
      ERROR
         
        
            
     
      %d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
         
    
   

ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。

• 文件输出RollingFileAppender

  另一种常见的日志输出到文件，随着应用的运行时间越来越长，日志也会增长的越来越多，将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志：

       
           
                
         
          ${log.path}/logback.%d{yyyy-MM-dd}.log
                 
         
          30
                 
         
          1GB
             
            
                
         
          %d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n
             
        
       

  其中重要的是rollingPolicy的定义，上例中<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>定义了日志的切分方式——把每一天的日志归档到一个文件中，<maxHistory>30</maxHistory>表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。<totalSizeCap>1GB</totalSizeCap>用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志。

1. 子节点二<root>

root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。level用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。可以包含零个或多个元素，标识这个appender将会添加到这个logger。

1. 子节点三<logger>

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

• name:用来指定受此logger约束的某一个包或者具体的某一个类。
• level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。
• addtivity:是否向上级logger传递打印信息。默认是true。

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

• 带有logger的配置，不指定级别，不指定appender

<logger name="com.simon.controller" />将控制controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别info；没有设置addtivity，默认为true，将此logger的打印信息向上级传递；没有设置appender，此logger本身不打印任何信息。<root level="info">将root的打印级别设置为info，指定了名字为console的appender。当执行com.simon.controller下类的方法时，首先执行<logger name="com.simon.controller"/>，将级别为info及大于info的日志信息传递给root，本身并不打印；root接到下级传递的信息，交给已经配置好的名为console的appender处理，console appender将信息打印到控制台。

• 带有多个logger的配置，指定级别，指定appender

控制com.simon.controller.DemoController类的日志打印，打印级别为WARN;additivity属性为false，表示此logger的打印信息不再向上级传递;指定了名字为console的appender;这时候执行com.simon.controller.DemoController类的方法时，先执行<logger name="com.simon.controller.DemoController" level="WARN" additivity="false">,将级别为“WARN”及大于WARN的日志信息交给此logger指定的名为console的appender处理，在控制台中打出日志，不再向上级root传递打印信息。当然如果你把additivity=”false”改成additivity=”true”的话，就会打印两次，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。

2.4 多环境日志输出

logback.xml与logback-spring.xml是有区别的，logback.xml会直接被日志框架识别使用，而logback-spring.xml会先经过springboot解析处理，之后才会被日志框架使用，可以使用SpringBoot的高级Profile功能。我们可以通过不同环境来定义不同日志的输出，如果我们使用logback-spring.xml，那么springProfile节点来标识配置应用到哪些环境中。

这样之后，我们在配置中指定环境，那么相关的日志就生效了

# 指定环境为devspring.profiles.active=dev

三、 切换日志框架

如果我们不想使用Lockback日志框架，我们可以安装如下方法做，以更换日志框架为log4j2,并使用log4j2配置文件进行日志打印为例。

3.1 排除当前日志框架,引入新的日志框架

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

3.2 定义log4j2.xml配置文件

?xml version="1.0" encoding="UTF-8"?>
   
   
   
       
        
            
             
                 
                  
              
             
             
                 
              
             
             
                 
                  
                  
                  
                      
                       
                   
              
             
                 
                  
                  
                      
                       
                   
                  
                  
              
             
                 
                  
                  
                      
                       
                   
              
         
        
        
            
             
             
             
                 
                  
                  
                  
              
         
    
   

转载地址：https://blog.csdn.net/u012921921/article/details/112604931 如侵犯您的版权，请留言回复原文章的地址，我们会给您删除此文章，给您带来不便请您谅解！