欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Spring Boot(08)——日志输出

程序员文章站 2022-06-28 15:47:33
...

日志输出

使用了spring-boot-starter后,将添加spring-boot-starter-logging依赖,此时Spring Boot将使用logback进行日志输出,默认只会输出INFO级别以上的日志信息,且只会输出到控制台。默认的日志格式是如下这样的。前面是日志输出时间,INFO是日志级别,7496是进程号,[ost-startStop-1]是用[]包起来的线程名,o.s.web.context.ContextLoader是日志名称,接下来冒号后面的内容就是真正的日志信息。

2018-07-06 16:03:13.083  INFO 7496 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 2954 ms
2018-07-06 16:03:13.255  INFO 7496 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean  : Servlet dispatcherServlet mapped to [/]

可以通过logging.pattern.dateformat单独指定日志里面的日期输出格式,可以通过logging.pattern.level单独指定日志中日志级别输出的格式。下面的代码中就分别指定了日期输出格式和日志级别的输出格式。

logging.pattern.dateformat=HH:mm:ss.sss
logging.pattern.level=custom-%5p

按照上面自定义的日期格式和日志级别输出格式后,输出的日志会是类似于下面这样的。

16:03:13.083  custom-INFO 7496 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 2954 ms
16:03:13.255  custom-INFO 7496 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean  : Servlet dispatcherServlet mapped to [/]

也可以通过#logging.pattern.console单独指定控制台的日志输出格式,通过#logging.pattern.file指定输出到文件的日志格式。

#logging.pattern.console=console-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} -%msg%n
#logging.pattern.file=file-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} -%msg%n

指定日志输出文件

默认的日志信息只会输出到控制台,可以在application.properties文件中通过logging.file指定日志输出文件名。当不指定路径时,默认将在当前路径下创建日志文件。

logging.file=logback.log

指定logging.file时也可以指定路径,如下则指定了日志内容将写入到/logs目录下的logback.log文件。

logging.file=/logs/logback.log

当不指定logging.file时也可以通过logging.path指定日志文件输出的路径,这样日志内容将写入到指定目录下的spring.log文件。如下配置则表示日志内容将写入到/logs/spring.log文件中。

logging.path=/logs

日志文件压缩

默认情况下每个日志文件写入10MB内容后将重新产生一个新的日志文件,然后将老的进行压缩,可以通过logging.file.max-size=20MB指定每个日志文件最多写入20MB日志。默认情况下压缩的日志文件将不断产生,没有数量限制,可以通过logging.file.max-history指定需要保留的历史日志文件数量。

调整日志级别

日志级别可以通过logging.level.logName=logLevel的形式进行调整,其中根日志级别可以通过logging.level.root进行调整。比如下面的代码就配置了根日志级别为WARN,而com.elim打头的日志级别为INFOorg.springframework打头的日志级别为DEBUG

logging.level.root=WARN
logging.level.com.elim=INFO
logging.level.org.springframework=DEBUG

自定义配置文件

Spring Boot也允许我们通过定义logback.xmllogback-spring.xml文件进行自定义的日志输出配置。Spring Boot建议我们定义日志输出文件为logback-spring.xml,因为logback.xml是logback的默认日志文件,会被logback自动加载,直接使用它时有些东西可能Spring Boot还没来得及初始化,并且使用logback.xml不能使用Spring Boot添加的一些扩展。之后就可以在配置文件中按照logback的规范进行配置了,以下是一个简单的配置,只配置了控制台输出。

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

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

扩展使用springProfile

logback-spring.xml中可以使用Spring Boot扩展的<springProfile/>,它可以用在根元素<configuration/>元素下的任何位置,用来包裹任何元素。<springProfile/>用来定义在特定Profile被激活时将使用的特殊配置信息,比如下面的代码中就定义了当dev这个Profile被激活时将定义org.springframework这个logger的输出级别为DEBUG。

<springProfile name="dev">
    <logger name="org.springframework" level="DEBUG"/>
</springProfile>

扩展使用springProperty

logback-spring.xml中可以使用Spring Boot扩展的<springProperty/>,使用它可以把在application.properties中定义的属性值映射为logback环境中的一个属性,从而可以在logback的上下文使用。下面的配置中定义了属性appName对应于Spring Boot的Environment中的app.name(由source属性指定),当未指定时默认使用defaultValue属性指定的TEST;属性logPath对应于Spring Boot的Environment中的log.path,未指定时使用/logs/${appName}.log,其中的${appName}又对应于变量appName的值。定义好的变量可以在logback的配置文件中以${varName}的形式进行引用。

<configuration>

    <springProperty name="appName" source="app.name" defaultValue="TEST"/>
    <springProperty name="logPath" source="log.path" defaultValue="/logs/${appName}.log"/>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${appName}-%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logPath}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${logPath}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>5MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
    
</configuration>

(注:本文基于Spring Boot 2.0.3所写)