logback的使用

1. 依赖的jar包

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

2. logback的加载

  • logback 首先会查找 logback.groovy 文件
  • 当没有找到,继续试着查找 logback-test.xml 文件
  • 当没有找到时,继续试着查找 logback.xml 文件
  • 如果仍然没有找到,则使用默认配置(打印到控制台

3. logback.xml的配置

3.1 configuration节点

configuration是配置文件的根节点,

  • scan 当此属性设置为 true 时,配置文件如果发生改变,将会被重新加载,默认值为 true
  • scanPeriod 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。但 scan 为 true 时,此属性生效,默认的时间间隔为 1 分钟
  • debug 当此属性设置为 true 时,将打印出 logback 内部日志信息,实时查看 logback 运行状态,默认值为 false。
<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <!-- 其他配置省略-->  
</configuration> 

3.2 contextName

设置上下文的名称

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <contextName>myAppName</contextName>  
      <!-- 其他配置省略-->  
</configuration>

3.3 property

设置变量
用于定义键值对的变量, property 有两个属性 name 和 value,name 是键,value 是值,通过 property 定义的键值对会保存到logger 上下文的 map 集合内。定义变量后,可以使用 “${}” 来使用变量

3.4 logger

logger有两种级别,一种是普通的另一种是<root>
logger是用来设置某一个类或者某一个包的日志打印级别,以及指定的appender。
logger有三个属性:

  • name:指定日志打印的类或者包,也可能是单纯的一个名字,对应到loggerfactory获取logger的方法参数的那个名字,例:
Logger DISPATCHER_SUCCESS_LOGGER = LoggerFactory.getLogger("dispatcher_success");
  • level:用来设置打印机别
  • addtivity:是否向上级 logger 传递打印信息。默认是 true
logger的父级关系

每个包名通过包名决定决定父级关系

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

        <!--
            普通的 logger
            name:类名或包名,标志该 logger 与哪个包或哪个类绑定
            level:该 logger 的日志级别
            additivity:是否将日志信息传递给上一级
        -->
        <logger name="com.lwc.qg.test.logbackDemo" level="debug" additivity="true">
            <appender-ref ref="STDOUT"/>
        </logger>

        <logger name="com.lwc.qg.test" level="info" additivity="true">
            <appender-ref ref="STDOUT"/>
        </logger>

        <logger name="com.lwc.qg" level="info" additivity="true">
            <appender-ref ref="STDOUT"/>
        </logger>

他们几个logger的父级关系是
com.lwc.qg.test.logbackDemo → com.lwc.qg.tes → com.lwc.qg → root

  • 日志打印流程:从最低级别的logger开始,判断级别,有自己的级别用自己的,有appender-ref就打印日志,再看additivity属性,为true就再向上传递日志信息,为false就整个一条链断了,所有父级不管有没有appender-ref都也不打日志
  • 日志级别:有子级的日志级别用子级的,如果没有子级且自己也没有用父级的

3.5 appender

appender 是负责写日志的组件,常用的组件有

  • ConsoleAppender
  • FileAppender
  • RollingFileAppender

3.5.1 ConsoleAppender

控制台日志组件,该组件将日志信息输出到控制台,该组件有以下节点:
encoder:对日志进行格式化
target:System.out 或者 System.err,默认是 System.out

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
        <encoder>  
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
        </encoder> 
        <target>System.out</target> 
    </appender>

3.5.2 FileAppender

文件日志组件,该组件将日志信息输出到日志文件中,该组件有以下节点

  • file:被写入的文件名,可以是相对路径,也可以是绝对路径。如果上级目录不存在会自动创建,没有默认值
  • append:如果是 true,日志被追加到文件结尾;如果是 false,清空现存文件,默认是 true。
  • encoder:格式化
  • prudent:如果是 true,日志会被安全的写入文件,即使其他的 FileAppender 也在向此文件做写入操作,效率低,默认是 false。
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>testFile.log</file>
        <append>true</append>
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
        <prudent>true</prudent>
    </appender>

3.5.3 RollingFileAppender

滚动记录文件日志组件,先将日志记录记录到指定文件,当符合某个条件时,将日志记录到其他文件,该组件有以下节点

  • file:文件名
  • encoder:格式化
  • rollingPolicy:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
  • triggeringPolicy:告知 RollingFileAppender 合适激活滚动
  • prudent:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。

3.5.3.1 rollingPolicy

滚动策略

  1. TimeBasedRollingPolicy:最常用的滚动策略,它根据时间来制定滚动策略,即负责滚动也负责触发滚动,包含节点:
  • fileNamePattern:文件名模式
  • maxHistoury:控制文件的最大数量,超过数量则删除旧文件
  1. FixedWindowRollingPolicy:根据固定窗口算法重命名文件的滚动策略,包含节点
  • minInedx:窗口索引最小值
  • maxIndex:串口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12
  1. fileNamePattern:文件名模式,必须包含%i,命名模式为 log%i.log,会产生 log1.log,log2.log 这样的文件
  • triggeringPolicy:根据文件大小的滚动策略,包含节点
  • maxFileSize:日志文件最大大小
<appender name="daoPerf4j" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_HOME}/dispatcher.daoPerf4j.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/history/%d{yyyyMM,aux}/dispatcher.daoPerf4j.log.%d{yyyyMMdd}</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder>
            <Pattern>%msg%n</Pattern>
            <charset>utf-8</charset>
        </encoder>
    </appender>

注:日志行的格式

由appender的encoder子标签决定

<encoder>
            <charset>UTF-8</charset>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{15} [%M:%L] %X{traceId} %X{orderNo} - %msg%n</pattern>
        </encoder>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容

  • 转自:http://www.cnblogs.com/warking/p/5710303.html 一、logbac...
    chenzhong_阅读 1,501评论 0 3
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 5,035评论 1 13
  • 原文出处:朱小厮 概述 LogBack是一个日志框架,它与Log4j可以说是同出一源,都出自Ceki Gülcü之...
    从你说谎阅读 437评论 0 3
  • logback 标签(空格分隔): java 1.概述 LogBack是一个日志框架. 1.1 LogBack、S...
    李米学阅读 1,170评论 0 2
  • 一:根节点包含的属性: scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为tru...
    把爱放下会走更远阅读 631评论 0 0