SpringBoot 日志系列:（二）日志配置

一、application.properties 或 application.yml 配置

可以在 application.properties 或 application.yml 修改日志的一些默认设置。

1.1 日志级别

log 中有 trace, debug, info, warning, error 级别，默认级别是 info。
可以在Spring环境中设置记录级别（例如在application.properties中）

格式为：`logging.level.* = LEVEL`
logging.level：日志级别控制前缀，*为包名或Logger名
LEVEL：选项 TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

//com.dudu包下所有class以DEBUG级别输出
logging.level.com.dudu=DEBUG 

//root日志以WARN级别输出
logging.level.root=WARN

也可以在 yml 文件中配置：

logging:
  level:
    com.fishpro.log: debug

1.2 文件输出

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

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

如果只配置 logging.file，会在指定路径 / 当前路径下生成一个 xxx.log 日志文件。

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

# 不指定路径在当前项目下生成springboot.log日志
#logging.file=springboot.log
# 可以指定完整的路径；
logging.file=d://springboot.log

# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用spring.log 作为默认文件
logging.path=/spring/log

注意：

• 二者不能同时使用，如若同时使用，则只有logging.file生效
• 默认情况下，日志文件的大小达到10MB时会切分一次，产生新的日志文件，默认级别为：ERROR、WARN、INFO

1.3 日志输出格式

# 在控制台输出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

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

在yml中的详细设置：

logging:
  #level 日志等级 指定命名空间的日志输出
  level:
    com.fishpro.log: debug
  #file 指定输出文件的存储路径
  file: logs/app.log
  #pattern 指定输出场景的日志输出格式
  pattern:
    console: "%d %-5level %logger : %msg%n"
    file: "%d %-5level [%thread] %logger : %msg%n"

二、自定义日志配置

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

• 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-spring.xml，日志框架就不直接加载日志的配置项，需要加上springProfile标签由SpringBoot解析日志配置，即可以使用SpringBoot的高级Profile功能

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
        	
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%npattern>
            springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%npattern>
            springProfile>
        layout>
    appender>

上面是默认的命名规则，并且放在 src/main/resources 下面即可。

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

logging.config=classpath:logging-config.xml

虽然一般并不需要改变配置文件的名字，但是如果你想针对不同运行时Profile使用不同的日志配置，这个功能会很有用。
一般不需要这个属性，而是直接在logback-spring.xml中使用springProfile配置，不需要logging.config指定不同环境使用不同配置文件。

看一个例子：

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logbackcontextName>
    <property name="log.path" value="E:\\test\\logback.log" />
    
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
       
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern>
        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}.logfileNamePattern>
        rollingPolicy>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern>
        encoder>
    appender>

    <root level="info">
        <appender-ref ref="console" />
        <appender-ref ref="file" />
    root>

    
    <logger name="com.dudu.controller"/>
    
    <logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
        <appender-ref ref="console"/>
    logger>
configuration>

2.1 根节点 包含的属性

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

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

2.1.1 属性一：设置上下文名称

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

2.1.2 属性二：设置变量

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

<property name="logback.logdir" value="/Users/inke/dev/log/tomcat"/>
<property name="logback.appname" value="app"/>
<property name="log.path" value="E:\\logback.log"/>

2.1.3 子节点一

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

控制台输出 ConsoleAppender
示例一：

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logback-democontextName>

    
    <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
        
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d -1 %msg%npattern>
        layout>
    appender>

    
    <appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d -2 %msg%npattern>
        encoder>
    appender>

    
    <root level="INFO">
        
        <appender-ref ref="consoleLog1"/>
        <appender-ref ref="consoleLog2"/>
    root>

configuration>

示例二：

 
 <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
     <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
         <level>ERRORlevel>
     filter>
     <encoder>
         <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern>
     encoder>
 appender>

表示对日志进行编码：

• %d{HH: mm:ss.SSS} ——日志输出时间
• %thread ——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
• %-5level ——日志级别，并且使用5个字符靠左对齐
• %logger{36} ——日志输出者的名字
• %msg ——日志消息
• %n ——平台的换行符

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

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

<appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
    
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        
        <level>ERRORlevel>
        
        <onMatch>DENYonMatch>
        
        <onMismatch>ACCEPTonMismatch>
    filter>
    
    <File>${logback.logdir}/info.${logback.appname}.logFile>
    
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        
        <FileNamePattern>${logback.logdir}/info.${logback.appname}.%d{yyyy-MM-dd}.logFileNamePattern>
        
        <maxHistory>90maxHistory>
        
        
    rollingPolicy>
    
    <encoder>
        <charset>UTF-8charset>
        <pattern>%d [%thread] %-5level %logger{36} %line - %msg%npattern>
    encoder>
