Java日志框架JUL和Log4j介绍

日志文件是用于记录系统操作事件的文件集合,可分为事件日志和消息日志。具有处理历史数据、诊断问题的追踪以及理解系统的活动等重要作用。

日志实现:
JUL、logback、log4j、log4j2等

JUL

全称java util logging,是java原生的日志框架,使用时不需要另外引用第三方类库,能够在小型应用中灵活使用

架构介绍

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

使用

public class JULTest {
    // 快速入门
    @Test
    public void testQuick() throws Exception{
        // 1.获取Logger
        Logger logger = Logger.getLogger("com.rhett.JULTest");
        // 2.日志记录输出
        logger.info("Hello JUL");

        // 通用方法进行日志记录
        logger.log(Level.INFO,"info msg");

        // 通过占位符方式输出变量值
        String name = "rhett";
        Integer age = 13;
        logger.log(Level.INFO,"用户信息:{0},{1}",new Object[]{name,age});
    }
}

JUL的日志级别:

  • OFF ->Integer.MAX_VALUE
  • SEVERE
  • WARNING
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST
  • ALL ->Integer.MIN_VALUE

每个级别都有一个value,当设定了过滤级别的值的时候,小于这个值的级别信息都不会输出

//日志级别
@Test
public void testLogLevel() throws Exception{
    // 1.获取logger
    Logger logger = Logger.getLogger(this.getClass().getName());
    // 2.日志记录输出
    logger.severe("severe");
    logger.warning("warning");
    logger.info("info"); // JUL默认的日志级别
    logger.config("config");
    logger.fine("fine");
    logger.finer("finer");
    logger.finest("finest");
}

//日志级别
@Test
public void testLogConfig() throws Exception{
    // 1.获取logger
    Logger logger = Logger.getLogger(this.getClass().getName());

    // 关闭系统默认配置
    logger.setUseParentHandlers(false);

    // 自定义配置日志级别
    // 创建ConsoleHandler 控制台输出
    ConsoleHandler consoleHandler = new ConsoleHandler();

    // 创建simpleFormatter
    SimpleFormatter simpleFormatter = new SimpleFormatter();

    // 进行关联
    consoleHandler.setFormatter(simpleFormatter);
    logger.addHandler(consoleHandler);

    // 配置日志具体级别
    logger.setLevel(Level.ALL);
    consoleHandler.setLevel(Level.ALL);

    // 创建FileHandler
    FileHandler fileHandler = new FileHandler("test.log");

    // 进行关联
    fileHandler.setFormatter(simpleFormatter);
    logger.addHandler(fileHandler);

    // 2.日志记录输出
    logger.severe("severe");
    logger.warning("warning");
    logger.info("info"); // JUL默认的日志级别
    logger.config("config");
    logger.fine("fine");
    logger.finer("finer");
    logger.finest("finest");
}

logger的父子关系

@Test
public void testLogParent() throws Exception{
    Logger logger1 = Logger.getLogger("com.rhett");
    Logger logger2 = Logger.getLogger("com");

    // 测试,logger2是logger1的父对象
    System.out.println(logger1.getParent() == logger2);
    // 所有日志记录器的顶级父元素 LogManager$RootLogger,名称为空字符串
    System.out.println("logger2 Parent:"+logger2.getParent()+",name:"+logger2.getParent().getName());

    // 关闭默认配置
    logger2.setUseParentHandlers(false);

    // 设置logger2日志级别
    // 自定义配置日志级别
    // 创建ConsoleHandler 控制台输出
    ConsoleHandler consoleHandler = new ConsoleHandler();

    // 创建simpleFormatter
    SimpleFormatter simpleFormatter = new SimpleFormatter();

    // 进行关联
    consoleHandler.setFormatter(simpleFormatter);
    logger2.addHandler(consoleHandler);

    // 配置日志具体级别
    logger2.setLevel(Level.ALL);
    consoleHandler.setLevel(Level.ALL);


    logger1.severe("severe");
    logger1.warning("warning");
    logger1.info("info"); // JUL默认的日志级别
    logger1.config("config");
    logger1.fine("fine");
    logger1.finer("finer");
    logger1.finest("finest");
}

