Java日志相关概述

日志是代码调试、生产运维必备工具，基本所有软件都会有日志记录。

1.常用日志框架介绍

1.Logging
    jdk1.5自带日志工具类，位于java.util.logging;

2.Log4j
    市场占有率最高的一个日志框架，注意2015/08/05这一天，Apache宣布停止维护了，用户需要切到Log4j2上面去；

3.commons-logging,
    apache最早提供的日志门面接口，用户可以根据自己喜欢选择不同日志实现框架，而不必改动日志定义。

4.slf4j
    simple logging facade for java,也是日志门面接口框架，和 Apache 的 commons-logging 是一样的概念，它们都不是具体的日志框架，你可以指定其他主流的日志实现框架。使用 Slf4j 可以很灵活的使用占位符进行参数占位，简化代码，拥有更好的可读性。

5.Logback
    是 Slf4j 的原生实现框架，同样也是出自 Log4j 一个人之手，但拥有比 log4j 更多的优点、特性和更做强的性能，现在基本都用来代替 log4j 成为主流。

2.日志级别

Log4j 的级别类 org.apache.log4j.Level 里面定义了日志级别，日志输出优先级由高到底分别为以下8种。
OFF，关闭，不输出日志
FATAL，致命，输出非常严重的可能会导致应用程序终止的错误
ERROR，错误，应用程序还能继续运行
WARN，警告，输出可能潜在的危险状况
INFO，信息，输出应用运行过程的详细信息
DEBUG，调试，输出更细致的对调试应用有用的信息
TRACE，跟踪，输出更细致的程序运行轨迹
ALL，所有，输出所有级别的信息

如果应用程序的日志级别设为L，一个级别为P的输出日志只有P >= L时才会输出。

3.日志打印规范

1.正确定义
    private static final Logger LOG = LoggerFactory.getLogger(ClassName.getClass);    //变量类型Log是门面接口框架中的类，实现类可以是Log4j、Logback，不要把实现类定义为变量类型，否则日志切换不方便，也不符合抽象编程思想。

2.使用参数化形式{}占位，[]进行参数隔离
    LOG.debug("Save order with order no：[{}], and order amount：[{}]");

    如果日志框架不支持参数化形式，且日志输出时不支持该日志级别时会导致对象冗余创建，浪费内存，此时就需要使用 isXXEnabled 判断，
    if(LOG.isDebugEnabled()){
        LOG.debug("orderid:" + orderno + ",amount:" + amount);
    }
    推荐使用SLF4J的门面接口，可以用参数化形式输出日志，debug级别也不必用if判断，简化代码。

3.代码中日志级别使用
    项目中常用日志级别ERROR、WARN、INFO、DEBUG四种
    ERROR，一般永安里记录程序任何异常信息（catch时使用）或者业务逻辑出错。
    WARN，一般用来记录一些用户输入错误。
    INFO，用来记录程序的一些有用信息，输入输出参数、耗时、开始结束等。
    DEBUG，程序运行过程中的中间参数，只希望开发环境出现，线上不需要的信息。

4.常见不要
    <1>不要使用System.out.print...
    <2>不要使用e.printStactTrack()，该方法本质是调用System.err输出到tomcat的控制台，不会记录到日志文件中。
    <3>不要抛出自定义异常前，又输出日志，而是应该由最终捕获方法进行异常处理。
    <4>不要使用具体的日志实现类
    <5>不要只输出部分异常信息
LOG.error("***发生异常"，e.getMessage());    //不好
LOG.error("***发生异常", e);    //正确
    <6>不要再千层嵌套中输出日志，容易拖累应用程序，而是应该用变量记录要点，循环外打印。
    <7>禁止在线上环境开启debug, 非常重要，一个是项目本身Debug日志太多，而是各大框架大量使用Debug的日志，线上业务调用多，很快就会把磁盘打满。

以上参考

4.log4j.xml文件配置讲解

