log Java日志规范

原创

mob649e815f494b 2024-04-04 03:56:30 ©著作权

©著作权归作者所有：来自51CTO博客作者mob649e815f494b的原创作品，请联系作者获取转载授权，否则将追究法律责任

如何实现“log Java日志规范”

一、流程图

gantt
    title Java日志规范实现流程
    dateFormat  YYYY-MM-DD
    section 审查需求
    定义需求               :done, des1, 2022-10-03, 3d
    section 实现代码
    编写日志输出代码       :done, des2, after des1, 5d
    测试日志输出功能       :active, des3, after des2, 3d
    section 上线部署
    部署代码到生产环境    :des4, after des3, 2d

二、步骤及代码示例

步骤	操作	代码示例
1	导入日志依赖	```xml

| 2 | 配置日志框架 | 在`logback.xml`中配置日志输出格式、路径等信息。 |
| 3 | 使用日志输出 | 在代码中使用日志输出功能。 |
| 4 | 日志级别设置 | 根据需要设置不同级别的日志输出。 |

### 1. 导入日志依赖

```xml
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.30</version>
</dependency>

2. 配置日志框架

在resources目录下创建logback.xml文件，示例配置如下：

<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>

</configuration>

3. 使用日志输出

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogExample {

    private static final Logger logger = LoggerFactory.getLogger(LogExample.class);

    public static void main(String[] args) {
        logger.debug("Debug message");
        logger.info("Info message");
        logger.warn("Warning message");
        logger.error("Error message");
    }

}

4. 日志级别设置

在logback.xml中配置不同级别的日志输出，例如：

<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>

    <logger name="com.example" level="debug"/>

</configuration>

三、序列图

sequenceDiagram
    participant 小白
    participant 经验丰富的开发者

    小白->>经验丰富的开发者: 请求学习Java日志规范
    经验丰富的开发者->>小白: 导入日志依赖
    经验丰富的开发者->>小白: 配置日志框架
    经验丰富的开发者->>小白: 使用日志输出
    经验丰富的开发者->>小白: 日志级别设置