3.2.3、log4j2使用
与 log4j 类似,直接在需要位置打印日志即可
package org.example.log4j.service; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class LogPrintUtil { /**log静态常量*/ private static final Logger logger = LoggerFactory.getLogger(LogPrintUtil.class); public static void main(String[] args){ logger.info("info信息"); logger.warn("warn信息"); logger.error("error信息"); } }
四、Logback
4.1、介绍
Logback 也是用 java 编写一款非常热门的日志开源框架,由 log4j 创始人写的,性能比 log4j 要好!
logback 主要分为3个模块:
- logback-core:核心代码模块
- logback-classic:log4j的一个改良版本,同时实现了slf4j的接口,这样你如果之后要切换其他日志组件也是一件很容易的事
- logback-access:访问模块与Servlet容器集成提供通过Http来访问日志的功能
4.2、项目应用
4.2.1、添加 maven 依赖
<!--这个依赖直接包含了 logback-core 以及 slf4j-api的依赖--> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.3</version> </dependency> <!-- 支持在xml中写判断标签 --> <dependency> <groupId>org.codehaus.janino</groupId> <artifactId>janino</artifactId> <version>2.7.8</version> </dependency>
4.2.2、创建logback配置文件
1、配置说明
logback在启动的时候,会按照下面的顺序加载配置文件:
- 如果java程序启动时指定了
logback.configurationFile
属性,就用该属性指定的配置文件。如java -Dlogback.configurationFile=/path/to/mylogback.xml Test
,这样执行Test
类的时候就会加载/path/to/mylogback.xml
配置 - 在
classpath
中查找logback.groovy
文件 - 在
classpath
中查找logback-test.xml
文件 - 在
classpath
中查找logback.xml
文件 - 如果是
jdk6+
,那么会调用ServiceLoader
查找com.qos.logback.classic.spi.Configurator
接口的第一个实现类 - 自动使用
ch.qos.logback.classic.BasicConfigurator
,在控制台输出日志
上面的顺序表示优先级,使用java -D
配置的优先级最高,只要获取到配置后就不会再执行下面的流程。相关代码可以看ContextInitializer#autoConfig()
方法。
2、同步输出日志
<?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="false"> <!-- 运行环境,dev:开发,test:测试,pre:预生产,pro:生产 --> <property name="system_host" value="dev" /> <property file="system.properties" /> <!-- 上下文变量设置,用来定义变量值,其中name的值是变量的名称,value的值时变量定义的值。 通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 --> <property name="CONTEXT_NAME" value="logback-test" /> <!-- 日志文件存放路径设置,绝对路径 --> <property name="logs.dir" value="/opt/logs" /> <!-- 日志文件存放路径设置,tomcat路径 --> <property name="logs.dir" value="${catalina.base}/logs" /> <!-- 定义日志文件 相对输入位置 --> <property name="log_dir" value="log" /> <!-- 日志输出格式设置 --> <!-- %d{yyyy-MM-dd HH:mm:ss} [%level] - %msg%n Logger: %logger Class: %class File: %file Caller: %caller Line: %line Message: %m Method: %M Relative: %relative Thread: %thread Exception: %ex xException: %xEx nopException: %nopex rException: %rEx Marker: %marker newline:%n --> <property name="CUSTOM_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{90} - %msg%n" /> <!-- 上下文名称:<contextName>, 每个logger都关联到logger上下文, 默认上下文名称为“default”。但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录。 一旦设置,不能修改。 --> <contextName>${CONTEXT_NAME}</contextName> <!-- <appender>是<configuration>的子节点,是负责写日志的组件。 有两个必要属性name和class。name指定appender名称, class指定appender的实现类。 --> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!-- 对日志进行格式化。 --> <encoder> <pattern>${CUSTOM_LOG_PATTERN}</pattern> <charset>UTF-8</charset> </encoder> </appender> <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 按天来回滚,如果需要按小时来回滚,则设置为{yyyy-MM-dd_HH} --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>log/testC.%d{yyyy-MM-dd}.%i.log</fileNamePattern> <!-- 如果按天来回滚,则最大保存时间为30天,30天之前的都将被清理掉 --> <maxHistory>30</maxHistory> <!-- 按时间回滚的同时,按文件大小来回滚 --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!-- 过滤器,只记录WARN级别的日志 --> <!-- 果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <!-- 设置过滤级别 --> <level>WARN</level> <!-- 用于配置符合过滤条件的操作 --> <onMatch>ACCEPT</onMatch> <!-- 用于配置不符合过滤条件的操作 --> <onMismatch>DENY</onMismatch> </filter> <!-- 日志输出格式 --> <encoder> <pattern>${CUSTOM_LOG_PATTERN}</pattern> <charset>UTF-8</charset> </encoder> </appender> <appender name="log_file" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。 --> <file>${logs.dir}/logback-test.log</file> <!-- 按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志 --> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <!-- 必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip --> <FileNamePattern>${logs.dir}/logback-test.%i.log</FileNamePattern> <!-- 窗口索引最小值 --> <minIndex>1</minIndex> <!-- 窗口索引最大值 --> <maxIndex>3</maxIndex> </rollingPolicy> <!-- 日志级别过滤器 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <!-- 日志级别过滤器 --> <level>INFO</level> <!-- 符合要求的日志级别,过滤,ACCEPT:接受 --> <onMatch>ACCEPT</onMatch> <!-- 不符合要求的日志级别,过滤,DENY:拒绝 --> <onMismatch>DENY</onMismatch> </filter> <!-- 激活滚动的条件。 --> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <!-- 活动文件的大小,默认值是10MB --> <maxFileSize>30MB</maxFileSize> </triggeringPolicy> <!-- 对记录事件进行格式化。 --> <encoder> <pattern>${CUSTOM_LOG_PATTERN}</pattern> <charset>UTF-8</charset> </encoder> </appender> <!-- 异步输出 --> <appender name="ASYNC_logback" class="ch.qos.logback.classic.AsyncAppender"> <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 --> <!-- <discardingThreshold>0</discardingThreshold> --> <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 --> <!-- <queueSize>256</queueSize> --> <!-- 添加附加的appender,最多只能添加一个 --> <appender-ref ref="log_file" /> </appender> <!-- 指定包输出路径 --> <!-- 用来设置某一个 包 或者具体的某一个 类 的日志打印级别、以及指定<appender>, name:用来指定受此logger约束的某一个包或者具体的某一个类。 level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。 additivity:是否向上级logger传递打印信息。默认是true。(这个logger的上级就是上面的root) <logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个logger。 --> <logger name="org.logback.test" level="DEBUG" additivity="true"> <appender-ref ref="stdout" /> </logger> <!-- 特殊的<logger>元素,是根logger。只有一个level属性,应为已经被命名为"root". level:设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。 <root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。 --> <root> <level value="WARN" /> <!-- if表达式,需要Janino jar --> <!-- Janino 2.6.0版本开始,除了janino.jar之外, commons-compiler.jar也需要在类路径中 --> <if condition='property("system_host").contains("dev")'> <then> <appender-ref ref="stdout" /> </then> </if> <appender-ref ref="file" /> </root> </configuration>
注意:logback
如果配置要输出行号,性能会明显降低,如果不是必须,建议不要配置!
4.2.3、logback使用
package org.example.logback.service; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class LogPrintUtil { /**log静态常量*/ private static final Logger logger = LoggerFactory.getLogger(LogPrintUtil.class); public static void main(String[] args){ logger.info("info信息"); logger.warn("warn信息"); logger.error("error信息"); } }
五、SLF4J桥接
细心的你,会发现上面代码使用时,都使用的是private static final Logger logger = LoggerFactory.getLogger(LogPrintUtil.class)
这个,其中都来自org.slf4j
包,SLF4J
是啥?有什么作用呢?
SLF4J
本身并不输出日志,最大的特色是**:它可以通过适配的方式挂接不同的日志系统,属于一个日志接口**。
如果项目适配到log4j
就使用log4j
日志库进行输出;如果适配到logback
就使用logback
日志库进行输出;如果适配到log4j2
就使用log4j2
日志库进行输出。
这样最大的好处,就是当你想将项目从log4j
换成log4j2
的时候,只需要在项目pom.xml
中进行桥接适配即可,不用修改具体需要打印日志的代码!
六、三大主流日志框架性能比较
介绍了这么多,但是我们还不知道三个日志框架的日志输出性能如何,本文以10000条数据进行打印,比较log4j
、log4j2
、logback
日志的输出时间。
本次测试采用的是本地电脑(win7),每个电脑的配置不一样,测试的结果也不一样,结果是真实的。
- 同步输出
- 异步输出
从测试结果上可以看出:
- 不建议生产环境进行控制台输出;
- 在纯文件输出的环境下,
logback
的输出优于log4j2
,而log4j2
要优于log4j
,如果要进行生产环境的部署,建议采用logback
,如果是使用log4j2
,建议使用异步方式进行输出,输出结果基本是实时输出;
最后需要注意的地方是:log
有风险,输出需谨慎!
由于输出log
过程需要进行磁盘操作,且log4j
为了保证log
输出过程的线程安全性而使用同步锁,就使得输出log
成为很耗时的操作,所以log
信息一定要言简意赅,不要输出一些无用的log
。
七、总结
本文主要围绕项目中使用到的日志框架进行应用介绍,限于笔者的才疏学浅,对本文内容可能还有理解不到位的地方,如有阐述不合理之处还望留言一起探讨。