5、日志系统

日志系统

日志文件

调试日志

软件开发中,我们经常需要去调试程序,做一些信息,状态的输出便于我们查询程序的运行状况。为了让我们能够更加灵活和方便的控制这些调试的信息,所以我们需要专业的日志技术。java中寻找bug会需要重现。调试也就是debug 可以在程序运行中暂停程序运行,可以查看程序在运行中的情况。日志主要是为了更方便的去重现问题。

系统日志

系统日志是记录系统中硬件、软件和系统问题的信息,同时还可以监视系统中发生的事件。用户可以通过它来检查错误发生的原因,或者寻找受到攻击时攻击者留下的痕迹。系统日志包括系统日志、应用程序日志和安全日志。

Java日志框架

一般有两种日志相关的框架,日志框架和日志门面,区别在于:每一种日志框架都有自己单独的API,要使用对应的框架就要使用对应的API,这就大大的增加了应用程序代码对于日志框架的耦合性。我们使用了日志门面技术之后,对于应用程序来说,无论底层的日志框架如何改变,应用程序不需要修改任何代码,就可以直接上线了。

也就是可以理解为,日志门面是对日志框架技术整合的框架。

日志框架

常用的日志框架有如下:

日志门面

常用的日志门面如下:

日志框架

JUL

是java原生的日志框架,使用时不需要另外引用第三方的类库,相对其他的框架使用方便,学习简单,主要是使用在小型应用中。

主要组件

简单使用

// 创建Logger实例
Logger logger = Logger.getLogger("top.ygang.demo_mvn");

// 配置,如下配置都不是必须的,有默认的
// 关闭按照父Logger的默认设置进行配置
logger.setUseParentHandlers(false);
// 获取日志控制台处理实例
ConsoleHandler handler = new ConsoleHandler();
// 创建日志格式化组件实例
SimpleFormatter formatter = new SimpleFormatter();
handler.setFormatter(formatter);
// 在Logger中添加处理器(可以添加多个处理器同时处理)
logger.addHandler(handler);
// 设置日志的处理级别
logger.setLevel(Level.ALL);
handler.setLevel(Level.ALL);

// 打印所有级别的日志
logger.severe("severe log...");
logger.warning("warning log...");
logger.info("info log...");
logger.config("config log...");
logger.fine("fine log...");
logger.finer("finer log...");
logger.finest("finest log...");
// 也可以这样打印
logger.log(Level.INFO,"info log...");

// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 严重: severe log...
// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 警告: warning log...
// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 信息: info log...
// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 配置: config log...
// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 详细: fine log...
// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 较详细: finer log...
// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 非常详细: finest log...
// 十一月 09, 2023 8:27:50 下午 top.ygang.demo_mvn.Main main
// 信息: info log...

字符串模板

// 创建Logger实例
Logger logger = Logger.getLogger("top.ygang.demo_mvn");
// {}中填写对应index
logger.log(Level.INFO,"name:{0},age:{1}",new Object[]{"lucy",18});

FileHandler

FileHandler可以将日志输出到磁盘中,FileHandler默认使用的是XMLFormatter,以XML的形式输出日志,可以自己替换

Logger logger = Logger.getLogger("top.ygang.demo_mvn");

FileHandler fileHandler = new FileHandler("/Users/yanggang/develop/test.log");
logger.addHandler(fileHandler);

logger.info("test file log...");

父子关系

JUL中的Logger之间是可以存在父子关系的,父Logger所做的设置可以同时作用于子Logger,子Logger可以使用logger.setUseParentHandlers(false);来关闭继承父Logger配置。所有的Logger的父Logger是RootLogger,名称是""空字符串,JUL在初始化时会创建一个顶层RootLogger作为所有Logger的父Logger。集成关系一般等同于路径的父子关系。

