Java日志记录框架Logback配置详解(企业级应用解决方案)

最新推荐文章于 2024-07-27 12:24:55 发布
最新推荐文章于 2024-07-27 12:24:55 发布
阅读量4.4k 收藏 20
点赞数 1
分类专栏： 技术博客 文章标签： 日志框架 Logback Logback配置
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/RobertoHuang/article/details/75452508
版权

前言

Logback是现在比较流行的一个日志记录框架，它的配置比较简单学习成本相对较低，所以刚刚接触该框架的朋友不要畏惧，多花点耐心很快就能灵活应用了。本篇博文不会具体介绍Logback搭建过程，如果你是Logback初学者强烈建议阅读Logback常用配置详解，它对Logback的配置介绍的非常的详细，相信你看完这篇博客后会对Logback有一定的了解，然后再回头看下面的内容收获会更大

YAML配置

# 日志配置
logging:
  config: classpath:logback.xml

企业级应用常用Logback配置

<?xml version="1.0" encoding="UTF-8" ?>
<!--
    scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true
    scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位默认单位是毫秒，当scan为true时此属性生效，默认时间间隔为1分钟
    debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态，默认值为false
 -->
<configuration scan="true" scanPeriod="3 seconds" debug="false">
    <!-- 这一句的意思是打印所有进入的信息 -->
    <statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener" />

    <!--
        appender是<configuration>的子节点，是负责写日志的组件
        两个必要属性name和class:name指定appender名称，class指定appender的全限定名
        定义控制台appender 作用:把日志输出到控制台 class="ch.qos.logback.core.ConsoleAppender"
    -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 对日志进行格式化 -->
        <encoder>
            <pattern>
                {"timestamp":"%d{yyyy-MM-dd'T'HH:mm:ss.SSS}","thread":"%t","line":"%line","log_level":"%p","class_name":"%C;","msg":"%m"}\n
            </pattern>
        </encoder>
    </appender>

    <!--
        定义滚动记录文件appender 作用:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件
        RollingFileAppender class="ch.qos.logback.core.rolling.RollingFileAppender"
        参数：
            <append>:如果是true日志被追加到文件结尾，如果是false清空现存文件,默认是true
            <file>:被写入的文件名，可以是相对目录也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值
            <rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名
            <triggeringPolicy>:告知RollingFileAppender合适激活滚动
            <prudent>:当为true时不支持FixedWindowRollingPolicy支持TimeBasedRollingPolicy，但是有两个限制:1不支持也不允许文件压缩,2不能设置file属性必须留空
    -->
    <appender name="LOGBACK_ALL_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <append>true</append>
        <file>logs/logback-test-all.log</file>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天滚动一次的日志 -->
            <FileNamePattern>logs/logback-test.%d{yyyy-MM-dd}.log.zip</FileNamePattern>
            <!-- 每分钟滚动一次日志 -->
            <!-- <FileNamePattern>logs/logback-test.%d{yyyy-MM-dd_HH-mm}.log.zip</FileNamePattern> -->
            <!--  只保留30天内的日志文件 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>

        <!-- 配置临界值过滤器 作用:过滤掉低于指定临界值的日志，当日志级别等于或高于临界值时过滤器返回NEUTRAL，当日志级别低于临界值时，日志会被拒绝 此处配置为INFO 即过滤掉日志级别小于INFO的日志信息 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>

        <encoder>
            <pattern>
                {"timestamp":"%d{yyyy-MM-dd'T'HH:mm:ss.SSS}","thread":"%t","line":"%line","log_level":"%p","class_name":"%C;","msg":"%m%n", "caller":"%caller{1}"}
            </pattern>
        </encoder>
    </appender>

    <!--
        定义滚动记录文件appender 作用:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件
        RollingFileAppender class="ch.qos.logback.core.rolling.RollingFileAppender"
        参数：
            <append>:如果是true日志被追加到文件结尾，如果是false清空现存文件,默认是true
            <file>:被写入的文件名，可以是相对目录也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值
            <rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名
            <triggeringPolicy>:告知RollingFileAppender合适激活滚动
            <prudent>:当为true时不支持FixedWindowRollingPolicy支持TimeBasedRollingPolicy，但是有两个限制:1不支持也不允许文件压缩,2不能设置file属性必须留空
     -->
    <appender name="LOGBACK_ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <append>true</append>
        <file>logs/logback-test-error.log</file>
        <!--
            定义滚动策略 作用:根据固定窗口算法重命名文件的滚动策略 class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy
            <fileNamePattern>:表示当触发了回滚策略后，按这个文件命名规则生成归档文件，命名规则中的%i表示在maxIndex和minIndex之间的一个整数值
            <minIndex>:最小索引值
            <maxIndex>:最大索引值
         -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>logs/logback-test-error.log.%i</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>20</maxIndex>
        </rollingPolicy>

        <!-- 定义按文件大小触发滚动策略triggeringPolicy 作用:查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender触发当前活动文件滚动 只有一个参数 maxSize 这是活动文件的大小，默认值是10MB -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>50MB</maxFileSize>
        </triggeringPolicy>

        <!--
            配置日志级别过滤器 作用:根据日志级别进行过滤，如果日志级别等于配置级别过滤器会根据onMath和onMismatch接收或拒绝日志
            参数:
                <level>:设置过滤级别
                <onMatch>:用于配置符合过滤条件的操作
                <onMismatch>:用于配置不符合过滤条件的操作
                此处配置为只接收ERROR日志级别信息
        -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>

        <encoder>
            <pattern>
                {"timestamp":"%d{yyyy-MM-dd'T'HH:mm:ss.SSS}","thread":"%t","line":"%line","log_level":"%p","class_name":"%C;","msg":"%m%n", "caller":"%caller{1}"}
            </pattern>
        </encoder>
    </appender>

    <!--
        logger用来设置某一个包的日志打印级别,以及指定<appender>
        <loger> 仅有一个name属性,一个可选的level和一个可选的addtivity属性
                name:用来指定受此loger约束的某一个包或者具体的某一个类
                level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF
                addtivity:是否向上级loger传递打印信息。默认是true,会将信息输入到root配置指定的地方,可以包含多个appender-ref，标识这个appender会添加到这个logger
    -->
    <logger name="com.roberto" level="DEBUG" additivity="false">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="LOGBACK_ALL_LOG" />
        <appender-ref ref="LOGBACK_ERROR_LOG" />
    </logger>

    <!-- 将root的打印级别设置为"INFO",指定了名字为"FILE","STDOUT"的appender -->
    <root>
        <level value="INFO" />
        <appender-ref ref="STDOUT" />
        <appender-ref ref="LOGBACK_ALL_LOG" />
        <appender-ref ref="LOGBACK_ERROR_LOG" />
    </root>