自定义配置文件

默认配置文件:(logging.properties

# root logger 的默认处理器
handlers= java.util.logging.ConsoleHandler

# 代表的是root logger的日志级别
.level= INFO

# 默认位置:系统用户目录下
java.util.logging.FileHandler.pattern = %h/java%u.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter

# 向控制台输出的handler对象
# 指定handler对象的日志级别
java.util.logging.ConsoleHandler.level = INFO
# 指定handler对象的日志消息格式对象
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

自定义配置文件:

# root logger 的默认处理器
handlers= java.util.logging.ConsoleHandler

# 代表的是root logger的日志级别
.level= ALL

# 自定义Logger使用
com.rhett.handlers = java.util.logging.ConsoleHandler
com.rhett.level = CONFIG

# 向文件输出的handler对象
# 指定文件路径,默认位置:系统用户目录下
java.util.logging.FileHandler.pattern = %h/java%u.log
# 指定日志文件内容大小最多为50000条
java.util.logging.FileHandler.limit = 50000
# 指定日志文件的数量
java.util.logging.FileHandler.count = 1
# 指定handler对象的Formatter
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
# 指定以追加的方式添加日志内容
java.util.logging.FileHandler.append = true

# 向控制台输出的handler对象
# 指定handler对象的日志级别
java.util.logging.ConsoleHandler.level = ALL
# 指定handler对象的Formatter
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
# 指定handler对象的字符集
java.util.logging.ConsoleHandler.encoding = UTF-8

# 指定formatter的format格式
java.util.logging.SimpleFormatter = %4s: %5s [%1$tc]%n

日志原理解析

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

Java日志框架JUL和Log4j介绍

Log4j

使用

@Test
public void test01()throws Exception{
    //初始化配置信息
    BasicConfigurator.configure();

    //获取logger
    Logger logger = Logger.getLogger(this.getClass());
    //日志记录
    logger.info("hello log4j");

    //日志级别
    logger.fatal("fatal"); // 严重错误,一般会造成系统崩溃并终止运行

    logger.error("error"); // 错误信息,一般不会影响系统运行
    logger.warn("warn"); // 警告信息,可能会发生问题
    logger.info("info"); // 运行信息,数据连接、网络连接、IO操作等等
    logger.debug("debug"); // 调试信息,一般在开发中使用,记录程序变量参数传递信息等等

    logger.trace("trace"); // 追踪信息,记录程序所有的流程信息
}

log4j组件

Log4j是Apache的一个开源项目。

Log4J主要由Loggers (日志记录器)、Appenders (输出端)和Layouts(日志格式化器)组成。其中Loggers控制日志的输出级别与日志是否输出; Appenders 指定日志的输出方式(输出到控制台、文件等) ; Layouts控制日志信息的输出格式。

Loggers

日志记录器,负责收集处理日志记录,实例的命名就是类"XX"的full quailied name (类的全限定名),Logger的名字大小写敏感,其命名有继承机制:例如:name为org.apache.commons的logger会继承name为org.apache的logger。

Log4J中有一个特殊的logger叫做"root",他是所有logger的根, 也就意味着其他所有的logger都会直接或者间接地继承自root。root logger可以用Logger.getRootLogger(方法获取。

log4j 1.2之前,Logger 类叫Category类。

Appenders

类似于JUL中的handler。

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

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

Layouts

类似于JUL中的Formatter。

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

格式化器类型 作用
HTMLLayout 格式化日志输出为HTML表格形式
SimpleLayout 简单的日志输出格式化,打印的日志格式为(info - message)
PatternLayout 最强大的格式化器,可以根据自定义格式输出日志,如果没有指定转换格式,就是用默认的转换格式

配置文件

log4j.properties:

# 指定Root Logger 默认配置信息
# 指定日志级别,使用的appender
log4j.rootLogger = trace,console

# 指定日志输出的appender对象
log4j.appender.console = org.apache.log4j.ConsoleAppender
# 指定appender使用的layout
log4j.appender.console.layout = org.apache.log4j.SimpleLayout

使用PatternLayout:

# 指定Root Logger 默认配置信息
# 指定日志级别,使用的appender
log4j.rootLogger = trace,console

# 指定日志输出的appender对象
log4j.appender.console = org.apache.log4j.ConsoleAppender
# 指定appender使用的layout
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.conversionPattern = %r [%t] %p %c %x - %m%n

conversionPattern的占位符含义如下:

符号 含义
%m 输出代码中指定的日志信息
%p 输出优先级,即DEBUG、 INFO等
%n 换行符(Windows平台的换行符为 "\r\n", Unix平台为"\n")
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出打印语句所属的类的全名
%t 输出产生该日志的线程全名
%d 输出服务器当前时间,格式默认为ISO8601, 也可以指定格式,如: %d{yyyy年M月dd日HH:mm:ss}
%l 输出日志时间发生的位置,包括类名、线程、在代码中的行数。如: Test.main(Test. java:10)
%F 输出日志消息产生时所在的文件名称
%L 输出代码中的行号
%% 输出一个“%"字符

使用FileAppender:

# 指定Root Logger 默认配置信息
# 指定日志级别,使用的appender
log4j.rootLogger = trace,console,file

# 指定日志输出的appender对象
log4j.appender.console = org.apache.log4j.ConsoleAppender
# 指定appender使用的layout
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.conversionPattern = %r [%t] %p %c %x - %m%n

log4j.appender.file = org.apache.log4j.FileAppender
log4j.appender.file.layout = org.apache.log4j.PatternLayout
log4j.appender.file.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
# 指定日志文件保存路径
log4j.appender.file.file = logs/log4j.log
# 指定日志文件的字符集
log4j.appender.file.encoding = UTF-8

使用RollingFileAppender和DailyRollingFileAppender:

# 指定Root Logger 默认配置信息
# 指定日志级别,使用的appender
log4j.rootLogger = trace,console,file,rollingFile,dailyFile

# 指定日志输出的appender对象
log4j.appender.console = org.apache.log4j.ConsoleAppender
# 指定appender使用的layout
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.conversionPattern = %r [%t] %p %c %x - %m%n

log4j.appender.file = org.apache.log4j.FileAppender
log4j.appender.file.layout = org.apache.log4j.PatternLayout
log4j.appender.file.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
# 指定日志文件保存路径
log4j.appender.file.file = logs/log4j.log
# 指定日志文件的字符集
log4j.appender.file.encoding = UTF-8

log4j.appender.rollingFile = org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.layout = org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
# 指定日志文件保存路径
log4j.appender.rollingFile.file = logs/log4j.log
# 指定日志文件的字符集
log4j.appender.rollingFile.encoding = UTF-8
# 指定日志文件内容的大小
log4j.appender.rollingFile.maxFileSize = 1MB
# 指定日志文件的数量,超过该数量则从最久远的日志文件开始覆盖
log4j.appender.rollingFile.maxBackupIndex = 10

log4j.appender.dailyFile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.layout = org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.conversionPattern = [%-10p]%r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
# 指定日志文件保存路径
log4j.appender.dailyFile.file = logs/log4j.log
# 指定日志文件的字符集
log4j.appender.dailyFile.encoding = UTF-8
# 指定日期拆分规则
log4j.appender.dailyFile.datePattern = '.'yyyy-MM-dd

使用JDBCAppender:

#mysql
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
log4j.appender.logDB.Driver=com.mysql.jdbc.Driver
log4j.appender.logDB.URL= jdbc :mysql ://localhost :3306/test
log4j.appender.logDB.User=root
log4j.appender.logDB.Password=root
log4j.appender.logDB.Sql=INSERT INTO \
log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) \
values('rhett','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')

自定义logger设置:

# 自定义logger对象设置
log4j.logger.com.rhett = info,file

原创文章,作者:彭晨涛,如若转载,请注明出处:https://www.codetool.top/article/java%e6%97%a5%e5%bf%97%e6%a1%86%e6%9e%b6jul%e5%92%8clog4j%e4%bb%8b%e7%bb%8d/

发表评论

电子邮件地址不会被公开。