Java 日志框架学习笔记(java 日志系统)

日志概念 1. 日志文件 日志文件是用于记录系统操作事件的文件集合 1.1 调试日志 1.2 系统日志 系统日志是记录系统中硬件、软件和系统问题的信息，同时还可以监视系统中发生的事件。用户可以通过它来检查错误发生的原因，或者寻找受到攻击时攻击者留下的痕迹 日志门面 当我们的系统变的更加复杂的时候，我 ... 日志概念1. 日志文件

推荐整理分享Java 日志框架学习笔记(java 日志系统)，希望有所帮助，仅作参考，欢迎阅读内容。

文章相关热门搜索词:java 日志规范,java 日志系统,java的日志框架,java 日志收集框架,java常用日志框架,java主流日志框架,java主流日志框架,java的日志框架,内容如对您有帮助，希望把文章链接给更多的朋友！

日志文件是用于记录系统操作事件的文件集合

1.1 调试日志1.2 系统日志

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

日志门面

当我们的系统变的更加复杂的时候，我们的日志就容易发生混乱。随着系统开发的进行，可能会更新不同的日志框架，造成当前系统中存在不同的日志依赖，让我们难以统一的管理和控制。所以我们需要借鉴 JDBC 的思想，为日志系统也提供一套门面，那么我们就可以面向这些接口规范来开发，避免了直接依赖具体的日志框架。这样我们的系统在日志中，就存在了日志的门面和日志的实现

常见的日志门面：JCL、Slf4j

常见的日志实现：JUL、log4j、logback、log4j2

日志门面和日志实现的关系：

使用日志门面的优势：

面向接口开发，不再依赖具体的实现类，减少代码的耦合项目通过导入不同的日志实现类，可以灵活的切换日志框架统一 API，方便开发者学习和使用统一配置便于项目日志的管理JUL

JUL（Java util Logging）是 Java 原生的日志实现框架，使用时不需要另外引用第三方类库，相对其他日志框架使用方便，学习简单，能够在小型应用中灵活使用

1. 架构

Loggers：记录器，应用程序通过获取 Logger 对象，调用其 API 来发布日志信息Appenders：也称为 Handlers，每个 Logger 都会关联一组 Handlers，Logger 会将日志交给关联 Handlers 处理，由 Handlers 负责将日志做记录。Handlers 在此是一个抽象，其具体的实现决定了 日志记录的位置可以是控制台、文件、网络上的其他日志服务或操作系统日志等Layouts：也称为 Formatters，它负责对日志事件中的数据进行转换和格式化。Layouts 决定了数据在一条日志记录中的最终形式Level：每条日志消息都有一个关联的日志级别，该级别粗略指导了日志消息的重要性和紧迫，可以将Level 和 Loggers、Appenders 做关联以便于我们过滤消息Filters：过滤器，根据需要定制哪些信息会被记录，哪些信息会被放过

总结一下就是：

