Java 日志(Logging)如何创建和捕获日志消息和文件

待我称王封你为后i 2024-03-23 17:21 84阅读 0赞

![683e7cf7454940b9b05b71da291ded63.jpeg][]

Java允许我们通过日志记录过程来创建和捕获日志消息和文件。

在Java中，日志记录需要框架和API。Java在java.util.logging程序包中具有内置的日志记录框架。

### Java 日志组件 ###

下图显示了Java Logging API（java.util.logging）的核心组件和指定流程。Java日志流程图：

![Java Logging API的指定流][Java Logging API]![1afdbdce19124ae2a309e745212fa43a.png][]

### Logger ###

Logger类提供了日志记录的方法。我们可以从Logger类中实例化对象并调用其方法以进行记录。

让我们举个实例。

Logger logger = Logger.getLogger("newLoggerName");

Logger类的getLogger()方法用于查找或创建新的Logger。 字符串参数定义logger的名称。

在这里，这将创建一个新Logger对象或返回一个具有相同名称的Logger对象。

按照惯例，使用class.getName()在当前类之后定义一个Logger。

Logger logger = Logger.getLogger(MyClass.class.getName());

**注意：**如果传递的名称为null，该方法将抛出NullPointerException。

每个Logger都有确定日志消息重要性的级别。有7个基本日志级别：

![9db855211a4c44a089998f40b6103d42.png][]

每个日志级别都有一个整数值，用来确定它们的严重性，除了两个特殊的日志级别OFF和ALL之外。

#### 日志消息 ####

默认情况下，始终会记录前三个日志级别。要设置其他级别，我们可以使用以下代码：

logger.setLevel(Level.LogLevel);
    示例：
    logger.setLevel(Level.FINE);

在本示例中，只有Level.FINE和它之上的级别被设置为日志记录。删除所有其他日志消息。

现在要记录一条日志消息，我们使用该log()方法。

logger.log(Level.LogLevel, "log message");
    // 示例
    logger.log(Level.INFO, "This is INFO log level message");

有一些用于记录所需级别的速记方法。

logger.info( "这是INFO日志级别的消息");
    logger.warning( "这是WARNING日志级别的消息");

然后，已通过设置的日志级别的所有日志请求都将转发到**LogRecord**。

**注意：**如果一个日志记录器的级别被设置为null，那么它的级别将从其父继承，以此类推。

#### 筛选器（Filter） ####

过滤器(如果存在)决定LogRecord是否转发该日志记录。顾名思义，它根据特定的标准过滤日志消息。

如果**LogRecord**通过指定的条件，则仅从记录器传递到日志处理程序，并从日志处理程序传递到外部系统。

// 设置filter
    logger.setFilter(filter);
    
    // 获取 filter
    Filter filter = logger.getFilter();

#### 处理程序（输出源） ####

日志处理程序或附加程序将接收**LogRecord**并将其导出到各种目标。

Java SE提供了5个内置处理程序：

![3a725b2b35d44b1e83b3d7e7e4bffcaf.png][]

处理程序可以将**LogRecord**传递到过滤器，以再次确定是否可以将其转发到外部系统。

要添加新的处理程序，我们使用以下代码：

logger.addHandler(handler);
    
    // 示例
    Handler handler = new ConsoleHandler();
    logger.addHandler(handler);

要删除处理程序，我们使用以下代码：

logger.removeHandler(handler);
    
    // 示例
    Handler handler = new ConsoleHandler();
    logger.addHandler(handler);
    logger.removeHandler(handler);

一个记录器可以有多个处理程序。要获取所有处理程序，我们使用以下代码：

Handler[] handlers = logger.getHandlers();

#### 4.格式化程序（Formatter） ####

处理程序还可以使用**Formatter**将**LogRecord**对象**格式化**为字符串，然后再将其导出到外部系统。

Java SE具有两个内置的**Formatter**：

![7f2fc5b2859041bbaad6330f39cc1753.png][]

我们可以使用以下代码来格式化处理程序：

// 格式化成字符串形式
    handler.setFormatter(new SimpleFormatter());
    
    // 格式化成XML格式
    handler.setFormatter(new XMLFormatter());

### 日志管理器 ###

**日志管理**对象跟踪的全球记录的信息。它读取并维护日志记录配置和记录器实例。

日志管理器是单例，这意味着仅实例化了一个实例。

要获取日志管理器实例，我们使用以下代码：

LogManager manager = new LogManager();

### 日志的优点 ###

这是使用Java 日志的一些优点。

>  *  帮助监控程序的流程
>  *  帮助捕获可能发生的任何错误
>  *  为问题诊断和调试提供支持

给大家分享一个好用的日历插件代码：

<configuration debug="false">
        
        <property name="LOG_HOME" value="/home"/>
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncode r">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logge r{50} - %msg%n</pattern>
            </encoder>
        </appender>
        
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAp pender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRolling Policy">
                
                <FileNamePattern>/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <MaxHistory>30</MaxHistory>
            </rollingPolicy>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncode r">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logge r{50} - %msg%n</pattern>
            </encoder>
            
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTrig geringPolicy">
                <MaxFileSize>100MB</MaxFileSize>
            </triggeringPolicy>
        </appender>
        
        <logger name="com.apache.ibatis" level="TRACE"/>
        <logger name="java.sql.Connection" level="DEBUG"/>
        <logger name="java.sql.Statement" level="DEBUG"/>
        <logger name="java.sql.PreparedStatement" level="DEBUG"/>
        
        <root level="DEBUG">
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="FILE"/>
        </root>
    </configuration>

[683e7cf7454940b9b05b71da291ded63.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/8bf226a658844eeda1f0355b2416487f.png
[Java Logging API]: https://www.nhooo.com/run/images/java-logging.png
[1afdbdce19124ae2a309e745212fa43a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b14b80397da84038891ea390f13fc082.png
[9db855211a4c44a089998f40b6103d42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5cc3ab52690e447aa05f1a9aecf5f2eb.png
[3a725b2b35d44b1e83b3d7e7e4bffcaf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/4a74b61be93d434d9279c013ab094a2a.png
[7f2fc5b2859041bbaad6330f39cc1753.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/af5df8e3fddc4a2783816a36d6a19dd0.png