1.Log4j支持两种配置文件格式，一种是XML格式文件，一种是properties格式的文件。这里介绍xml格式
    (1) Appender:日志输出器，配置日志的输出级别、输出位置等，包括以下几类
            ConsoleAppender:：输出到控制台
            FileAppender：输出到文件
            RollingFileAppender：输出到文件，文件达到一定阈值，自动备份日志文件
            DailyRollingFileAppender：可定期备份日志文件，默认一天一个文件，也可以设置为每分钟一个，每小时一个
            WriterAppender：可自定义日志输出位置

    (2)日志级别
            虽然日志级别包括八种，但常用的四个包括、DEBUG/INFO/WARN/ERROR

    (3)输出格式
            支持格式包括
                 1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），
                 2.org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
                 3.org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
                 4.org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

            Log4J最常用的日志输出格式为：org.apache.log4j.PatternLayOut，其主要参数为：
                %n - 换行
                %m - 日志内容
                %p - 日志级别(FATAL， ERROR，WARN， INFO，DEBUG or custom)
                %r - 程序启动到现在的毫秒数
                %t - 当前线程名
                %d - 日期和时间, 一般使用格式 %d{yyyy-MM-dd HH:mm:ss， SSS}
                %l - 输出日志事件的发生位置， 同 %F%L%C%M
                %F - java 源文件名
                %L - java 源码行数
                %C - java 类名，%C{1} 输出最后一个元素
                %M - java 方法名

5.log4j.xml示例