</configuration>

以上配置部分涵盖了大部分日志记录的需求，如控制台输出日志、文件记录日志、日志输出格式化、按文件大小滚动日志、按日期滚动日志、日志级别过滤等等，在实际应用中只需对配置进行适当的修改即可。以上配置注释部分可以帮助你解决百分90的疑惑，接下来我以上诉配置为基准，运行程序进行简单解释说明

企业级应用常用Logback配置讲解

  • 在com.roberto包下测试

    package com.roberto;

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

public class LogbackTest {
  private static Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class);

  public static void main(String[] args) {
      LOGGER.debug("=======DEBUG=======");
      LOGGER.info("========INFO=======");
      LOGGER.warn("========WARN=======");
      LOGGER.error("=======ERROR=======");
  }
}

    以上诉配置为基准新建Logback测试类 观察日志输出情况 切记包名为com.roberto

    • 控制台输出
    {"timestamp":"2018-08-17T10:42:11.089","thread":"main","line":"28","log_level":"DEBUG","class_name":"com.roberto.LogbackTest;","msg":"=======DEBUG======="}
{"timestamp":"2018-08-17T10:42:11.094","thread":"main","line":"29","log_level":"INFO","class_name":"com.roberto.LogbackTest;","msg":"========INFO======="}
{"timestamp":"2018-08-17T10:42:11.095","thread":"main","line":"30","log_level":"WARN","class_name":"com.roberto.LogbackTest;","msg":"========WARN======="}
{"timestamp":"2018-08-17T10:42:11.095","thread":"main","line":"31","log_level":"ERROR","class_name":"com.roberto.LogbackTest;","msg":"=======ERROR======="}
    <logger name="com.roberto" level="DEBUG" additivity="false">
    <appender-ref ref="STDOUT" />
    <appender-ref ref="LOGBACK_ALL_LOG" />
    <appender-ref ref="LOGBACK_ERROR_LOG" />