Logger logger1 = Logger.getLogger("top.ygang");
Logger logger2 = Logger.getLogger("top.ygang.demo_mvn");
System.out.println("logger1:" + logger1);
System.out.println("logger2:" + logger2);
System.out.println("logger1's parent:" + logger1.getParent() + ",name:" + logger1.getParent().getName());
System.out.println("logger2's parent:" + logger2.getParent() + ",name:" + logger2.getParent().getName());

// logger1:java.util.logging.Logger@45ee12a7
// logger2:java.util.logging.Logger@330bedb4
// logger1's parent:java.util.logging.LogManager$RootLogger@2503dbd3,name:
// logger2's parent:java.util.logging.Logger@45ee12a7,name:top.ygang

配置文件

默认使用的配置文件位于jre_path/lib/logging.properties

# RootLogger的日志级别
.level= ALL

# 启用的Handler,多个可以使用逗号分割
handlers=java.util.logging.ConsoleHandler,java.util.logging.FileHandler

# 文件处理器属性设置
# 输出日志文件的路径
java.util.logging.FileHandler.pattern = %h/java%u.log
# 输出日志文件的限制(50000字节)
java.util.logging.FileHandler.limit = 50000
# 设置日志文件的数量
java.util.logging.FileHandler.count = 1
# 输出日志的格式
# 默认是以XML的方式进行的输出
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter

# 控制台处理器属性设置
# 控制台输出默认的级别
java.util.logging.ConsoleHandler.level = ALL
# 控制台默认输出的格式
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

# 也可以将日志级别设定到具体的某个包下
top.ygang.level = SEVERE

可以根据自己的需要修改后,进行加载

// 加载配置文件
InputStream inputStream = Main.class.getClassLoader().getResourceAsStream("logging.properties");
LogManager logManager = LogManager.getLogManager();
logManager.readConfiguration(inputStream);

Logger logger = Logger.getLogger("top.ygang");
logger.fine("fine log...");

Log4j

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

依赖

<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

配置文件

ClASSPATH下建立配置文件log4j.properties,Maven项目就是resources目录下

log4j.rootLogger = INFO, FILE, CONSOLE

log4j.appender.FILE=org.apache.log4j.FileAppender
log4j.appender.FILE.File=log.log
log4j.appender.FILE.ImmediateFlush=true
log4j.appender.FILE.Threshold = DEBUG
log4j.appender.FILE.Append=true
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.conversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss:SSS} (%c\:%L)-(%t) : %m%n

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.ImmediateFlush=true
log4j.appender.CONSOLE.Threshold = DEBUG
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.encoding=UTF-8
log4j.appender.CONSOLE.layout.conversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss:SSS} (%c\:%L)-(%t) : %m%n

三大组件

在实际应用中,要使Log4j在系统中运行须事先设定配置文件。配置文件事实上也就是对Logger、Appender及Layout进行相应设定。

Logger

固定语法格式:log4j.rootLogger = [ level ] , appenderName, appenderName, …

log4j.rootLogger = INFO, FILE, CONSOLE
Appenders

log4j默认定义了几种输出目的

ConsoleAppender

将日志信息输出到控制台中

log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender
# 将日志信息使用System.out.println输出到控制台
log4j.appender.CONSOLE.Target=System.out
# 表示所有信息都会被立即输出,设为false则不输出,默认值是true。
log4j.appender.CONSOLE.ImmediateFlush=true
# 指定日志输出的最低级别,默认为DEBUG
log4j.appender.CONSOLE.Threshold=DEBUG
# 设置日志输出的编码
log4j.appender.CONSOLE.encoding=UTF-8
FileAppender

将日志信息输出到对应的磁盘文件中

log4j.appender.FILE = org.apache.log4j.FileAppender
# 指定日志输出的最低级别,默认为DEBUG
log4j.appender.FILE.Threshold = DEBUG
# 日志输出的路径
log4j.appender.FILE.File=e:/mylog.log
# 设置日志输出的编码
log4j.appender.FILE.Encoding=UTF-8
# 将新增日志追加到文件中,默认为true,false为覆盖
log4j.appender.FILE.Append=false
# # 表示所有信息都会被立即输出,设为false则不输出,默认值是true。
log4j.appender.FILE.ImmediateFlush=true
# 是否使用缓冲,当缓存满了后才输出到磁盘文件中,默认为false
log4j.appender.FILE.BufferedIO=true
# 缓冲区大小
log4j.appender.FILE.BufferSize=8192
DailyRollingFileAppender

