一、各种日志系统介绍
1. Commons-logging
Commons-logging也就是jcl,提供的是一个日志接口。自身提供一个简单的日志系统,但是一般是和其他日志系统组合使用。
如Commons-loggi+log4j。他会通过动态查找方式,在程序运行时自动找出真正使用的日志库。
2. slf4j
slf4j是simple logging facade for java.和Commons-logging类似,也是对其他日志系统进行门面封装。可以在部署的时候,通过桥接包来接入其他日志系统进行使用。他支持多个参数,并通过“{ }”占位符来进行替换。
3. log4j
log4j是logging for Java ,经典的日志解决方案。内部把日志系统抽象封装成Logger, Appender. Layout等实现。我们可以通过配置文件轻松地实现对日志系统的管理和多样化配置。log4j的三大板块。Logger日志写入器,Appender日志输出终端,Layout日志布局模式。其中Appender常用的有ConsoleAppender(输出到控制台)、FileAppender(输出文件)和RollingFileAppender(输出滚动文件)三种。
在classpath下编写配置文件log4j.properties或者log4j.xml,配置相关日志属性和格式。
4. log4j2
log4j2 是在log4j 1.x版本基础上的一个升级版本。性能得到提升的同时,还能够自动装载配置文件,支持参数变量的占位符功能,可以专门指定事件进行过滤,并且支持插件式架构。
5. logback
Logback是由log4j创始人涉及的又一个开源的日志组件,logback当前分成三个模块:logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现Slf4j API,使我们可以很方便地更换成其它日志系统,如:log4j或JDK。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。
二、springmvc + slf4j + log4j2配置
首先,应在Maven中加载所需依赖包,并通过桥接器将Slf4j和Log4j2组合起来使用。
1.添加spring依赖,这里用的spring版本是4.3.8
<!-- Spring -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${org.springframework-version}</version>
<!-- spring 自身的日志系统是基于commons-logging接口的,
本项目采用slf4j接口+log4j2 组合模式,为了避免冲突,
故需要在配置依赖中将spring中的Commons-logging取消依赖 -->
<exclusions>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${org.springframework-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${org.springframework-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${org.springframework-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${org.springframework-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jms</artifactId>
<version>${org.springframework-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>${org.springframework-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${org.springframework-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${org.springframework-version}</version>
</dependency>
注意 : Spring自身的日志系统是基于Commons-Logging接口的,而我们所采用的是Slf4j接口 + Log4j2组合模式,为了避免冲突,故需在配置依赖中将
Spring中的Commons-Logging取消依赖,如下操作:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${org.springframework-version}</version>
<!-- spring 自身的日志系统是基于commons-logging接口的,
本项目采用slf4j接口+log4j2 组合模式,为了避免冲突,
故需要在配置依赖中将spring中的Commons-logging取消依赖 -->
<exclusions>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
2. 配置slf4j依赖,(选用1.7.25版本)
<!-- slf4j config start -->
<!-- slf4j的核心包,只有日志接口,没有实现 -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j-version}</version>
</dependency>
<!-- jcl-over-slf4j桥接器,将jcl的日志输出重定向到slf4j中 -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>${jcl.over.version}</version>
</dependency>
<!-- slf4j config end -->
slf4j-api : Slf4j的核心包,只有日志的接口,并没有实现。
jcl-over-slf4j : 桥接器,将JCL的日志输出重定向到Slf4j中。
3. 配置log4j (版本选用2.8.2)
<!-- log4j2 config start -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>${log4j2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-web</artifactId>
<version>${log4j2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>${log4j2.version}</version>
</dependency>
<dependency>
<!-- 将log4j2和slf4j进行绑定 -->
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>${log4j2.version}</version>
</dependency>
<!-- log4j2 config end -->
log4j-slf4j-impl : 将log4j2 和 slf4j进行绑定。
4. 编写log4j2.xml配置文件
在resources目录下,编写log4j2.xml配置文件
注意: web3.0 以后,不用再在web.xml中配置listener和contextParam,会自动扫描到
<?xml version="1.0" encoding="UTF-8"?>
<!--
status:这个用于设置log4j2自身内部的信息输出,可以不设置,
当设置成trace时,你会看到log4j2内部各种详细输出。
monitorInterval : Log4j2能够自动检测修改配置文件和重新配置本身,
设置间隔秒数,单位是s,最小是5s.
-->
<configuration status="warn" monitorInterval="30">
<properties>
<property name="appName">stms</property>
<property name="LOG_HOME">D:/logs/${appName}</property>
<property name="layout">%d{yyyy-MM-dd HH:mm:ss:SSS}-[%-5level]-[%t] - [%logger{36}.%M: Line-%L] : %msg%n
</property>
</properties>
<Appenders>
<!--Console节点 配置控制台日志输出:
name:指定Appender的名字.
target: SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
PatternLayout: 输出格式,不设置默认为:%m%n.
-->
<Console name="Console" target="SYSTEM_OUT">
<!--ThresholdFilter 过滤器:
控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)
日志的级别: ALL< Trace < DEBUG < INFO < WARN < ERROR < FATAL < OFF。
-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<!--PatternLayout 日志输出格式模板:
%d{yyyy-MM-dd HH:mm:ss.SSS} 日志生成时间。
%-5level 日志级别(级别从左显示5个字符宽度)。
%logger{36} 表示logger名字最长36个字符,否则按照句点分割。
%L 日志输出所在行数 日志输出所在行数
[%t] 输出产生该日志事件的线程名
%msg 日志消息
%n 是换行符
eg:"2017-04-17 16:04:02.312 INFO com.zte.lucene.tools.DateUtils2Joda:424 [main] - Info Message!"
-->
<PatternLayout pattern="${layout}"/>
</Console>
<!--RollingFileAppender 定义输出滚动文件格式。(FileAppender 定义输出到文件)
name : RollingFileAppender的名字,用于与Loggers模块的绑定
fileName : 日志输出保存的文件路径
filePattern:满足条件后,日志输出保存的文件路径和名称。
(eg: 2017-04/search-2017-04-17-1.log)
-->
<RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/stms.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM}/stms-%d{yyyy-MM-dd}-%i.log">
<Filters>
<!--阀值过滤
onMatch DENY/ACCEPT 是否接受匹配到的日志
onMismatch DENY/NEUTRAL 是否接受未匹配的日志
-->
<!--随便提供一个高级别日志,用于允许打印高级日志-->
<!--重要的是,如果有多个ThresholdFilter,那么Filters是必须的,
同时在Filters中,首先要过滤更高级别的,将其NEUTRAL交给下一个高级别的过滤器处理,
不符合的日志级别,把不需要的DENY掉,然后再ACCEPT需要的日志级别,这个次序不能搞颠倒 -->
<ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
<PatternLayout pattern="${layout}"/>
<!-- Policies定义相关策略:-->
<Policies>
<!--TimeBasedTriggeringPolicy 基于时间的滚动策略:
该策略主要是完成周期性的log文件封存工作。
interval: integer型,指定两次封存动作之间的时间间隔,默认是1 hour。
单位:以日志的命名精度来确定单位,比如yyyy-MM-dd-HH 单位为小时,yyyy-MM-dd-HH-mm 单位为分钟。
关键点在于 filePattern后的日期格式.
modulate: boolean型,说明是否对封存时间进行调制。
若modulate=true,则封存时间将以0点为边界进行偏移计算。
比如:modulate=true,interval=4hours,那么假设上次封存日志的时间为01:00,
则下次封存日志的时间为04:00,之后的封存时间依次为08:00,12:00.
-->
<!-- log4j2的按天分日志文件 : search-%d{yyyy-MM-dd}.log -->
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<!-- SizeBasedTriggeringPolicy 基于对log文件大小的判断策略:
当log文件大于设定的阈值时,将触发封存动作。
可设定的log文件大小的单位有bytes、KB、MB或GB。
-->
<SizeBasedTriggeringPolicy size="500MB"/>
</Policies>
<!--DefaultRolloverStrategy(属性如不设置,则默认为最多同一文件夹下7个文件):
fileIndex: String类型,有两个选择“max”或“min”。
设置为“max”意味着将最新的日志信息封存在序号较大的封存文件中。“min”则相反。
max: integer类型,封存文件的序号的最大值。(超过最大值时,将有文件被删除)
min: integer类型,封存文件的序号的起始值。
相当于min和max两个参数设置了一个保存窗口,超出这个窗口的日志文件将会被删除。
-->
<DefaultRolloverStrategy max="100"/>
</RollingFile>
<RollingFile name="RollingFileError" fileName="${LOG_HOME}/stms-error.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM}/stms-error-%d{yyyy-MM-dd}.log">
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="${layout}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<SizeBasedTriggeringPolicy size="500MB"/>
</Policies>
<DefaultRolloverStrategy max="100"/>
</RollingFile>
</Appenders>
<!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
<Loggers>
<!-- 配置日志的根节点 -->
<!-- level="all" 只能够输出level级别是all及all以上的-->
<root level="all">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileError"/>
</root>
<!--
不能用这个写法,不然启动时会报错,无法读取level
<logger name="xx.xx.xx">
<level value="error"></level>
</logger>-->
<!-- Application Loggers -->
<logger name="com.guoy.stms" level="warn"></logger>
<!-- 3rdparty Loggers -->
《》
<logger name="org.quartz" level="error"></logger>
<logger name="org.springframework" level="info"></logger>
<logger name="com.zaxxer.hikari" level="error"></logger>
<logger name="org.hibernate" level="error"></logger>
<logger name="org.apache.mina" level="error"></logger>
<logger name="org.apache.shiro" level="error"></logger>
<logger name="net.sf.ehcache" level="error"></logger>
</Loggers>
</configuration>
最后,测试:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.List;
public class Test {
private static final Logger logger = LoggerFactory.getLogger(Test.class);
public static void main(String[] args) {
logger.info("info test");
logger.warn("warn test");
logger.error("error test");
}
}