用户使用 Logger 来进行日志记录，Logger 持有若干个 Handler，日志的输出操作是由 Handler 完成的Handler 在输出日志前，会经过 Filter 的过滤，判断哪些日志级别过滤放行哪些拦截，Handler 会将日志内容输出到指定位置（日志文件、控制台等）Handler 在输出日志时会使用 Layout，将输出内容进行排版2. 入门案例public class JULTest { @Test public void testQuick() throws Exception { // 1.创建日志记录器对象 Logger logger = Logger.getLogger("com.itheima.log.JULTest"); // 2.日志记录输出 logger.info("hello jul"); logger.log(Level.INFO, "info msg"); String name = "jack"; Integer age = 18; logger.log(Level.INFO, "用户信息：{0},{1}", new Object[]{name, age}); }}3. 日志级别

JUL 中定义的日志级别：SEVERE（最高值）、WARNING、INFO（默认级别）、CONFIG、FINE、FINER、FINEST（最低值）

还有两个特殊的级别：OFF，可用来关闭日志记录、ALL，启用所有消息的日志记录

@Testpublic void testLogLevel() throws Exception { // 1.获取日志对象 Logger logger = Logger.getLogger("com.itheima.log.QuickTest"); // 2.日志记录输出 logger.severe("severe"); logger.warning("warning"); logger.info("info"); logger.config("cofnig"); logger.fine("fine"); logger.finer("finer"); logger.finest("finest");}

虽然我们测试了 7 个日志级别，但是默认只实现 info 以上的级别，info 以下不会输出，我们可以自定义日志级别配置

@Testpublic void testLogConfig() throws Exception { // 创建日志记录器对象 Logger logger = Logger.getLogger("com.itheima.log.JULTest"); // 一、自定义日志级别 // a.关闭系统默认配置 logger.setUseParentHandlers(false); // b.创建handler对象 ConsoleHandler consoleHandler = new ConsoleHandler(); // c.创建formatter对象 SimpleFormatter simpleFormatter = new SimpleFormatter(); // d.进行关联 consoleHandler.setFormatter(simpleFormatter); logger.addHandler(consoleHandler); // e.设置日志级别 logger.setLevel(Level.ALL); consoleHandler.setLevel(Level.ALL); // 二、输出到日志文件 FileHandler fileHandler = new FileHandler("d:/logs/jul.log"); fileHandler.setFormatter(simpleFormatter); // 日志记录输出 logger.severe("severe"); logger.warning("warning"); logger.info("info"); logger.config("config"); logger.fine("fine"); logger.finer("finer"); logger.finest("finest");}4. logger 之间的父子关系

JUL 中 Logger 之间存在父子关系，这种父子关系通过树状结构存储，JUL 在初始化时会创建一个顶层 RootLogger 作为所有 Logger 父 Logger，存储上作为树状结构的根节点，父子关系通过包路径来关联

@Testpublic void testLogParent() throws Exception { // 日志记录器对象父子关系 Logger logger1 = Logger.getLogger("com.itheima"); Logger logger2 = Logger.getLogger("com"); // true System.out.println(logger1.getParent() == logger2); // 所有日志记录器对象的顶级父元素 class 为 java.util.logging.LogManager$RootLogger // logger2 parent:java.util.logging.LogManager$RootLogger,name: System.out.println("logger2 parent:" + logger2.getParent() + ",name" + logger2.getParent().getName()); // 一、自定义日志级别 // a.关闭系统默认配置 logger2.setUseParentHandlers(false); // b.创建handler对象 ConsoleHandler consoleHandler = new ConsoleHandler(); // c.创建formatter对象 SimpleFormatter simpleFormatter = new SimpleFormatter(); // d.进行关联 consoleHandler.setFormatter(simpleFormatter); logger2.addHandler(consoleHandler); // e.设置日志级别 logger2.setLevel(Level.ALL); consoleHandler.setLevel(Level.ALL); // 测试日志记录器对象父子关系,这里会全部输出,因为logger1继承logger2的级别配置 logger1.severe("severe"); logger1.warning("warning"); logger1.info("info"); logger1.config("config"); logger1.fine("fine"); logger1.finer("finer"); logger1.finest("finest");}5. 日志的配置文件

默认配置文件路径 $JAVAHOME\jre\lib\logging.properties

@Testpublic void testProperties() throws Exception { // 读取自定义配置文件 InputStream in = JULTest.class.getClassLoader().getResourceAsStream("logging.properties"); // 获取日志管理器对象 LogManager logManager = LogManager.getLogManager(); // 通过日志管理器加载配置文件 logManager.readConfiguration(in); Logger logger = Logger.getLogger("com.itheima.log.JULTest"); logger.severe("severe"); logger.warning("warning"); logger.info("info"); logger.config("config"); logger.fine("fine"); logger.finer("finer"); logger.finest("finest");}

配置文件：

## RootLogger使用的处理器（获取时设置）handlers= java.util.logging.ConsoleHandler# RootLogger日志等级.level= INFO# 自定义Loggercom.itheima.handlers= java.util.logging.FileHandler# 自定义Logger日志等级com.itheima.level= INFO# 忽略父日志设置com.itheima.useParentHandlers=false## 控制台处理器# 输出日志级别java.util.logging.ConsoleHandler.level = ALL# 输出日志格式java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter# 指定handler对象的字符集java.util.logging.ConsoleHandler.encoding = UTF-8# 指定日志消息格式java.util.logging.SimpleFormatter.format = %4$s: %5$s [%1$tc]%n## 文件处理器# 输出日志级别java.util.logging.FileHandler.level=INFO# 输出日志格式java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter# 输出日志文件路径# /logs/java0.logjava.util.logging.FileHandler.pattern = /logs/java%u.log# 输出日志文件限制大小（50000字节）java.util.logging.FileHandler.limit = 50000# 输出日志文件限制个数java.util.logging.FileHandler.count = 10# 输出日志文件是否是追加java.util.logging.FileHandler.append=true6. 日志原理解析

初始化 LogManagerLogManager 加载 logging.properties 配置添加 Logger 到 LogManager从单例 LogManager 获取 Logger设置级别 Level，并指定日志记录 LogRecordFilter 提供了日志级别之外更细粒度的控制Handler 是用来处理日志输出位置Formatter 是用来格式化 LogRecord 的

Log4J

Log4j 是Apache 下的一款开源的日志实现框架，通过在项目中使用 Log4J，我们可以控制日志信息输出到控制台、文件、甚至是数据库中。我们可以控制每一条日志的输出格式，通过定义日志的输出级别，可以更灵活的控制日志的输出过程，方便项目调试

1. 入门案例<dependencies> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency></dependencies>public class Log4jTest { @Test public void testQuick() throws Exception { // 初始化系统配置，不需要配置文件 BasicConfigurator.configure(); // 创建日志记录器对象 Logger logger = Logger.getLogger(Log4jTest.class); // 日志记录输出 logger.info("hello log4j"); // 日志级别 logger.fatal("fatal"); // 严重错误，一般会造成系统崩溃和终止运行 logger.error("error"); // 错误信息，但不会影响系统运行 logger.warn("warn"); // 警告信息，可能会发生问题 logger.info("info"); // 程序运行信息，数据库的连接、网络、IO操作等 logger.debug("debug"); // 调试信息，一般在开发阶段使用，记录程序的变量、参数等 logger.trace("trace"); // 追踪信息，记录程序的所有流程信息 }}2. 日志级别

每个 Logger 都被定义了一个日志级别，用来控制日志信息的输出，日志级别从高到低分为：

fatal：指出每个严重的错误事件将会导致应用程序的退出error：指出虽然发生错误事件，但仍然不影响系统的继续运行warn：表明会出现潜在的错误情形info：一般和在粗粒度级别上，强调应用程序的运行全程debug：一般用于细粒度级别上，对调试应用程序非常有帮助trace 是程序追踪，可以用于输出程序运行中的变量，显示执行的流程

还有两个特殊的级别：OFF 可用来关闭日志记录、ALL 启用所有消息的日志记录

3. Log4j 组件3.1 Loggers

日志记录器，负责收集处理日志记录，实例的命名就是类的全限定名

Logger 的名字大小写敏感，其命名有继承机制，例如：name 为 org.apache.commons 的 logger 会继承 name 为 org.apache 的 logger

Log4J 中有一个特殊的 logger 叫做 root，他是所有 logger 的根，可以用 Logger.getRootLogger() 方法获取，其他所有的 logger 都会直接或间接地继承自 root

3.2 Appenders

Appender 用来指定日志输出到哪个地方，可以同时指定日志的输出目的地。Log4j 常用的输出目的地有以下几种：

ConsoleAppender：将日志输出到控制台FileAppender：将日志输出到文件中DailyRollingFileAppender：将日志输出到一个日志文件，并且每天输出到一个新的文件RollingFileAppender：将日志信息输出到一个日志文件，并且指定文件的尺寸，当文件大小达到指定尺寸时，会自动把文件改名，同时产生一个新的文件JDBCAppender：把日志信息保存到数据库中3.3 Layouts

布局器 Layouts 用于控制日志输出内容的格式，让我们可以使用各种需要的格式输出日志。Log4j 常用的 Layouts：

HTMLLayout：格式化日志输出为 HTML 表格形式SimpleLayout：简单的日志输出格式化，打印的日志格式为（info - message）PatternLayout：最强大的格式化期，可以根据自定义格式输出日志，如果没有指定转换格式，就使用默认的转换格式4. 配置文件详解#指定日志的输出级别与输出端log4j.rootLogger=INFO,Console# 自定义Logger# com.itheima包下的logger使用文件输出配置log4j.logger.com.itheima = info,file# apache包下的logger输出error级别日志log4j.logger.org.apache = error# 控制台输出配置log4j.appender.Console=org.apache.log4j.ConsoleAppenderlog4j.appender.Console.layout=org.apache.log4j.PatternLayout# log4j 采用类似 C 语言的 printf 函数的打印格式格式化日志信息，具体的占位符及其含义如下：# %m 输出代码中指定的日志信息# %p 输出优先级，及 DEBUG、INFO 等# %n 换行符（Windows平台的换行符为 "\n"，Unix 平台为 "\n"）# %r 输出自应用启动到输出该 log 信息耗费的毫秒数# %c 输出打印语句所属的类的全名# %t 输出产生该日志的线程全名# %d 输出服务器当前时间，默认为 ISO8601，也可以指定格式，如：%d{yyyy年MM月dd日# HH:mm:ss}# %l 输出日志时间发生的位置，包括类名、线程、及在代码中的行数。如：# Test.main(Test.java:10)# %F 输出日志消息产生时所在的文件名称# %L 输出代码中的行号# %% 输出一个 "%" 字符# 可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式。如：# %5c 输出category名称，最小宽度是5，category<5，默认的情况下右对齐# %-5c 输出category名称，最小宽度是5，category<5，"-"号指定左对齐,会有空格# %.5c 输出category名称，最大宽度是5，category>5，就会将左边多出的字符截掉，<5不会有空格# %20.30c category名称<20补空格，并且右对齐，>30字符，就从左边交远销出的字符截掉log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n# 文件输出配置log4j.appender.A = org.apache.log4j.DailyRollingFileAppender#指定日志的输出路径log4j.appender.A.File = D:/log.txtlog4j.appender.A.Append = true#使用自定义日志格式化器log4j.appender.A.layout = org.apache.log4j.PatternLayout#指定日志的输出格式log4j.appender.A.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] -[%p] %m%n#指定日志的文件编码log4j.appender.A.encoding=UTF-8#mysqllog4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppenderlog4j.appender.logDB.layout=org.apache.log4j.PatternLayoutlog4j.appender.logDB.Driver=com.mysql.jdbc.Driverlog4j.appender.logDB.URL=jdbc:mysql://localhost:3306/testlog4j.appender.logDB.User=rootlog4j.appender.logDB.Password=rootlog4j.appender.logDB.Sql=INSERT INTOlog(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) values('itcast','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')CREATE TABLE `log` ( `log_id` int(11) NOT NULL AUTO_INCREMENT, `project_name` varchar(255) DEFAULT NULL COMMENT '目项名', `create_date` varchar(255) DEFAULT NULL COMMENT '创建时间', `level` varchar(255) DEFAULT NULL COMMENT '优先级', `category` varchar(255) DEFAULT NULL COMMENT '所在类的全名', `file_name` varchar(255) DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称 ', `thread_name` varchar(255) DEFAULT NULL COMMENT '日志事件的线程名', `line` varchar(255) DEFAULT NULL COMMENT '号行', `all_category` varchar(255) DEFAULT NULL COMMENT '日志事件的发生位置', `message` varchar(4000) DEFAULT NULL COMMENT '输出代码中指定的消息', PRIMARY KEY (`log_id`));

JCL

全称为 Jakarta Commons Logging，是 Apache 提供的一个日志门面实现，为所有的 Java 日志实现提供一个统一的接口，它自身也提供一个日志的实现，但是功能较弱，它允许开发人员使用不同的具体日志实现工具，如：Log4J，JUL

JCL 有两个基本的抽象类：Log（基本记录器）和 LogFactory（负责创建 Log 实例）

1. 入门案例<dependency><groupId>commons-logging</groupId><artifactId>commons-logging</artifactId><version>1.2</version></dependency>public class JULTest { @Test public void testQuick() throws Exception { // 创建日志对象 Log log = LogFactory.getLog(JULTest.class); // 日志记录输出 log.fatal("fatal"); log.error("error"); log.warn("warn"); log.info("info"); log.debug("debug"); }}2. JCL 原理

JCL 通过 LogFactory 动态加载 Log 实现类

. 获取具体的日志实现的源码如下：

private static final String[] classesToDiscover =new String[]{"org.apache.commons.logging.impl.Log4JLogger","org.apache.commons.logging.impl.Jdk14Logger","org.apache.commons.logging.impl.Jdk13LumberjackLogger","org.apache.commons.logging.impl.SimpleLog"};for(int i = 0; i < classesToDiscover.length && result == null; ++i) {result = this.createLogFromClass(classesToDiscover[i], logCategory, true);}

classesToDiscover 数组是 JCL 支持的日志实现数组，对它进行遍历，尝试通过反射去实现

SLF4J

SLF4J（Simple Logging Facade For Java）主要是为了给 Java 日志访问提供一套标准、规范的 API 框架，其主要意义在于提供接口，具体的实现可以交由其他日志框架，例如 log4j 和 logback 等

SLF4J 也提供了功能较为简单的实现，但是一般很少用到。对于一般的 Java 项目而言，日志框架会选择 slf4j-api 作为门面，配上具体的实现框架（log4j、logback 等），中间使用桥接器完成桥接

SLF4J 的优势：

SLF4J 提供了对所有流行的日志框架的绑定，可以在部署时切换到所需的日志记录框架无论使用哪种绑定，SLF4J 都支持参数化日志记录消息SLF4J 提供了一个称为桥接器的工具，可以将现有项目的使用日志框架（JCL、JUL、Log4j）迁移到 SLF4J1. 入门案例<!--slf4j core 使用slf4j必須添加--><dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.27</version></dependency><!--slf4j 自带的简单日志实现 --><dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.7.27</version></dependency>public class Slf4jTest { //