日志配置文件详解-logback,log4j

导读

日志是对于我们开发确定问题是至关重要的信息,包括日志的打印,日志的级别,

这些都是可以由开发者直接控制,但是一些日志的基本配置,比如打印线程名称,

日志时间格式,日志输出的位置等,这些日志基本配置,很多开发者不一定了解,

虽然我们不常用,但是给你一个日志配置文件能看明白什么意思也是很至关重要的.

配置文件详解

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：scan的扫描间隔, 默认单位是毫秒, 默认的时间间隔为1分钟, 当scan为true时,此属性生效。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    
    <!-- property定义属性值,在配置文件别的地方可以用过${name}的方式引用,比如${LOG_HOME} -->
    <property name="LOG_HOME" value="/app/log"/></property>
    <property name="appName" value="bianchengbang-spring-boot-logging"></property>
    <!-- appender 可以理解为日志输出的渠道定义,关键点在class属性指定的类,更多的class值可以自行百度 -->
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    	<!-- 日志的输出形式 -->
        <layout class="ch.qos.logback.classic.PatternLayout">
        <!-- pattern用来定义日志输出模板 
        	部分日志输出格式,更多的可以自己百度：
   			%d表示日期时间，
   			%thread表示线程名，
   			%-5level：级别从左显示5个字符宽度
   			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。
   			%msg：日志消息，
   			%n是换行符
        -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread]**************** %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <appender name="stdout_1" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread]+++++++++++++++ %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 这个appender定义的是输出日志到一个文件,ch.qos.logback.core.rolling.RollingFileAppender标识滚动生成文件,也就是按照一定的策略生成日志文件,比如每天生成一个日志文件记录当天的日志 -->
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。
 		 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!--
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [ %thread ] ------------------ [ %-5level ] [ %logger{50} : %line ] -
                %msg%n
            </pattern>
        </layout>
    </appender>

    <!--
  logger 主要用于存放日志对象，也可以定义日志类型、级别
  name：这个是个通配,指定包名的话就是这个包路径下的所有类都会通过这个logger指定的appender进行日志打印,比如这里:com.example包路径下的日志输出都会按照stdout_1定义的日志格式输出
  level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
  additivity：默认为true,当为false的时候仅仅会按照stdout_1定义的日志格式输出,
  下面的root和logger标签是父子标签,logger标签你可以单独理解为专门为某些包路径下的类单独指订输出格式,root标签是兜底的,所有的日志输出默认都会按照root指定的方式输出,如果additivity为true,不仅会按照stdout_1,还会按照stdout(输出到控制台)和appLogAppender(写日志)的格式输出,会打印多遍,是false的话就不会再去触发父标签root的指定的格式.
   -->
    <!-- hibernate logger -->
    <logger name="com.example" level="debug"  additivity="false">
    <appender-ref ref="stdout_1" ></appender-ref>
    </logger>

    <!--
    root与logger是父子关系，root指定的输出格式,默认所有的类都会按照这种方式,除非单独制订了logger标签,并且additivity设置为了false才不会触发
    -->
    <root level="info">
        <appender-ref ref="stdout"/>
        <appender-ref ref="appLogAppender"/>
    </root>
</configuration> 

以上就是配置的基本介绍,很简单,然后还有就是这个文件的命名和生效条件,
首先这个文件要放在resource目录下,
文件命名:命名为logback-spring.xml 则会被springboot直接扫描生效, 而且可以在配置文件中的任何地方使用<springProfile>标签

<!-- 首先这个标签可以用在日志配置文件的任何地方,这个标签可以读取到当前系统启动触发的是哪个环境,
name属性的值要和系统配置文件的值(就是application-XXX.yaml中的这个XXX)对应,
比如系统启动的系统配置文件是dev环境,那么<springProfile>标签内的配置就会生效,这样我们就可以做到在同一个日志配置文件中不同的环境日志的输出格式不同 -->
<springProfile name="dev">
    <!-- configuration to be enabled when the "test" profile is active -->
</springProfile>

<!--这里定义的一个appender,就可以根据不同的系统环境,自动按照设置打印不同格式的日志,当是dev环境的时候打印的就是***********test环境打印的就是++++++++++-->
    <appender name="stdout_2" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
        <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread]*************** %-5level %logger{50} - %msg%n</pattern>
		</springProfile>
		<springProfile name="test">
                <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread]+++++++++++++++ %-5level %logger{50} - %msg%n</pattern>
		</springProfile>
        </layout>
    </appender>

如果文件命名:logback.xml那么则需要在系统配置文件里面配上classpath:logback.xml此日志配置文件才会生效.

结束语

	这个很简单,感兴趣或者不明白的同学可以用上面的配置试下,很容易就明白了.
	不过我觉得我写的已经够明白了,都显得絮叨了.以上.log4j也是类似的.