</logger>

    控制台打印以上内容是因为这里配置了包名为com.roberto的DEBUG信息输出到控制台

    • logback-test-all.log内容
    {"timestamp":"2018-08-17T10:42:11.094","thread":"main","line":"29","log_level":"INFO","class_name":"com.roberto.LogbackTest;","msg":"========INFO=======", "caller":"Caller+0     at com.roberto.LogbackTest.main(LogbackTest.java:29)"}
{"timestamp":"2018-08-17T10:42:11.095","thread":"main","line":"30","log_level":"WARN","class_name":"com.roberto.LogbackTest;","msg":"========WARN=======", "caller":"Caller+0     at com.roberto.LogbackTest.main(LogbackTest.java:30)"}
{"timestamp":"2018-08-17T10:42:11.095","thread":"main","line":"31","log_level":"ERROR","class_name":"com.roberto.LogbackTest;","msg":"=======ERROR=======", "caller":"Caller+0     at com.roberto.LogbackTest.main(LogbackTest.java:31)"}
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>INFO</level>
</filter>

    虽然配置com.roberto的DEBUG级别信息输出到logback-test-all.log，但是由于LOGBACK_ALL_LOG的appender中配置了过滤器，过滤掉了INFO级别以下的信息，所以logback-test-all.log信息如上

    • logback-test-error.log内容
    {"timestamp":"2018-08-17T10:42:11.095","thread":"main","line":"31","log_level":"ERROR","class_name":"com.roberto.LogbackTest;","msg":"=======ERROR=======", "caller":"Caller+0     at com.roberto.LogbackTest.main(LogbackTest.java:31)"}
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
    <level>ERROR</level>
    <onMatch>ACCEPT</onMatch>
    <onMismatch>DENY</onMismatch>
</filter>

    虽然配置com.roberto的DEBUG级别信息输出到logback-test-error.log，但是由于LOGBACK_ERROR_LOG的appender中配置了过滤器，只输出ERROR级别信息，所以logback-test-error.log打印信息如上

  • 在非com.roberto包下测试

    package com.dreamt;

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

public class LogbackTest {
  private static Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class);

  public static void main(String[] args) {
      LOGGER.debug("=======DEBUG=======");
      LOGGER.info("========INFO=======");
      LOGGER.warn("========WARN=======");
      LOGGER.error("=======ERROR=======");
  }
}

    注意此处包名不为com.roberto，观察日志输出情况

    • 控制台输出
    {"timestamp":"2018-08-17T10:53:22.669","thread":"main","line":"29","log_level":"INFO","class_name":"com.dreamt.LogbackTest;","msg":"========INFO======="}
{"timestamp":"2018-08-17T10:53:22.678","thread":"main","line":"30","log_level":"WARN","class_name":"com.dreamt.LogbackTest;","msg":"========WARN======="}
{"timestamp":"2018-08-17T10:53:22.679","thread":"main","line":"31","log_level":"ERROR","class_name":"com.dreamt.LogbackTest;","msg":"=======ERROR======="}
    • logback-test-all.log内容
    {"timestamp":"2018-08-17T10:53:22.669","thread":"main","line":"29","log_level":"INFO","class_name":"com.dreamt.LogbackTest;","msg":"========INFO=======", "caller":"Caller+0     at com.dreamt.LogbackTest.main(LogbackTest.java:29)"}
{"timestamp":"2018-08-17T10:53:22.678","thread":"main","line":"30","log_level":"WARN","class_name":"com.dreamt.LogbackTest;","msg":"========WARN=======", "caller":"Caller+0     at com.dreamt.LogbackTest.main(LogbackTest.java:30)"}
{"timestamp":"2018-08-17T10:53:22.679","thread":"main","line":"31","log_level":"ERROR","class_name":"com.dreamt.LogbackTest;","msg":"=======ERROR=======", "caller":"Caller+0     at com.dreamt.LogbackTest.main(LogbackTest.java:31)"}
    • logback-test-error.log内容
    {"timestamp":"2018-08-17T10:53:22.679","thread":"main","line":"31","log_level":"ERROR","class_name":"com.dreamt.LogbackTest;","msg":"=======ERROR=======", "caller":"Caller+0     at com.dreamt.LogbackTest.main(LogbackTest.java:31)"}
    • 以上输出是由于配置文件如下
    <root>
    <level value="INFO" />
    <appender-ref ref="STDOUT" />
    <appender-ref ref="LOGBACK_ALL_LOG" />
    <appender-ref ref="LOGBACK_ERROR_LOG" />