将输出的日志信息,固定周期产生一个日志文件

log4j.appender.DRFILE = org.apache.log4j.DailyRollingFileAppender
# 日志输出的路径
log4j.appender.DRFILE.File=e:/log.out
# 表示所有信息都会被立即输出,设为false则不输出,默认值是true。
log4j.appender.DRFILE.ImmediateFlush=true
# 指定日志输出的最低级别,默认为DEBUG
log4j.appender.DRFILE.Threshold=DEBUG
# 将新增日志追加到文件中,默认为true,false为覆盖
log4j.appender.DRFILE.Append=true
# 标识每天产生一个新的日志文件,当然也可以指定按月、周、时、分
log4j.appender.DRFILE.DatePattern='.'yyyy-MM-dd
# '.'yyyy-MM:  每月 
# '.'yyyy-ww:  每周  
# '.'yyyy-MM-dd:    每天 
# '.'yyyy-MM-dd-a:  每天两次 
# '.'yyyy-MM-dd-HH:  每小时 
# '.'yyyy-MM-dd-HH-mm:  每分钟 
RollingFileAppender

文件大小到达指定尺寸的时候产生一个新的文件

log4j.appender.RFILE=org.apache.log4j.RollingFileAppender
# 指定日志输出的最低级别,默认为DEBUG
log4j.appender.RFILE.Threshold=DEBUG
# 日志输出的路径
log4j.appender.RFILE.File=e:/mylog.log
# 设置日志输出的编码
log4j.appender.RFILE.encoding=UTF-8
# 将新增日志追加到文件中,默认为true,false为覆盖
log4j.appender.RFILE.Append=false
# 表示所有信息都会被立即输出,设为false则不输出,默认值是true。
log4j.appender.RFILE.ImmediateFlush=true
# 指定日志文件切割大小,默认10MB,单位KB/MB/GB
# 当日志文件达到指定大小后,将当前日志文件内容剪切到新的日志文件中
# 新的文件默认以“原文件名.1”、“原文件名.2”的形式命名
log4j.appender.RFILE.MaxFileSize=100KB
# 产生的切割文件最大数量,如果第二个文件超过了指定大小,那么第一个文件将会被删除
log4j.appender.RFILE.MaxBackupIndex=2
Layout

配置日志信息的格式Layout,其语法为:log4j.appender.appenderName.layout = className

其中,appenderName就是上面所讲的Appender的名称,Appender必须与Layout相互绑定

HTMLLayout

以html表格页面的形式输出日志

log4j.appender.FILE.layout=org.apache.log4j.HTMLLayout
# 输出java文件名称和行号,默认值false
log4j.appender.FILE.layout.LocationInfo=true
# html页面的标题
log4j.appender.FILE.layout.Title=My Log
SimpleLayout

简单模式输出日志,只包含日志等级、信息

log4j.appender.FILE.layout=org.apache.log4j.SimpleLayout
TTCCLayout

包含日志产生的时间、线程、类别等等信息

log4j.appender.FILE.layout=org.apache.log4j.TTCCLayout
PatternLayout

自定义日志输出格式

log4j.appender.FILE.layout = org.apache.log4j.PatternLayout
# 指定怎样格式化的日志
log4j.appender.FILE.layout.ConversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss:SSS} (%c\:%L)-(%t) : %m%n
# 具体的格式化说明:
# %p:输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。
# %d:输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。
# %r:输出自应用程序启动到输出该log信息耗费的毫秒数。
# %t:输出产生该日志事件的线程名。
# %l:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。
# %c:输出日志信息所属的类目,通常就是所在类的全名。
# %M:输出产生日志信息的方法名。
# %F:输出日志消息产生时所在的文件名称。
# %L::输出代码中的行号。
# %m::输出代码中指定的具体日志信息。
# %n:输出一个回车换行符,Windows平台为"\r\n",Unix平台为"\n"。
# %x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
# %%:输出一个"%"字符。