demo1

    <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//log4j/log4j Configuration//EN" "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <!-- 日志输出到控制台 -->
    <appender name="console" class="org.apache.log4j.ConsoleAppender">
        <!-- 日志输出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>

        <!--过滤器设置输出的级别-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <!-- 设置日志输出的最小级别 -->
            <param name="levelMin" value="INFO"/>
            <!-- 设置日志输出的最大级别 -->
            <param name="levelMax" value="ERROR"/>
        </filter>
    </appender>

    <!-- 输出日志到文件 -->
    <appender name="fileAppender" class="org.apache.log4j.FileAppender">
        <!-- 输出文件全路径名-->
        <param name="File" value="/data/applogs/own/fileAppender.log"/>
        <!--是否在已存在的文件追加写：默认时true，若为false则每次启动都会删除并重新新建文件-->
        <param name="Append" value="false"/>
        <param name="Threshold" value="INFO"/>
        <!--是否启用缓存，默认false-->
        <param name="BufferedIO" value="false"/>
        <!--缓存大小，依赖上一个参数(bufferedIO), 默认缓存大小8K  -->
        <param name="BufferSize" value="512"/>
        <!-- 日志输出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
    </appender>

    <!-- 输出日志到文件，当文件大小达到一定阈值时，自动备份 -->
    <!-- FileAppender子类 -->
    <appender name="rollingAppender" class="org.apache.log4j.RollingFileAppender">
        <!-- 日志文件全路径名 -->
        <param name="File" value="/data/applogs/RollingFileAppender.log" />
        <!--是否在已存在的文件追加写：默认时true，若为false则每次启动都会删除并重新新建文件-->
        <param name="Append" value="true" />
        <!-- 保存备份日志的最大个数，默认值是：1  -->
        <param name="MaxBackupIndex" value="10" />
        <!-- 设置当日志文件达到此阈值的时候自动回滚，单位可以是KB，MB，GB，默认单位是KB，默认值是：10MB -->
        <param name="MaxFileSize" value="10KB" />
        <!-- 设置日志输出的样式 -->`
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 日志输出格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" />
        </layout>
    </appender>

    <!-- 日志输出到文件，可以配置多久产生一个新的日志信息文件 -->
    <appender name="dailyRollingAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 文件文件全路径名 -->
        <param name="File" value="/data/applogs/own/dailyRollingAppender.log"/>
        <param name="Append" value="true" />
        <!-- 设置日志备份频率，默认：为每天一个日志文件 -->
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />

        <!--每分钟一个备份-->
        <!--<param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" />-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{HH:mm:ss SSS}][%c]-[%m]%n"/>
        </layout>
    </appender>

    <!--
        1. 指定logger的设置，additivity是否遵循缺省的继承机制
        2. 当additivity="false"时，root中的配置就失灵了，不遵循缺省的继承机制
        3. 代码中使用Logger.getLogger("logTest")获得此输出器，且不会使用根输出器
    -->
    <logger name="logTest" additivity="false">
        <level value ="INFO"/>
        <appender-ref ref="dailyRollingAppender"/>
    </logger>

    <!-- 根logger的设置，若代码中未找到指定的logger，则会根据继承机制，使用根logger-->
    <root>
        <appender-ref ref="console"/>
        <appender-ref ref="fileAppender"/>
        <appender-ref ref="rollingAppender"/>
        <appender-ref ref="dailyRollingAppender"/>
    </root>

</log4j:configuration>

demo2

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appenders 日志信息输出目的地 -->

	<!-- ConsoleAppender -->
	<!-- 每个ConsoleAppender都有一个target，表示它的输出目的地。 -->
	<!-- 它可以是System.out，标准输出设备（缓冲显示屏） -->
	<!-- 或者是System.err，标准错误设备（不缓冲显示屏） -->
	<appender name="console" class="org.apache.log4j.ConsoleAppender">
		<param name="Target" value="System.out" />
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%d %-5p: %c - %m%n" />
		</layout>
	</appender>

	<!-- RollingFileAppender 回滚文件 -->
	<!-- Append true，默认每次启动系统，日志继续输出到原来的文件，而不是清空了再来 -->
	<!-- MaxFileSize 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件 -->
	<!-- MaxBackupIndex 最多20个 -->
	<!-- PatternLayout 控制日志输出的格式化，参考上面的那些符合说明，自己怼自己想要的格式。 -->
	<!-- filter 级别范围过滤器 -->
	<!-- levelMin levelMax 范围 -->
	<appender name="StreamOperateFile" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="f:/ezLog/streamOperate.log" />
		<param name="Append" value="true"/>
		<param name="MaxFileSize" value="10MB"/>
		<param name="MaxBackupIndex" value="20"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%m%n" />
		</layout>
		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<param name="levelMin" value="INFO" />
			<param name="levelMax" value="INFO" />
			<param name="AcceptOnMatch" value="true" />
		</filter>
	</appender>

	<!-- 同上 回滚文件，有2个的原因就是演示，把不同的日志输出到不同的文件 -->
	<appender name="File" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="f:/ezLog/production.log" />
		<param name="Append" value="true"/>
		<param name="MaxFileSize" value="10MB"/>
		<param name="MaxBackupIndex" value="20"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%d %-5p: %c - %m%n" />
		</layout>
	</appender>

	<!-- 下面这些就是根据 这些路径来控制对应包下的文件的日志输出级别，基本上都是报错了，才输出日志-->
	<logger name="org.springframework.core">
		<level value="error" />
	</logger>

	<logger name="org.springframework.beans">
		<level value="error" />
	</logger>

	<logger name="org.springframework.context">
		<level value="error" />
	</logger>

	<logger name="org.springframework.http">
		<level value="error" />
	</logger>

	<logger name="org.springframework.web">
		<level value="error" />
	</logger>

	<logger name="org.elasticsearch.client.transport">
		<level value="debug" />
	</logger>

	<logger name="org.springframework.data.mongodb">
		<level value="error" />
	</logger>

	<!-- 这个就是自定义的一个logger -->
	<!-- 输出级别是info级别及以上的日志，不要怕，StreamOperateFile已经过滤，只输出info级别的日志 -->
	<!-- additivity 这个默认是true，即继承父类 root logger -->
	<!-- 也就是说，你的这个日志也会在root的logger里面输出的，我这里配置false，就是不继承，各走各的。 -->
	<!-- appender-ref 也就是说这个logger的输出目的地是哪里，ref就是关联到上面声明的一个file，一个console -->
	<logger name="StreamOperateFile" additivity="false">
		<level value="info" />
		<appender-ref ref="StreamOperateFile" />
		<appender-ref ref="console" />
	</logger>

	<!-- 传说中的根logger -->
	<!-- 输出级别是info级别及以上的日志，下面的ref关联的两个appender没有filter设置，所以，info及以上的日志都是会输出到这2个appender的 -->
	<root>
		<priority value="info" />
		<appender-ref ref="console" />
		<appender-ref ref="File" />
	</root>
</log4j:configuration>

以上参考

其他参考

properties文件配置参考

Java日志的前世今生