logback最详细配置讲解,及命名规范

介绍

logback是一款日志框架。这个就不详细赘述了

命名规范

一般来说logback的配置文件可以命名为logback.xml,项目启动时就可以读取到里面的配置。但是在spring-boot项目中,这样会有一点问题。因为logback.xml会先于spring-boot的配置文件application.yml读取,导致在logback.xml中读取application.yml中配置的值时会读取不到,导致项目报错。

这里举个例子。在application.yml中配置了项目名称application.name=car
在logback.xml中获取项目名作为配置文件的命名时会出现错误,因为在logback.xml加载时还没有加载application.yml文件。(因为之前自己遇到过所以在这里赘述了一下)
因此在spring-boot项目中可以命名为logback-spring.xml,这样在读取玩application.yml文件后springboot会自动读取logback-spring.xml文件。

详细配置以及解释

这里知己附上一份比较完整的配置 解释我直接放在配置文件中,可以直接cv取用

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds" debug="false">

    <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
    <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
    <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
    <!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->


    <contextName>logback</contextName>

    <!--彩色日志渲染类-->
    <conversionRule conversionWord="clr"
                    converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>


    <!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
    <property name="log.path" value="./logs"/>
    <property name="log.name" value="eschool"/>
    <!-- 这里是我配置的输出控制台和输出文件中的格式 控制台可以彩色输出 文件中无法彩色输出 -->
    <property name="console_log_pattern"
              value="%red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger{36}:%L) - %gray(%msg%n)"/>
      <property name="file_log_pattern"
              value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36}:%L - %msg%n"/>

    <property name="charset" value="UTF-8"/>
    <!--输出到控制台-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
        <!-- 例如:如果此处配置了INFO级别,则后面其他位置即使配置了DEBUG级别的日志,也不会被输出 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <encoder>
        <!-- 这里的字符编码默认的是UTF-8 所以我没写出来 -->
            <pattern>${console_log_pattern}</pattern>
        </encoder>
    </appender>

    <!--输出到文件,只记录INFO级别信息-->
    <appender name="info_file" class="ch.qos.logback.core.rolling.RollingFileAppender">

            <!-- 同时有file 和 fileNamePattern标签时,当天的命名按照file中配置的值命名,明天会将其修改成今天的日期
            好处: 今天的日志就叫info.log 便于查找 明天之后的就会按照命名规则命名 -->
            <file>${log.path}/info/info.log</file>

        <encoder>
            <pattern>${file_log_pattern}</pattern>
            <!--       可以不写 默认UTF-8     <charset>${charset}</charset>-->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式  %i是索引 超过20MB 日志文件索引会以0开始-->
            <fileNamePattern>${log.path}/info/${log.name}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 如果超过50MB就删除 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>50MB</maxFileSize>
        </triggeringPolicy>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 追加方式记录日志 -->
        <append>true</append>
    </appender>

    <!--输出到文件,只记录WARN级别信息-->
    <appender name="warn_file" class="ch.qos.logback.core.rolling.RollingFileAppender">

            <!-- 同时有file 和 fileNamePattern标签时,当天的命名按照file中配置的值命名,明天会将其修改成今天的日期
            好处: 今天的日志就叫warn.log 便于查找 明天之后的就会按照命名规则命名 -->
            <file>${log.path}/warn/warn.log</file>

        <encoder>
            <pattern>${file_log_pattern}</pattern>
            <!--       可以不写 默认UTF-8     <charset>${charset}</charset>-->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式  %i是索引 超过20MB 日志文件索引会以0开始-->
            <fileNamePattern>${log.path}/warn/${log.name}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 如果超过50MB就删除 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>50MB</maxFileSize>
        </triggeringPolicy>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 追加方式记录日志 -->
        <append>true</append>
    </appender>
    <!--输出到文件,只记录ERROR级别信息-->
    <appender name="error_file" class="ch.qos.logback.core.rolling.RollingFileAppender">

            <!-- 同时有file 和 fileNamePattern标签时,当天的命名按照file中配置的值命名,明天会将其修改成今天的日期
            好处: 今天的日志就叫error.log 便于查找 明天之后的就会按照命名规则命名 -->
            <file>${log.path}/error/error.log</file>

        <encoder>
            <pattern>${file_log_pattern}</pattern>
            <!--       可以不写 默认UTF-8     <charset>${charset}</charset>-->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式  %i是索引 超过20MB 日志文件索引会以0开始-->
            <fileNamePattern>${log.path}/error/${log.name}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 如果超过50MB就删除 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>50MB</maxFileSize>
        </triggeringPolicy>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 追加方式记录日志 -->
        <append>true</append>
    </appender>

    <!--
    root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
    level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,默认是DEBUG
    可以包含零个或多个appender元素。
    -->
    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="info_file"/>
        <appender-ref ref="warn_file"/>
        <appender-ref ref="error_file"/>
    </root>

    <!--
        <logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。
        <logger>仅有一个name属性,
        一个可选的level和一个可选的additivity属性。
        name:用来指定受此logger约束的某一个包或者具体的某一个类。
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
              如果未设置此属性,那么当前logger将会继承上级的级别。
        additivity:是否向上级logger传递打印信息,默认是true
    -->
    <!-- 使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
         第一种把<root level="INFO">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
         第二种就是单独给mapper下目录配置DEBUG模式,代码如下,这样配置sql语句会打印,其他还是正常DEBUG级别:
    -->

    <!-- jdbc LOG -->
    <logger name="jdbc.sqlonly" level="DEBUG" />
    <logger name="jdbc.sqltiming" level="OFF" />
    <logger name="jdbc.resultsettable" level="OFF" />
    <logger name="jdbc.resultset" level="OFF" />
    <logger name="jdbc.connection" level="OFF" />
    <logger name="jdbc.audit" level="OFF" />
    <logger name="log4jdbc.debug" level="INFO" />

    <!--其他配置-->
    <logger name="javax.activation" level="WARN" />
    <logger name="javax.mail" level="WARN" />
    <logger name="javax.xml.bind" level="WARN" />
    <logger name="ch.qos.logback" level="WARN" />
    <logger name="com.codahale.metrics" level="WARN" />
    <logger name="com.ryantenney" level="WARN" />
    <logger name="com.sun.xml.internal.bind" level="WARN" />
    <logger name="com.zaxxer" level="WARN" />
    <logger name="io.undertow" level="WARN" />
    <logger name="net.sf.ehcache" level="WARN" />
    <logger name="org.apache" level="WARN" />
    <logger name="org.apache.catalina.startup.DigesterFactory"
            level="OFF" />
    <logger name="org.bson" level="WARN" />
    <logger name="org.hibernate.validator" level="WARN" />
    <logger name="org.hibernate" level="WARN" />
    <logger name="org.hibernate.ejb.HibernatePersistence"
            level="OFF" />
    <logger name="org.springframework" level="WARN" />
    <logger name="org.springframework.web" level="WARN" />
    <logger name="org.springframework.security" level="WARN" />
    <logger name="org.springframework.cache" level="WARN" />
    <logger name="org.eclipse.jetty" level="WARN" />
    <logger name="httpclient.wire" level="WARN"></logger>

    <!--    如果多环境开发可以用springProfile -->
    <!--开发环境:打印控制台-->