简单使用

public class Start {
    
    public static final  Logger log = Logger.getLogger(Start.class);

    public static void main(String[] args) {
        log.debug("Debug Message!");
        log.info("Info Message!");
        log.warn("Warn Message!");
        log.error("Error Message!");
        log.fatal("Fatal Message!");
    }
}

日志门面

Slf4j

slf4j-api是Simple Logging Facade for Java (SLF4J)框架的核心组件,它定义了SLF4J框架的API和日志交互接口,是所有SLF4J实现的基础。

SLF4J旨在为不同的日志框架提供统一的抽象层,使得应用程序可以在运行时选择最适合的日志框架,而不必修改应用程序代码。SLF4J的API包括日志级别、日志信息的格式化、动态跟踪的绑定机制等,可以让开发者按自己的需求选择不同的日志框架来实现日志功能。并且,在JAVA EE中,SLF4J API是规范化的,可以方便地在web应用程序中使用。

官方网站: https://www.slf4j.org/

日志级别

简单使用

使用时和JUL、Log4j类似,仍然是先获取Logger实例,这里有两种获取方法:一种是通过LoggerFactory获取,另一种是通过Lombok插件的@Slf4j注解获取,其原理是在编译期给类添加private static final Logger log = LoggerFactory.getLogger(Xxx.class)

@Slf4j
public class Main {
		// public static final Logger log = LoggerFactory.getLogger(Main.class);
    public static void main(String[] args) throws IOException {
        // slf4j支持使用{}作为占位符,然后后面参数可以填充
        log.trace("{} log...","trace");
        log.debug("{} log...","debug");
        log.info("{} log...","info");
        log.warn("{} log...","warn");
        log.error("{} log...","error");
    }
}

具体实现

slf4j 仅仅是一个日志门面,需要接上具体的日志实现才能完成日志的打印,倘若仅提供slf4j-api,并没有给出具体的日志实现,程序运行时会出现警告,并且没有日志输出。

image-20231111175520394

slf4j-nop

为了避免slf4j-api的警告,可以手动指定不输出任何日志。方式是,在maven配置中指定使用slf4j-nop日志后端实现。

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>2.0.5</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-nop</artifactId>
    <version>2.0.5</version>
</dependency>
slf4j-simple

slf4j自己也提供了功能较为简单的实现(slf4j-simple),但是一般很少用到。

<!-- slf4j-api -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.30</version>
</dependency>
<!-- slf4j自带的简单日志实现 -->
<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-simple</artifactId>
	<version>1.7.30</version>
</dependency>

配置文件,classpath下创建simplelogger.properties

org.slf4j.simpleLogger.defaultLogLevel=DEBUG
org.slf4j.simpleLogger.showDateTime=true
org.slf4j.simpleLogger.dateTimeFormat=yyyy-MM-dd HH:mm:ss:SSS Z
org.slf4j.simpleLogger.showThreadName=true
org.slf4j.simpleLogger.showLogName=true
org.slf4j.simpleLogger.showShortLogName=false
JUL

JUL的日志等级与slf4j的日志等级存在较大的差异,在配置logging.properties时要注意。

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

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jdk14</artifactId>
    <version>2.0.5</version>
</dependency>
log4j

早期版本

<!-- slf4j-api -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.31</version>
</dependency>
<!-- log4j的slf4j实现 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.31</version>
</dependency>

新版本

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

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-reload4j</artifactId>
    <version>2.0.5</version>
</dependency>
log4j2

早期版本

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

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.19.0</version>
</dependency>

新版本

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

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j2-impl</artifactId>
    <version>2.19.0</version>
</dependency>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.19.0</version>
</dependency>
logback

logback是slf4j推荐的日志实现,毕竟出自同一家公司。

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

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

桥接