spring boot集成ureport spring boot集成logback-access

转载

mob64ca1414c613 2023-12-20 09:28:20

文章标签 sed 日志输出 xml 文章分类 spring boot 后端开发

Logback的介绍

Logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块：logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。

Logback的优点

执行速度快，初始化内存加载小;
原生实现了 SLF4J API，不需要进行转换;
配置简单，并可以适应多种环境;
可以定时的删除过期日志;
更为强大的过滤器，不必因更改日志级别而产生大量的日志;
可以从 IO 错误中进行恢复;
。。。。

Logback的使用

1、jar包引入

<!--如果是web项目直接引入这个包就行-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!--如果不是web项目直接引入这3个包就行-->

<dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-api</artifactId>
</dependency>
    
    
<dependency>
　　 <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    
</dependency>
    
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
</dependency>

2、（我这使用的是 xml 也可直接在 application.yml 中配置原理相同）xml配置文件（注意xml文件名约束：【官方推荐】logback-spring.xml 也可以 logback.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--    scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
　　　　scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
　　　　debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。-->
<configuration scan="true" scanPeriod="60 seconds" debug="false"> <!--共5个节点-->
    <!--子节点<timestamp>：获取时间戳字符串，他有两个属性key和datePattern
　　　　key: 标识此<timestamp> 的名字；
　　　　datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
    -->
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
    <!--设置上下文名称  节点一
    每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。
    一旦设置，不能修改,可以通过%contextName来打印日志上下文名称。
    -->
    <contextName>logback</contextName>
    <!--设置变量<property>  节点二
    用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。
    通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。
    -->
    <property name="LOG_HOME" value="F:\\test\\logs" ></property>
    <!--设置输出格式-->
    <property name="ENCODER_PATTERN"
              value="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %highlight([%-5level] %logger{50} - %msg%n)"/>

    <!--设置<appender>  节点三
    appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。
    #####控制台输出ConsoleAppender：
    -->
    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%Thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息 %n是换行符-->
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %highlight([%-5level] %logger{50} - %msg%n)</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!--输出到文件-->
    <appender name="SYSTEM_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_HOME}/pi.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--这是每天创建一个log文件  重点{yyyy-MM-dd} 加时分秒不能使用“：”号，否则不会切割日志-->
            <FileNamePattern>${LOG_HOME}/pi.%d{yyyy-MM-dd HH_mm}.%i.log</FileNamePattern>
            <!--最多保存30天-->
            <maxHistory>30</maxHistory>
            <!--设置日志文件总大小-->
            <totalSizeCap>50MB</totalSizeCap>
            <!--设置切割日志文件-->
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!--切割文件大小的大小-->
                <MaxFileSize>10MB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>${ENCODER_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

　　<!-- 设定具体时间生成一个日志文件 -->

<appender name="SYSTEM" class="ch.qos.logback.core.rolling.RollingFileAppender">

<file>${LOG_HOME}/system.log</file>

<rollingPolicy
            class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <!-- daily rollover ，每10分钟生成一份日志文件-->
        <fileNamePattern>${LOG_HOME}/system.%d{yyyy-MM-dd-HH-mm}.log

</fileNamePattern>
        <timeBasedFileNamingAndTriggeringPolicy

                class="com.common.log.MyTimeBasedFileNamingAndTriggeringPolicy">

            <multiple>10</multiple>

        </timeBasedFileNamingAndTriggeringPolicy>

        <maxHistory>7</maxHistory>
    </rollingPolicy>

    <encoder>
        <pattern>%d{HH:mm:ss} %-5level [%thread][%file:%line] : %msg%n
        </pattern>
    </encoder>
</appender>

<!--设置<root> 节点四
    root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。
    level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。
    默认是DEBUG。  可以包含零个或多个元素，标识这个appender将会添加到这个loger
    -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="SYSTEM_FILE"/>
    </root>

    <!--设置<logger> 节点五
        <logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性，一个可选的level和一个可选的additivity属性。
        name 用来指定受此loger约束的某一个包或者具体的某一个类。
        level 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，
        代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。
        additivity 是否向上级logger传递打印信息。默认是true。false：表示只用当前logger的appender-ref。
        true：表示当前logger的appender-ref和rootLogger的appender-ref都有效。

    -->
    <logger name="com.wwc.demo.*" level="INFO" additivity="true"></logger>


    </configuration>

3、类中使用创建 logger 对象

//导包要导

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

private Logger logger = LoggerFactory.getLogger(this.getClass());

public static void main(String[] args) {
    logger.trace("日志输出 trace");
    logger.debug("日志输出 debug");
    logger.info("日志输出 info");
    logger.warn("日志输出 warn");
    logger.error("日志输出 error");
}

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。