JavaLog

通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件,甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;
我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。
最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。

Java中日志的使用

一、引言

1.1 日志介绍

用于记录系统中发生的各种事件。记录的位置常见的有:控制台、磁盘文件等

1.2 日志级别

日志级别从低到高:
TRACE、DEBUG、INFO、WARN、ERROR、FATAL

1.3日志作用

  • 通过日志观察、分析项目的运行情况(项目维护)
  • 通过日志分析用户的使用情况(大数据分析)

二、解决方案1

2.1 Log4j+Commons-Logging

2.1.1导入依赖

项目中添加Log4j和Commons-Logging的依赖

1
2
3
4
5
6
7
8
9
10
11
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>

<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
</dependency>

2.1.2 基本使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.junit.Test;

public class test {
//日志对象
private Log log = LogFactory.getLog(test.class);

@Test
public void test1() {
log.trace("hello trace");
log.debug("hello debug");
log.info("hello info");
log.warn("hello warn");
log.error("hello error");
log.fatal("hello fatal");
}
}

2.1.3 配置信息

创建配置文件 log4j.xml

占位符 描述
%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%C 输出所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符
%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%dfyyy-MM-dd HH:mm:ss,SSS},输出类似:2002-10-1822:10:28,921
%l 输出日志事件的发生位置,包括类名、发生的线程,以及在代码中的行数。举例:Testlo4.main(TestLog4.java:10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE log4j:configuration PUBLIC "-//LOGGER"
"http://org/apache/log4j/xml/log4j.dtd">

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

<!-- 输出到文件 -->
<appender name="myFile" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="F:/log/hello.log"/> <!-- 文件位置 -->
<param name="Append" value="true"/> <!-- 向文件内追加内容 -->
<param name="MaxFileSize" value="1kb"/> <!-- 文件最大字节数 -->
<param name="MaxBackupIndex" value="2"/> <!-- 新文件数量 -->
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="%-d{yyyy-MM-dd HH:mm:ss,SSS}[%c]-[%p]%m%n"/>
</layout>
</appender>

<!-- 输出到文件 每天新建一个日志文件 -->
<appender name="myFile1" class="org.apache.log4j.DailyRollingFileAppender">
<param name="File" value="F:/log/day.log"/> <!-- 文件位置 -->
<param name="Append" value="true"/> <!-- 向文件内追加内容 -->
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="%-d{yyyy-MM-dd HH:mm:ss,SSS}[%c]-[%p]%m%n"/>
</layout>
</appender>

<!--根logger的设置-->
<root>
<!--优先级设置,all < trace < debug < info < warn < error < fatal < off -->
<priority value="all"/>
<appender-ref ref="myConsole"/> <!-- 引用追加器 -->
<appender-ref ref="myFile"/>
<appender-ref ref="myFile1"/>
</root>
</log4j:configuration>

三、解决方案2

3.1 Logback+SLF4j

3.1.1 导入依赖

在项目中导入依赖

1
2
3
4
5
6
<!-- logback依赖,还会传递slf4j和logback-core-->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>

3.2.1 基本使用

Logback+SLF4j基本API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.qf.test;

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogTest {
private Logger log = LoggerFactory.getLogger(LogTest.class);

@Test
public void test1() {
log.trace("hello trace");
log.debug("hello debug");
log.info("hello info");
log.warn("hello warn");
log.error("hello error");
}
}

3.1.3 配置信息

创建logback.xml

占位符 描述
%d{yyyy-MM-dd HH:mm:ss.SSS} 日期
%5p 日志级别,5位字符长度显示,如果内容占不满5位则内容右对齐并在左侧补空格
%-5p 5位字符长度显示日志级别,如果内容占不满5位则内容左对齐并在右侧补空格-代表左对齐
%logger 日志所在包和类
%M 日志所在方法名
%L 日志所在代码行
%m 日志正文
%n 换行
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?xml version="1.0" encoding="UTF-8" ?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。
默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="true">
<property name="CONSOLE_LOG_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS} |-[%-5p] in %logger.%M[line-%L] -%m%n"/>
<property name="log.path" value="F:/log"/>

<!--输出到控制台-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!-- Threshold=即最低日志级别,此appender输出大于等于对应级别的日志
(当然还要满足root中定义的最低级别)
-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
<encoder>
<!-- 日志格式(引用变量)-->
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>

<!-- 追加到文件 -->
<appender name="file" class="ch.qos.logback.core.FileAppender">
<file>${log.path}/hello2.log</file>
<encoder>
<Pattern>
${CONSOLE_LOG_PATTERN}
</Pattern>
</encoder>
</appender>

<!--滚动追加到文件中-->
<appender name="file1" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}/hello.log</file>
<encoder>
<!-- 日志格式(引用变量)-->
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
<!--日志记录器的滚动策略,按日期,按大小记录
文件超过最大尺寸后,会新建文件,然后新的日志文件中继续写入
如果日期变更,也会新建文件,然后在新的日志文件中写入当天日志
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--新建文件后,原日志改名为如下 %i=文件序号,从0开始-->
<fileNamePattern>${log.path}/hello-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 每个日志文件的最大值 -->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>8kb</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!-- 日志文件保留天数, 1—则只保留昨天的归档日志文件,不设置则保留所有日志-->
<maxHistory>1</maxHistory>
</rollingPolicy>
</appender>

<root level="trace">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="file"/>
<appender-ref ref="file1"/>
</root>
</configuration>

本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!