</root>

关于滚动日志这里就不做测试，你们可以自己写个循环输出日志进行测试，上面配置注释的非常清楚，只要你们肯动手肯定能实验成功的，以上部分纯属个人拙见，如有误解欢迎大家指正，谢谢~

RobertoHuang
关注
专栏目录
expad-spring:Spring版的ExPad卡发行解决方案
05-17
Spring是一个开源的应用框架，主要设计用于简化企业级Java应用的开发。它提供了一个全面的基础设施，包括数据访问、事务管理、远程服务、AOP（面向切面编程）以及多种Web框架的集成。Spring的核心是IoC（Inversion ...
Java日志框架：logback配置详解
碌碌无为的小陈的博客
01-12 513
引（废）言（话） 本文的核心内容在于如何快速在maven项目中配置logback日志框架，使日志即输出在控制台，又以log文件的形式输出到本地磁盘保存。 1.logback的优点 logback日志框架的优点： （1）内核重写，测试充分，初始化内存加载更小； （2）logback非常自然地直接实现了slf4j； （3）有比较齐全地200多页地文档； （4）配置修改后，支持自定重新加载配置文件； （...
logback.xml配置详解
weixin_43611145的博客
07-22 533
logback.xml配置详解 相关文章 SSM项目中应用：SSM框架搭建Web项目 log4j.xml配置详解：log4j.xml配置详解 log4j自定义输出级别和输出信息：log4j自定义输出级别和输出信息 jar包链接地址：Jar包下载点我 1.简介 Logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块：logback-core，logback- c...
logback-spring配置文件
最新发布
G121121W的博客
07-27 359
【代码】logback-spring配置文件。
springboot配置logback.xml(多环境配置)
leomoon
11-11 4277
一、配置dev,pro环境，通过spring.profiles.active属性切换日志配置 1.application.yml配置 # Spring配置 spring: profiles: active: dev # 指定日志配置文件(默认) logging: config: classpath:logback.xml 2.application-dev.yml配置 # 指定日志配置文件 logging: config: classpath:logback-dev.xml 3.l
Java实战04之 springboot 整合logback 打印日志，分文件
浪漫手机的博客
06-09 3202
springboot 整合logback
日志输出 logback.xml 放置的位置以及找不到logback.xml文件的问题
weixin_33845477的博客
06-29 2948
2019独角兽企业重金招聘Python工程师标准>>> ...
springboot项目创建笔记29 之《springboot打包优化2—加载logback.xml问题》
csj50的专栏
09-09 2122
打包优化分离配置文件后，服务器部署时logback.xml加载有问题。问题就是，在ide中需要设置classpath路径，服务器部署需要设置file路径 以下都是在服务器上部署的加载测试 一、设置成classpath 1、classpath:./config/logback.xml 启动报错： Logging system failed to initialize using configuration from 'classpath:./config/logback.xml' java.io.Fil
基于ssm框架仓库系统.zip
04-01
1. **Spring框架**：Spring是Java企业级应用的核心框架，提供了一个全面的编程和配置模型，使得开发复杂的、集成了的、企业级应用变得更加简单。在本仓库系统中，Spring主要负责管理应用的组件，包括数据库连接池、...
java项目管理系统源码
03-02
9. **日志记录**：日志系统是诊断问题的关键，项目中可能使用了Log4j、SLF4J或Logback等日志框架，方便追踪和分析程序运行状态。 10. **持续集成/持续部署（CI/CD）**：源码可能包含了与Jenkins、GitLab CI/CD或...
airline_Java、SpringBoot_java_sillyurp_
09-29
本文将深入探讨一款名为"airline"的航班售票系统，该系统利用Java编程语言和SpringBoot框架进行后端开发，结合MySQL数据库，为用户提供了一个完整的机票预订解决方案。 一、Java与SpringBoot的应用 Java作为一款跨...
基于java的开发源码-多用户商城电子商务系统.zip
04-01
使用Log4j、Logback等日志框架记录系统运行状态，便于排查问题；引入Prometheus、Grafana等监控工具，实时监控系统性能，及时发现并解决问题。 14. **持续集成与自动化测试**： Jenkins、GitLab CI/CD等工具实现...
spring如何自定义加载logback.xml
static_coder的博客
05-11 9574
1、前言做过项目的朋友们都知道，只要把logback或者log4j放在下，容器就可以自动加载日志文件。但是如何自定义日志文件的路径呢？2、logback的自动加载从官方文档中找找原因：Logback can be configured either programmatically or with a configuration script expressed in XML or Groo...
Java日志框架：logback详解
yuhui666666的博客
08-16 872
举一反三，上面的name="java"这个可以把additivity设置为true试试看是什么结果，如果对前面的分析理解的朋友应该很容易想到，有两部分日志输出，一部分是日志级别大于等于warn的、一部分是日志级别大于等于debug的。目前PatternLayoutEncoder是唯一有用的且默认的encoder，有一个节点，就像上面演示的，用来设置日志的输入格式，使用“%+转换符"的方式，如果要输出"%"则必须使用"\%"对"%"进行转义。...
【Java】logback.xml文件配置
Syals的博客
12-05 4576
logback日志的使用。logback.xml的配置文件讲解
java日志框架之logback详解
不忘初心的博客
12-06 1544
一、logback介绍 Logback是流行的log4j项目的继承者，Logback的体系结构足够通用，可以应用于不同的环境。目前，logback分为三个模块，即logback-core、logback-classic和logback-access。 logback-core模块为其他两个模块奠定了基础。 logback-classic模块可以被同化为log4j的显著改进版本。此外，logb...
LOGBACK 配置: 用 XML
热门推荐
Elementary Conference
07-31 1万+
现如今，java 开发中 都用logback来配置日志了。之前看到一篇好文章，翻译分享给大家。 原文前言当底层的日志记录框架成为一个技术瓶颈时，将无法很好记录日志。日志记录框架需要是快速的，有一个小的内存占用空间，并且可以很容易地配置。Logback是日志框架具有这些优点。如果你是新的Logback，我建议去通过我的介绍后对logback：logback简介：一个企业级日志框架。生成Logger我
logback配置xml日志文件(保姆级教程)
程序员劝退师的博客
01-23 828
前言 这是个啥，这就是个控制日志输出格式、控制日志输出位置、控制日志输出环境、控制日志输出级别的玩意、控制忽略输出的日志就这些功能，没有什么很复杂的东西，废话不说多了。 配置介绍 configuration <configuration scan="true" scanPeriod="10 seconds"> scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是
springboot配置logback日志
weixin_42057187的博客
03-03 390
application.yml添加配置： # 日志配置 logging: level: com.egao: DEBUG com.baomidou.mybatisplus: DEBUG # config: /java/code/idea/projects/****/**/EducationPlatformBak/src/main/resources/logback.xml config: classpath:logback.xml # config: src/main/resour
Java日志首选：logback性能优化与配置解析
"本文主要介绍了Java日志框架logback，包括其优势、使用原因以及加载过程。logback因其内核优化、与SLF4J的良好集成、丰富的文档、配置文件实时更新和日志文件管理功能而备受推崇。文章还详细阐述了logback的启动...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值