【SSH】从log4j看日志框架

前言

　　日志作为一个项目必不可少的一部分。开发阶段 ，它可以帮助我们发现程序中的问题，定位问题；产品阶段，它可以记录程序运行的过程与状况。
　　java中日志框架主要分为两类，一类是日志实现，包括JDK logger、Log4j、Logback、blitz4j等，另一类是日志门面，主要有common-logging、Slf4j(Simple Logging Facade for Java)等，它的作用是在日志记录实现的基础上提供一个封装的 API 层次，对日志记录 API 的使用者提供一个统一的接口，使得可以自由切换不同的日志记录实现。
　　本篇博文将以log4j为例，介绍相关知识。

---

log4j

一.log4j配置文件内容示例：

### direct log messages to stdout ###     
### 直接的日志信息到标准输出文件###
### stdout为数据源输出名称，file为文件输出名称 ###

### 一.把日志信息输出到控制台 ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender   ### 输出到控制台 ###
log4j.appender.stdout.Target=System.out   ### 使用System.out作为输出 ###
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout   ### 输出样式 布局模式###
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n   
### 日志输出信息格式为 “%时间  [%线程] %log级别 %完整类名 - %消息 %换行” ### 

### 二.把日志信息输出到文件 ### 
log4j.appender.file=org.apache.log4j.FileAppender   ### 把日志信息写到文件 ###
log4j.appender.file.File=c:/mylog.log  ### 输出文件位置 ###
log4j.appender.file.layout=org.apache.log4j.PatternLayout   ### 输出样式 布局模式###
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### 三.设置优先级别（error、warn、debug、info）以及输出源（控制台、文件） ###
### set log levels - for more verbose logging change 'info' to 'debug' ###

log4j.rootLogger=info, stdout

---

二.log4j是什么

　　Log4j是一个开源的日志记录管理工具，通过使用Log4j，我们可以控制日志信息输送的目的地、格式以及日志信息的级别。这些工作都可以放到一个配置文件中来处理，log4j目前支持的配置文件格式有properties和xml。

---

三.log4j核心

1 . Logger——完成日志信息的处理，可以设置输出优先级别　

　　级别共有一下7个，常用的是error、warm、info、debug

级别	名称	内容
1	off	最高等级，关闭所有日志记录
2	fatal	指出每个严重的错误事件将会导致应用程序的退出
3	error	指出虽然发生错误事件，但仍然不影响系统的继续运行
4	warm	表明会出现潜在的错误情形
5	info	一般和在粗粒度级别上，强调应用程序的运行全程
6	debug	一般用于细粒度级别上，对调试应用程序非常有帮助
7	all	最低等级，用于打开所有日志记录

2 . Appender——设置日志信息的去向

内容	解释
org.apache.log4j.ConsoleAppender	控制台
org.apache.log4j.FileAppender	文件
org.apache.log4j.DailyRollingFileAppender	每天产生一个日志文件
org.apache.log4j.RollingFileAppender	文件大小到达指定尺寸的时候产生一个新的文件
org.apache.log4j.WriterAppender	将日志信息以流格式发送到任意指定的地方
org.apache.log4j.JdbcAppender	将日志信息保存到数据库

3 . Layout——设置日志信息的输出样式

内容	解释
org.apache.log4j.HTMLLayout	以HTML表格形式布局
org.apache.log4j.PatternLayout	可以灵活地指定布局模式
org.apache.log4j.SimpleLayout	包含日志信息的级别和信息字符串
org.apache.log4j.TTCCLayout	包含日志产生的时间、线程、类别等信息

对于我们常用的Layout，它的常用参数主要有以下内容：

参数	内容
%m	输出代码中指定的消息
%M	输出打印该条日志的方法名
%p	输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r	输出自应用启动到输出该log信息耗费的毫秒数
%c	输出所属的类目，通常就是所在类的全名
%t	输出产生该日志事件的线程名
%n	输出一个回车换行符，Windows平台为”rn”，Unix平台为”n”
%d	输出日志时间点的日期或时间，默认格式为ISO8601
%l	输出日志事件的发生位置，包括类名、发生的线程、行数

---

四.怎么用

1.下载jar包 - apache-log4j-2.10.0，导入到项目中
2.新建log4j配置文件（放在src文件夹下），添加配置信息，示例如下：
（1）log4j.properties

### direct log messages to stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### direct messages to file mylog.log ###
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=c:/mylog.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### set log levels - for more verbose logging change 'info' to 'debug' ###
log4j.rootLogger=info, stdout

（2）log4j.xml
（来自https://www.cnblogs.com/godtrue/p/6444158.html）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration>

    <!-- 将日志信息输出到控制台 -->
    <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
        <!-- 设置日志输出的样式 -->
        <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>
        <!--过滤器设置输出的级别-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <!-- 设置日志输出的最小级别 -->
            <param name="levelMin" value="WARN" />
            <!-- 设置日志输出的最大级别 -->
            <param name="levelMax" value="ERROR" />
            <!-- 设置日志输出的xxx，默认是false -->
            <param name="AcceptOnMatch" value="true" />
        </filter>
    </appender>

    <!-- 将日志信息输出到文件，但是当文件的大小达到某个阈值的时候，日志文件会自动回滚 -->
    <appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender">
        <!-- 设置日志信息输出文件全路径名 -->
        <param name="File" value="D:/log4j/RollingFileAppender.log" />
        <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
        <param name="Append" value="true" />
        <!-- 设置保存备份回滚日志的最大个数 -->
        <param name="MaxBackupIndex" value="10" />
        <!-- 设置当日志文件达到此阈值的时候自动回滚，单位可以是KB，MB，GB，默认单位是KB -->
        <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="DailyRollingFileAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 设置日志信息输出文件全路径名 -->
        <param name="File" value="D:/log4j/DailyRollingFileAppender.log" />
        <!-- 设置日志每分钟回滚一次，即产生一个新的日志文件 -->
        <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" />
        <!-- 设置日志输出的样式 -->
        <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>


    <!--
     注意：
     1：当additivity="false"时，root中的配置就失灵了，不遵循缺省的继承机制
     2：logger中的name非常重要，它代表记录器的包的形式，有一定的包含关系，试验表明
        2-1：当定义的logger的name同名时，只有最后的那一个才能正确的打印日志
        2-2：当对应的logger含有包含关系时，比如：name=test.log4j.test8 和 name=test.log4j.test8.UseLog4j，则2-1的情况是一样的
        2-3：logger的name表示所有的包含在此名的所有记录器都遵循同样的配置，name的值中的包含关系是指记录器的名称哟！注意啦！
     3：logger中定义的level和appender中的filter定义的level的区间取交集
     4：如果appender中的filter定义的 levelMin > levelMax ，则打印不出日志信息
     -->

    <!-- 指定logger的设置，additivity指示是否遵循缺省的继承机制-->
    <logger name="test.log4j.test8.UseLog4j" additivity="false">
        <level value ="WARN"/>
        <appender-ref ref="DailyRollingFileAppender"/>
    </logger>

    <!--指定logger的设置，additivity指示是否遵循缺省的继承机制 -->
    <logger name="test.log4j.test8.UseLog4j_" additivity="false">
        <level value ="ERROR"/>
        <appender-ref ref="RollingFileAppender"/>
    </logger>

    <!-- 根logger的设置-->
    <root>
        <level value ="INFO"/>
        <appender-ref ref="ConsoleAppender"/>
        <!--<appender-ref ref="DailyRollingFileAppender"/>-->
    </root>

</log4j:configuration>

---

小结

　　log4j对程序的运行的性能影响非常小，我们可以广泛使用。