<!--    <springProfile name="dev">-->
<!--        &lt;!&ndash;可以输出项目中的debug日志,包括mybatis的sql日志&ndash;&gt;-->
<!--        <logger name="com.hyh.logback.web" level="DEBUG">-->
<!--            <appender-ref ref="console"/>-->
<!--        </logger>-->
<!--        &lt;!&ndash;-->
<!--            root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性-->
<!--            level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,默认是DEBUG-->
<!--            可以包含零个或多个appender元素。-->
<!--        &ndash;&gt;-->
<!--        <root level="INFO">-->
<!--            <appender-ref ref="console"/>-->
<!--        </root>-->
<!--    </springProfile>-->
</configuration>

至此所有配置结束,希望这篇文章可以帮助到你解决繁琐又让人头疼的的日志配置~

  • 4
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Logback 是一个灵活且功能强大的 Java 日志框架,可以通过配置文件或者 Java 代码来控制日志的输出。下面是一个详细Logback 配置教程。 ## 1. 配置 Maven 依赖 首先,在项目的 pom.xml 文件中添加 Logback 的 Maven 依赖: ```xml <!-- Logback 日志框架 --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.3</version> </dependency> ``` ## 2. 配置 logback.xml 文件 接下来,在 src/main/resources 目录下创建一个名为 `logback.xml` 的文件,并添加以下内容: ```xml <?xml version="1.0" encoding="UTF-8"?> <configuration> <!-- 定义日志输出的格式 --> <property name="LOG_PATTERN" value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/> <!-- 定义控制台输出的 appender --> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>${LOG_PATTERN}</pattern> </encoder> </appender> <!-- 定义文件输出的 appender --> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>logs/app.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern> </rollingPolicy> <encoder> <pattern>${LOG_PATTERN}</pattern> </encoder> </appender> <!-- 配置日志级别 --> <root level="INFO"> <appender-ref ref="STDOUT"/> <appender-ref ref="FILE"/> </root> </configuration> ``` 上面的配置文件定义了两个 appender:一个是控制台输出的 appender,一个是文件输出的 appender。其中,`name` 表示 appender 的名称,`class` 表示 appender 的类型,`encoder` 表示日志输出的格式。 同时,也定义了一个根日志记录器,设置了日志级别为 INFO,并将两个 appender 添加到根日志记录器中。 ## 3. 配置日志级别 Logback 提供了五种日志级别,从高到低分别是 ERROR、WARN、INFO、DEBUG 和 TRACE。在配置文件中,可以通过设置根日志记录器的级别来控制日志输出的级别。 例如,如果将根日志记录器的级别设置为 INFO,则只会输出 INFO、WARN 和 ERROR 级别的日志,DEBUG 和 TRACE 级别的日志将被忽略。 ## 4. 配置 appender Logback 支持多种 appender,可以将日志输出到控制台、文件、数据库等。在配置文件中,可以根据需求来配置相应的 appender。 例如,上面的配置文件中定义了两个 appender:一个是控制台输出的 appender,一个是文件输出的 appender。控制台输出的 appender 会将日志输出到控制台,文件输出的 appender 会将日志输出到文件中。 ## 5. 配置日志输出的格式 Logback 提供了丰富的日志输出格式,可以根据需求自定义日志输出的格式。在配置文件中,可以通过设置 appender 的 encoder 来定义日志输出的格式。 例如,上面的配置文件中设置了一个名为 `LOG_PATTERN` 的变量,用于定义日志输出的格式。然后在 appender 的 encoder 中使用 `${LOG_PATTERN}` 来引用该变量,实现日志输出格式的自定义。 ## 6. 使用 Java 代码配置 Logback 除了使用配置文件外,Logback 还支持使用 Java 代码来配置。以下是一个简单的示例: ```java import ch.qos.logback.classic.LoggerContext; import ch.qos.logback.core.util.StatusPrinter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class MyApp { public static void main(String[] args) { Logger logger = LoggerFactory.getLogger(MyApp.class); // 可以通过代码来配置 Logback LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); lc.reset(); // ... logger.debug("Debug message"); logger.info("Info message"); logger.warn("Warn message"); logger.error("Error message"); } } ``` 上面的代码中,首先获取一个 logger,然后通过代码来配置 Logback。最后使用 logger 输出一些日志信息。需要注意的是,在使用 Java 代码配置 Logback 时,必须在使用 logger 之前进行配置。 ## 总结 Logback 是一个功能强大、灵活且易于使用的 Java 日志框架,可以通过配置文件或者 Java 代码来控制日志的输出。在使用 Logback 时,需要注意配置文件的位置、日志级别、appender 的配置以及日志输出的格式。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值