SpringBoot的日志管理

紫晨
755 阅读5分钟

SpringBoot的日志管理

SprongBoot使用的默认日志框架是Logback,并用INFO级别输出到控制台: 日志输出内容元素具体如下：

  • 时间日期：精确到毫秒
  • 日志级别：ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID
  • 分隔符：— 标识实际日志的开始
  • 线程名：方括号括起来（可能会截断控制台输出)
  • Logger名：通常使用源代码的类名
  • 日志内容 日志依赖:该依赖内容就是 Spring Boot 默认的日志框架 logback
<!-- 日志管理 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>

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

SpringBoot的日志的级别有7个： TRACE , DEBUG , INFO , WARN , ERROR , FATAL , OFF

日志级别从低到高为: TRACE < DEBUG < INFO < WARN < ERROR < FATAL< OFF 。 如果设置为 WARN ，则低于 WARN 的信息都不会输出。 Spring Boot 中默认配置 ERROR 、 WARN 和 INFO 级别的日志输出到控制台。

例如

#root日志以WARN级别输出
logging.level.root=WARN (让日志只输出warn及以上级别的信息)

#springframework.web日志以DEBUG级别输出
logging.level.org.springframework.web=DEBUG

#hibernate日志以ERROR级别输出
logging.level.org.hibernate=ERROR

默认情况下，Spring Boot将日志输出到控制台，不会写到日志文件。
如果要编写除控制台输出之外的日志文件，则需在application.properties中设置logging.file或logging.path属性。

  • logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=log/my.log(相对)或者/log/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

#配置日志
logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.file=e:\\springboot\\info.log
logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n
logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n

自定义日志配置

通过系统属性和传统的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特有的配置项。 如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以通过logging.config属性指定自定义的名字

logging.config=classpath:logging-config.xml

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

<?xml version="1.0" encoding="UTF-8"?> 
    <configuration  scan="true" scanPeriod="60 seconds" debug="false">  
        <contextName>logback</contextName>  
        <property name="log.path" value="E:\\springboot\\info.log" />  
        <!--输出到控制台-->  
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">  
           <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">  
                <level>ERROR</level>  
            </filter>-->  
            <encoder>  
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>  
            </encoder>  
        </appender>  
      
        <!--输出到文件-->  
        <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">  
            <file>${log.path}</file>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>  
            </rollingPolicy>  
            <encoder>  
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>  
            </encoder>  
        </appender>  
      
        <root level="info">  
            <appender-ref ref="console" />  
            <appender-ref ref="file" />  
        </root>  
      
        <!-- logback为java中的包 -->  
        <logger name="com.zichen.controller"/>  
        
        <!--additivity是否向上级loger传递打印信息-->  
        <logger name="com.zichen.controller.SpringController" level="WARN" additivity="false">  
            <appender-ref ref="console"/>  
        </logger>  
</configuration>

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

  • scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。

  • scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。

  • debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

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

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

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

ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志。

RollingFileAppender用于切分文件日志：

  • <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>:定义了日志的切分方式——把每一天的日志归档到一个文件中，
  • <maxHistory>30</maxHistory>:表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。
  • <totalSizeCap>1GB</totalSizeCap>用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志。
  • <root>节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。
  • <loger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。
    • name:用来指定受此loger约束的某一个包或者具体的某一个类。
    • level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
    • addtivity:是否向上级loger传递打印信息。默认是true。

loger的使用

第一种：带有loger的配置，不指定级别，不指定appender

<logger name="com.zichen.controller"/>

将控制controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别"info".

  • 没有设置addtivity，默认为true，将此loger的打印信息向上级传递；
  • 没有设置appender，此loger本身不打印任何信息。

当执行该包下的某个类中的功能时，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印；

  • root接到下级传递的信息，交给已经配置好的名为"console"的.
  • appender处理，"console"appender将信息打印到控制台。

第二种：带有多个loger的配置，指定级别，指定appender

<logger name="com.zichen.controller.SpringController" level="WARN" additivity="false">  
      <appender-ref ref="console"/> 
</logger>

控制com.zichen.controller.SpringController类的日志打印，打印级别为“WARN”; additivity属性为false，表示此loger的打印信息不再向上级传递.

  • 指定了名字为"console"的appender;

  • 当执行SpringController中的方法时将级别为"WARN"及大于"WARN"的日志信息交给此loger指定的名为"console"的appender处理，在控制台中打出日志，不再向上级root传递打印信息。

多环境日志输出

根据不同环境（prod:生产环境，test:测试环境，dev:开发环境）来定义不同的日志输出，在 logback-spring.xml中使用 springProfile 节点来定义，方法如下

<!-- 测试环境+开发环境. 多个使用逗号隔开-->
<springProfile name="test,dev">
    <logger name="com.qianfeng.controller" level="info" />
</springProfile>

<!-- 生产环境-->
<springProfile name="prod">
    <logger name="com.zichen.controller" level="ERROR" />
</springProfile>

在application.properties文件中指明使用哪一种：

   spring.profiles.active=prod

使用log4j日志管理

  • 修改pom.xml文件，过滤掉自带的spring-boot-starter-logging，然后添加spring-boot-starter-log4j依赖包
<!-- log4j -->
<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
     </dependency>    
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-log4j</artifactId>
        <version>1.3.8.RELEASE</version>
</dependency>
  • 在resources目录下新建log4j.properties配置文件

配置info,error,console,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=e://springboot/api_services_info.log
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=e://springboot/api_services_error.log
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=e://springboot/api_services_debug.log
  • 在使用到的类中声明log以及输出log信息
@RestController
public class UserController{
    private static Logger log = Logger.getLogger(UserController.class);
    @Autowired
    UserService userService;
    @RequestMapping(“/add”)
    public String addUser(){
          User u=new User(“zhangsan”，“12345”);
          int result = userService.addUser(u);
          log.info(“增加用户成功”+result);
          return “success”+result;
    }
}
avatar
文章
阅读
粉丝