Skip to content

Latest commit

 

History

History
218 lines (159 loc) · 5.6 KB

java-log.md

File metadata and controls

218 lines (159 loc) · 5.6 KB
Raw

Java Log

[TOC]

参考文献

jdk Logging

jdk 自带的日志系统，不常用。

// logging
import java.util.logging.Level;
import java.util.logging.Logger;

public class Hello {
    public static void main(String[] args) {
        Logger logger = Logger.getGlobal();
        logger.info("start process...");
        logger.warning("memory is running out...");
        logger.fine("ignored.");
        logger.severe("process will be terminated...");
    }
}

/*
Mar 02, 2019 6:32:13 PM Hello main
INFO: start process...
Mar 02, 2019 6:32:13 PM Hello main
WARNING: memory is running out...
Mar 02, 2019 6:32:13 PM Hello main
SEVERE: process will be terminated...
*/

7 个日志级别

SEVERE
WARNING
INFO
CONFIG
FINE
FINER
FINEST

Commons Logging / Log4j

Commons Logging

第三方日志库，Apache创建的日志模块。

Commons Logging 是接口，Log4J 是实现。

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class Main {
    public static void main(String[] args) {
        Log log = LogFactory.getLog(Main.class);
        log.info("start...");
        log.warn("end.");
    }
}

6 个日志级别：

FATAL
ERROR
WARNING
INFO
DEBUG
TRACE

在实例方法中定义 Log

// 在实例方法中引用Log:
public class Person {
    protected final Log log = LogFactory.getLog(getClass()); // 注意此处的 getClass()，这么写的好处是，子类也可以直接使用该 Log 实例
    void foo() {
        log.info("foo");
    }
}

记录异常：

try {
    ...
} catch (Exception e) {
    log.error("got exception!", e);
}

Log4j

Log4j 是 Commons Logging 的实现，其功能类似于 Django Logging。

Commons Logging 会自动发现并使用 Log4j。

SLF4J / Logback

SLF4J类似于Commons Logging，也是一个日志接口，而Logback类似于Log4j，是一个日志的实现。

SLF4J + logback 是现在最常用的日志系统。

logback 会自动扫描 classpath 中的 logback.xml 文件。

Maven 配置

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.1.7</version>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.20</version>
</dependency>

logback

logback 配置文档详解：https://blog.csdn.net/millery22/article/details/86672284

  • appender

    是用来定义一个写日志记录的组件，常用的appender类有ConsoleAppender和RollingFileAppender，前者个是用来在控制台上打印日志，后者是将日志输出到文件中。

  • layout

    是指定日志的布局方式，这个基本都不会去特殊的指定，可以忽略，知道有这个东西即可。

  • encoder

    负责把事件转换成字节数组并把字节数组写到合适的输出流。encoder可以指定属性值class，这里对应的类只有一个PatternLayoutEncoder，也是默认值，可以不去指定。

  • filter

    过滤器分为三种，logback-classic提供的是两种，分别是常规的过滤器和Turbo过滤器。常用的过滤器就是按照日志级别来控制，将不同级别的日志输出到不同文件中，便于查看日志。如：错误日志输出到xxx-error.log，info日志输出到xxx-info.log中。

  • rollingPolicy

    用来设置日志的滚动策略，当达到条件后会自动将条件前的日志生成一个备份日志文件，条件后的日志输出到最新的日志文件中。常用的是按照时间来滚动（使用的类TimeBaseRollingPolicy）,还有一种就是基于索引来实现（使用的类FixedWindowRollingPolicy）

  • triggeringPolicy

    日志触发器策略，常用的是日志的大小的控制，当日志达到对应的大小的时候，就会触发。生成新的日志文件。日志大小的控制配合rollingPlicy使用的时候，不同的rollingPolicy会有所不同

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <file>log/jqx-message-push.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>log/output.log.%i</fileNamePattern>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- INFO 表示只输出 INFO 级别及以上的日志，FILE 和 CONSOLE 表示该日志配置有两个输出，一个输出到控制台，一个输出到 FILE -->
    <root level="INFO">
        <appender-ref ref="FILE" />
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

Demo

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class Main {
    final Logger logger = LoggerFactory.getLogger(getClass());
    logger.info("Set score {} for Person {} ok.", score, p.getName());
}
try{
    entityItemRepo.save(entityItem);
}catch (IllegalArgumentException e){
    log.error("save {} failed", "entityItem", e);
}