日志框架之Logback

1. Logback

  • https://logback.qos.ch/documentation.html
  • Log4j 的创始人设计的
  • 三个模块
    • logback-core是其他两个模块的基础模块
    • logback-classic 完整实现 slf4j API
    • logback-access 访问模块与Servlet容器集成提供通过Http来访问日志的功能
  • 组件
    • Logger 日志记录器,主要用于存放日志对象,也可以定义日志类型、级别
    • Appender 指定日志输出的目的地,目的地可以是控制台、文件、数据库等
    • Layout 负责把事件转换成字符串,格式化日志信息 (在 Logback 中 Layout 对象被封装在 Encoder 中)
  • 配置文件有三种:logback.groovy, logback.xml, logback-test.xml
  • 5 种日志级别 TRACE < DEBUG(default) < INFO< WARN< ERROR ,类ch.qos.logback.classic.Level

2. Logger, Appenders and Layouts

3. Logback多环境配置

  • 加载顺序: logback.xml --> application.properties --> logback-spring.xml
  • Logback 框架会默认加载 classpath 下命名为 logback-spring 或 logback 的配置文件
<springProfile name="prod">
    <root level="error">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</springProfile>
<springProfile name="dev,test">
    <root level="INFO">...</root>
</springProfile>

启动方式:
方式一:java -jar xxx.jar –spring.profiles.active=prod
方式二:在 application.properties 中配置 logging.config=classpath:logback-spring.xml

4. 打印日志的规范准则

4.1 占位符

  • 支持占位符{}logger.info("name:{}, age:{}", "tinyspot", "20");
// 参数化形式{}占位,[] 进行参数隔离
logger.info("name:{}, age:{}", "tinyspot", "20");
logger.info("name:{}, age:{}", new Object[]{"tinyspot", "20"});
logger.info("call method, with args: [{}], [{}]", user, result);

4.2 打印异常栈

try {
    Class.forName("classname");
} catch (ClassNotFoundException e) {
    // e.printStackTrace();
    // logger.info("出现异常:{}", e);  有问题,e是引用类型对象,不能和前面的 {} 做字符串拼接
    logger.info("出现异常:", e);
}

4.3 日志级别判断

  • 历史原因,参考 文章
    • 很多日志框架都不支持{}模板的写法,于是通过字符串拼接来输出日志内容,字符串拼接会带来无用的性能损耗
// 为什么要提前判断isDebugEnabled()
if (log.isDebugEnabled()) {
    // 没使用占位符 {},直接字符串拼接损耗性能
    log.debug("hello, this is " + name);
}

// 使用 {},JVM执行到这时不会进行字符串拼接,且日志框架会自动判断DEBUG有没有开启
log.debug("hello, this is {}", name);

5. logback.xml

5.1 Layouts

Conversion Word Definition
c{length}
lo{length}
logger{length}
logger name
return the sub-string right to the rightmost dot character in the logger name
C{length}
class{length}
fully-qualified class name
m / msg / message 日志内容,logger.info("message:{}", "tinyspot");
M / method
d{pattern}
date{pattern}
d{pattern, timezone}
date{pattern, timezone}
%d{yyyy-MM-dd HH:mm:ss.SSS}
n "\r\n"
L / line the line number
t / thread the name of the thread

补充:转换器算法
The converter's abbreviation algorithm

5.2 自定义 Logger

  • 日志的父子继承关系是按照包结构的关系来指定的
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!-- 通过`${name}`取得 value 值 (EL表达式) -->
    <property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L %thread %m%n"></property>
    <property name="fileDir" value="/Users/tinyspot/Downloads"></property>
    <!-- appender设置日志输出的位置 -->
    <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
        <traget>System.err</traget>  <!-- System.out 默认黑色;System.err 红色 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>  <!-- 引用 property 配置中的 ${pattern} -->
        </encoder>
    </appender>
    <appender name="fileAppender" class="ch.qos.logback.core.FileAppender">
        <file>${fileDir}/mylog.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
    <!-- RollingFileAppender常用,日志要有滚动策略,避免单个文件过大 -->
    <appender name="rollingAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${fileDir}/roll.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
        <!-- 指定拆分规则 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${fileDir}/roll.%d{yyyy-MM-dd}.log%i.gz</fileNamePattern>  <!-- %i 表示序号 -->
            <maxFileSize>1KB</maxFileSize>
        </rollingPolicy>
    </appender>
    <!-- 自定义logger, additivity=false 不会重复记录 -->
    <!-- name="路径"  默认有父子关系 -->
    <!-- additivity:false 表示不继承 rootLogger -->
    <logger name="com.demo" level="info" additivity="false">
        <appender-ref ref="consoleAppender" />
    </logger>
    <!-- 日志记录器,root 即 rootLogger -->
    <!--  level: 日志级别,ALL表示所有日志级别 -->
    <root level="ALL">
        <appender-ref ref="consoleAppender" />
        <appender-ref ref="fileAppender" />
        <appender-ref ref="rollingAppender" />
    </root>
</configuration>

Log4j 改造为 logback

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

推荐阅读更多精彩内容