web开发-日志框架-------slf4j+logback

 

参考文章

• log桥接工具jcl-over-slf4j使用(项目排除commons-logging依赖的影响) https://blog.csdn.net/javaloveiphone/article/details/52486257
• logback的使用和logback.xml详解 http://www.cnblogs.com/warking/p/5710303.html

概述

• log4j（Log for Java）、java.logging、logback等都是具体的日志框架，每一个都可以独立地完成日志记录的功能。
• commons-logging、slf4j（Simple Logging Facade for Java）都只是统一的接口，并不是日志系统的具体实现。只有一套标准是无法完成日志记录功能的。当我们调用接口时，接口的工厂会自动寻找恰当的实现，返回一个实现的实例给我服务。
• Apache Commons Logging （曾用名： Jakarta Commons Logging，JCL）JCL 只提供 log 接口，具体的实现则在运行时动态寻找。这样一来组件开发者只需要针对 JCL接口开发，而调用组件的应用程序则可以在运行时搭配自己喜好的日志实践工具。当程序规模越来越庞大时，JCL的动态绑定并不是总能成功，解决方法之一就是在程序部署时静态绑定指定的日志工具，这就是 SLF4J 产生的原因之一。
• 现在的开发一般是slf4j+桥接器+logback模式
• 注：导入了redis相关jar包之后，会自动包含jcl-over-slf4j（桥接器，将已经使用了 JCL 的，还有一些组建可能直接调用了 java.util.logging的程序的日志重定向到slf4j处理）与slf4j-api包。

logback

• logback:logback可以认为是log4j的升级版，使用简单，只需要在classpath里包含slf4j-api.jar、logback-core.jar以及logback-classic.jar即可。
• logback包含3个子工程——classic、core和access
• • core 基础核心模块
  • classic 扩展了core,内置slf4j，完整实现slf4j api接口，也支持各种其他log门面
  • access 与Servlet容器集成提供通过Http访问日志的功能

配置 slf4j+桥接器+logback 日志框架

1. 导入jar包（这里只导入必须的jar包）

    <!--slf4j+logback-->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.5</version>
    </dependency>
    <dependency>
    <groupId>ch.qos.logback</groupId>
      <artifactId>logback-core</artifactId>
      <version>1.2.1</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
    <version>1.2.1</version>
    </dependency>

2. 配置logback.xml文件

<?xml version="1.0" encoding="UTF-8" ?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!--Linux参考输出路径  /home/testDemoLog/-->
    <property name="CONTEXT_NAME" value="X:/testDemoLog/"/>
    <contextName>${CONTEXT_NAME}</contextName>

    <!--判断是否是Windows或者Mac系统（一般这两个是开发系统，服务器是Linux），将日志打印到控制台，需要导入org.codehaus.janino包，否则判断无效-->
    <if condition='property("os.name").toUpperCase().contains("WINDOWS")||property("os.name").toUpperCase().contains("MAC")'>
        <then>
            <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
                <encoder>
                    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36}---/%n-/%msg%n%n</pattern>
                </encoder>
            </appender>
            <root>
                <appender-ref ref="STDOUT"/>
            </root>
        </then>
    </if>

    <appender name="ERROR_FILE" class="ch.qos.logback.core.FileAppender">
        <file>${CONTEXT_NAME}/error/error.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:  %msg%n</pattern>
        </encoder>
        <!--过滤器，只把该级别的日志记录在文件中-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
            <level>WARN</level>
        </filter>
    </appender>

    <appender name="INFO_ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${CONTEXT_NAME}/info/info_%d{yyyy-MM-dd}.log</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <logger name="com.equator" level="ERROR" additivity="true">
        <appender-ref ref="ERROR_FILE" />
    </logger>
    <logger name="com.equator" level="INFO" additivity="true">
        <appender-ref ref="INFO_ROLLING_FILE"/>
    </logger>

</configuration>

3. 如果logback.xml文件不在ClassPath下，需要在web.xml中声明logback.xml的位置

  <context-param>
    <param-name>logbackConfigLocation</param-name>
    <param-value> classpath:logback.xml</param-value>
  </context-param>

4.使用日志功能

• 通过LoggerFactory获取Logger实例，传入需要打印日志的.class类，方便区分不同的class与package

public class App {
　　private final static Logger logger = LoggerFactory.getLogger(App.class);
　　　　public static void main(String[] args) {
　　　　　　logger.info("打印info级别的日志");
　　　　　　logger.error("打印error级别的日志");
　　　　　　logger.debug("打印debug级别的日志");
　　　　}
　　}

logback.xml文件配置详解

根节点<configuration>

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

子节点<contextName>

• 用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

子节点<property>

• 用来定义变量值，它有两个属性name和value，通过<property>定义的值会被插入到logger上下文中，可以使“${}”来使用变量
• 属性：
  • name: 变量的名称
  • value: 的值时变量定义的值

子节点<timestamp>

• 获取时间戳字符串
• 属性：
  • key: 标识此<timestamp> 的名字
  • datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。

子节点<appender>

• 负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名，常用的有三种：ConsoleAppender、FileAppender、RollingFileAppender
  • ConsoleAppender
    • 子节点：
      • <encoder>：对日志进行格式化。
      • <target>：System.out(默认)或者System.err
  • FileAppender
    • 子节点：
      • <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
      • <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
      • <encoder>：对记录事件进行格式化。
      • <prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。
  • RollingFileAppender
    • 子节点：
      • <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
      • <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
      • <rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类，常用的有：
        • TimeBasedRollingPolicy 根据时间来制定滚动策略，既负责滚动也负责出发滚动
          • <fileNamePattern>子节点，默认格式是 yyyy-MM-dd
          • <maxHistory> （可选）子节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。
        • SizeBasedTriggeringPolicy 根据当前活动文件的大小来制定滚动策略
          • <maxFileSize>:这是活动文件的大小，默认值是10MB。
          • <prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
          • <triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动

子节点<logger>

• 用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。
• 属性：
  • name: 用来指定受此loger约束的某一个包或者具体的某一个类。
  • level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特殊值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前loger将会继承上级的级别。
  • addtivity: 是否向上级logger传递打印信息。默认是true。
  • 同<logger>一样，可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger。

子节点<root>

• 它也是<logger>元素，但是它是根logger，是所有<logger>的上级。只有一个level属性，因为name已经被命名为"root"（所以无name属性），且已经是最上级了（所以无addtivity属性），所有属性addtivity为true的logger都会向root传递打印日志信息。