日志框架
常见的日志框架
在项目开发过程中,我们可以通过 debug 查找问题。而在线上环境我们查找问题只能通过打印日志的方式查找问题。因此对于一个项目而言,日志记录是一个非常重要的问题。因此,如何选择一个合适的日志记录框架也非常重要
以下为常用的框架
框架 | 说明 |
---|---|
Log4j | Apache Log4j是一个基于Java的日志记录工具。它是由Ceki首创的,现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。 |
Log4j 2 | Apache Log4j 2是apache开发的一款Log4j的升级产品。 |
Commons Logging | Apache基金会所属的项目,是一套Java日志接口,之前叫Jakarta Commons Logging,后更名为Commons Logging。 |
Slf4j | 类似于Commons Logging,是一套简易Java日志门面,本身并无日志的实现。(Simple Logging Facade for Java,缩写Slf4j)。 |
Logback | 一套日志组件的实现(Slf4j阵营) |
Jul | (Java Util Logging),自Java1.4以来的官方日志实现。 |
日志框架关系
- Log4j 2与Log4j 1发生了很大的变化,Log4j 2不兼容Log4j 1。
- Commons Logging和Slf4j是日志门面(门面模式是软件工程中常用的一种软件设计模式,也被称为正面模式、外观模式。它为子系统中的一组接口提供一个统一的高层接口,使得子系统更容易使用)。Log4j和Logback则是具体的日志实现方案。可以简单的理解为接口与接口的实现,调用者只需要关注接口而无需关注具体的实现,做到解耦。
- 比较常用的组合使用方式是Slf4j与Logback组合使用,Commons Logging与Log4j组合使用。
- Logback必须配合Slf4j使用。由于Logback和Slf4j是同一个作者,其兼容性不言而喻。
log4j的使用
共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF
log4j 1.2.x版本的使用
依赖信息
<!--门面commons-logging-->
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
第一步:配置文件:log4j.properties
不一定要全部添加
### set log levels - for more verbose logging change 'info' to 'debug' , 'off' ###
log4j.rootLogger=info【打印info以上的级别,可以修改】, stdout,file,daily,R
【调试的时候用,平常可以把参数调成off】
【All < Trace < Debug < Info < Warn < Error < Fatal < OFF】
###1 direct log messages to stdout ###
log4j.appender.stdout【跟上面一样】=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.err
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE}【时间】 %5p %c{1}:%L - %m%n
###2 direct messages to file mylog.log ###
log4j.appender.file【在上面添加file】=org.apache.log4j.FileAppender
log4j.appender.file.File=d:\\mylog.log 【日志输出地址】
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
###3每天生成一个文件
log4j.appender.daily=org.apache.log4j.DailyRollingFileAppender
log4j.appender.daily.File=d:\\logs\\soso.log
log4j.appender.daily.Append=true
log4j.appender.daily.Threshold=INFO
log4j.appender.daily.ImmediateFlush=true
#生成一个配置文件 命名 soso.8888-88-88-88 时间
log4j.appender.daily.DatePattern='_'yyyy-MM-dd'.txt'
log4j.appender.daily.layout=org.apache.log4j.PatternLayout
log4j.appender.daily.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
###4控制每个滚动日志文件大小和个数
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.Threshold=DEBUG
log4j.appender.R.File=d:\\logs\\test.log
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%5p] - %c -%F(%L) -%m%n
log4j.appender.R.MaxFileSize=1kb
log4j.appender.R.MaxBackupIndex=5【5个文件】
第二步:java测试类:
public class Demo1 {
public static void main(String[] args) {
//不用日志框架
System.out.println("xxxx");
Logger logger = LogManager.getLogger(LogDemo2.class.getName());
//门面使用
//Log logger = LogFactory.getLog(Demo2.class.getName());
//使用日志
logger.trace("跟踪信息");
logger.debug("调试信息");
logger.info("信息");
logger.warn("警告信息");
logger.error("错误信息");
logger.fatal("致命错误");
}
}
log4j 2.x的使用
依赖信息
<!--门面commons-logging-->
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.11.1</version>
</dependency>
如果和commons-logging配合使用需要添加log4j-jcl依赖
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-jcl</artifactId>
<version>2.11.1</version>
</dependency>
第一步:配置文件:log4j2.xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
<Console name="STDOUT" target="SYSTEM_OUT">
<PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/>
</Console>
</Appenders>
<Loggers>
<Root level="warn">
<AppenderRef ref="STDOUT"/>
</Root>
</Loggers>
</Configuration>
第二步 编写java类测试:
public class LogDemo2 {
public static void main(String[] args){
Logger logger = LogManager.getLogger(LogDemo2.class.getName());
//门面使用
//Log logger = LogFactory.getLog(Demo2.class.getName());
logger.trace("entry"); //等同于logger.entry();但此方法在新版本好像已经废弃
logger.error("Did it again!");
logger.info("这是info级信息");
logger.debug("这是debug级信息");
logger.warn("这是warn级信息");
logger.fatal("严重错误");
logger.trace("exit");
}
}
logback的使用
logback是java的日志开源组件,是log4j创始人写的,性能比log4j要好,目前主要分为3个模块
- logback-core:核心代码模块
- logback-classic:log4j的一个改良版本,同时实现了
slf4j
的接口,这样你如果之后要切换其他日志组件也是一件很容易的事 - logback-access:访问模块与Servlet容器集成提供通过Http来访问日志的功能
依赖如下:
<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.26</version>
</dependency>
logback.xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration >
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_HOME" value="D:/" /><!-- 日志文件的家目录 -->
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss" /><!-- 生成指定格式的时间戳,用于日志文件的唯一命名 -->
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<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>
</appender>
<appender name="fileAppender" class="ch.qos.logback.core.FileAppender">
<immediateFlush>true</immediateFlush><!-- 立即刷新输出流,设置为 false 可以提高日志吞吐量 -->
<file>${LOG_HOME}${bySecond}.log</file><!-- 日志文件路径 -->
<encoder><!-- 日志输出格式,必须指定,否则不会往文件输出内容 -->
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>
</encoder>
<append>true</append><!-- 追加 -->
<prudent>false</prudent><!-- 关闭严格模式,也提高日志吞吐量(3倍),默认false -->
</appender>
<!-- 日志输出级别 -->
<root level="DEBUG">
<appender-ref ref="STDOUT" />
</root>
</configuration>
测试代码:
Logger logger = LoggerFactory.getLogger(Demo3.class.getName());
logger.trace("跟踪信息_logback");
logger.debug("调试信息_logback");
logger.info("基本信息_logback");
logger.warn("警告信息_logback");
logger.error("错误信息_logback");