appender>


<appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
    
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>Errorlevel>
    filter>
    
    <File>${logback.logdir}/error.${logback.appname}.logFile>
    
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        
        <FileNamePattern>${logback.logdir}/error.${logback.appname}.%d{yyyy-MM-dd}.logFileNamePattern>
        
        <maxHistory>90maxHistory>
        
        
    rollingPolicy>
    
    <encoder>
        <charset>UTF-8charset>
        <pattern>%d [%thread] %-5level %logger{36} %line - %msg%npattern>
    encoder>
appender>

如果同时有和，则根据日期分割日志。
如果要区分 Info 和 Error 级别的日志，那么需要使用过滤规则的策略。

2.1.4 子节点二

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

• level：用来设置打印级别，大小写无关，TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。

• 默认是DEBUG。

• 可以包含零个或多个元素，标识这个appender将会添加到这个loger。

  <root level="debug">
    <appender-ref ref="console" />
    <appender-ref ref="file" />
  root>
  

2.1.5 子节点三

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

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

loger在实际使用的时候有两种情况
先来看一看代码中如何使用

package com.dudu.controller;
@Controller
public class LearnController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping(value = "/login",method = RequestMethod.POST)
    @ResponseBody
    public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){
        //日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。
        logger.trace("日志输出 trace");
        logger.debug("日志输出 debug");
        logger.info("日志输出 info");
        logger.warn("日志输出 warn");
        logger.error("日志输出 error");
        Map<String,Object> map =new HashMap<String,Object>();
        String userName=request.getParameter("userName");
        String password=request.getParameter("password");
        if(!userName.equals("") && password!=""){
            User user =new User(userName,password);
            request.getSession().setAttribute("user",user);
            map.put("result","1");
        }else{
            map.put("result","0");
        }
        return map;
    }
}

这是一个登录的判断的方法，我们引入日志，并且打印不同级别的日志，然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。

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

logback-spring.xml增加 loger 配置如下：

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

将控制controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别 “info”；
没有设置addtivity，默认为true，将此loger的打印信息向上级传递；
没有设置appender，此loger本身不打印任何信息。
将root的打印级别设置为“info”，指定了名字为“console”的appender。

当执行com.dudu.controller.LearnController类的login方法时，LearnController在包com.dudu.controller中，所以首先执行，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印；
root接到下级传递的信息，交给已经配置好的名为“console”的appender处理，“console” appender将信息打印到控制台；

打印结果如下：

16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.dudu.controller.LearnController - 日志输出 info
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController -

第二种：带有多个loger的配置，指定级别，指定appender
logback-spring.xml增加 loger 配置如下：

<configuration>
    ...
    
    
    <logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
        <appender-ref ref="console"/>
    logger>
configuration>

控制com.dudu.controller.LearnController类的日志打印，打印级别为“WARN”;
additivity属性为false，表示此loger的打印信息不再向上级传递;
指定了名字为“console”的appender;

这时候执行com.dudu.controller.LearnController类的login方法时，先执行，将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理，在控制台中打出日志，不再向上级root传递打印信息。

打印结果如下：

16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日志输出 error

当然如果你把additivity="false"改成additivity="true"的话，就会打印两次，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。

注意：范围有重叠的话，范围小的，有效。

<configuration>
    ...
    
    <logger name="com.example.demo.controller" level="WARN" additivity="false">
       <appender-ref ref="consoleLog"/>
    logger>
    
    <logger name="com.example.demo.controller"/>
    
    <logger name="com.example.demo"/>
configuration>

2.2 多环境日志输出

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

文件名称不是logback.xml，想使用spring扩展profile支持，要以logback-spring.xml命名

<springProfile name="test,dev">
    <logger name="com.dudu.controller" level="info" />
springProfile>

<springProfile name="prod">
    <logger name="com.dudu.controller" level="ERROR" />
springProfile>

application.yml增加环境选择的配置active: dev

server:
  port: 9010

spring:
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://localhost:3306/test?characterEncoding=utf8
    username: root
    password: root

active: [test、dev、prod]，根据 active 的环境，自动采用上面配置的springProfile的 logger 日志

2.3 自定义日志路径

application.yml增加日志相关自定义配置

logback:
  logdir: /Users/inke/dev/log/tomcat/sell
  appname: sell

在logback-spring.xml 使用

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    
    <springProperty scope="context" name="appname" source="logback.appname"/>
    <springProperty scope="context" name="logdir" source="logback.logdir"/>

    <contextName>${appname}contextName>

    
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern>
            pattern>
        layout>
    appender>

参考：默认日志logback配置解析