SLF4J日志级别以及使用场景

为什么要使用日志

在项目开发的过程中, 添加合适的日志是一个必不可少的过程,给程序添加合适的日志有以下两个好处。

  1. 可以通过查看日志的输出,了解程序的运行状况,判断程序是否按预期进行运行。

  2. 程序出现bug的时候,可以通过日志判断出现问题的原因,而不需要去做繁琐的排查。

如果没有合适的日志,程序的运行状态就像是一个黑盒,只能通过测试的手段去判断结果是否正确,而详细的运行细节只能通过debug的方式去查看。

在程序的测试阶段这么做当然没问题,但是项目上线之后呢?一旦线上程序出了问题,如何快速的定位问题产生的原因是非常重要的,只有快速定位到问题的原因并修复,才能够最大程度的减少损失。

线上的环境无法像测试阶段一样去debug,即使可以debug,重现程序出现问题的场景也需要慢慢的去摸索。这个时候,如果程序预先添加了合适的日志,将程序的运行状况记录下来,就可以给问题的排查提供线索,即使不能直接通过日志判断出问题,也能将问题排查的范围缩小,减少大量的问题排查时间。

SLF4J日志组件

SLF4J是Java程序开发中常用的日志管理组件,通过引入该类库,可以添加不同级别的日志,输出不同级别的信息。本篇文章对具体如何使用SLF4J将不作介绍,只讨论其定义的日志级别的使用场景。

SLF4J将日志分为trace、debug、info、warn、error五个级别,每个级别对应记录不同的日志,对应不同的使用场景。

trace

trace是最低优先级的日志,一般用来追踪详细的程序运行流,比如程序的运行过程中,运行到了哪一个方法,进入了哪一条分支。通过trace程序的运行流程,可以判断程序是否按照期望的逻辑在运行。举个例子,有以下代码段。

public class Car{
 
  //点火
  public void fire(){
    log.trace("fire")
    ...
  }
  //踩离合
  public void clutch(){
    log.trace("clutch")
    ...
  }
  //挂档
  public void gear(){
    log.trace("gear")
    ...
  }
  //松刹车
  public void looseBrake(){
    log.trace("gear")
    ...
  }
}

...
  
public void static main(String[] args){
  Car car = new Car();
  car.fire();
  car.clutch();
  car.gear();
  car.looseBrake();
}

上面的代码创建了一个Car实例,并依次运行了fire、clutch、gear、looseBrake四个方法完成骑车的起步动作。在上述的代码中,使用trace来跟踪了这个流程,记录了程序运行的流程,根据trace的记录,可以判断程序是否按流程去运行了。

debug

debug是比trace高一级别的日志,该级别的日志就是用来debug用的。这类日志往往用在判断是否有出现bug的场景,且往往记录了代码运行的详细信息,比如方法调用传入的参数信息。还是以上面的代码为例,将gear方法稍微变动如下。

//挂档
public void gear(int gear){
  log.trace("gear")
  //记录档位
  log.debug(gear)
  ...
}

假设运行的过程中出现了问题,为了定位问题的原因,可以使用debug级别的日志来记录档位,通过记录运行时传入的gear来判断是不是因为档位输入错误而导致Car起步失败。

info

info比debug高一级别,用来记录程序运行的一些关键信息,它不像trace那样记录程序运行的整个流程,也不像debug那样为了解决问题而记录详细的信息。info记录的是整个系统的运行信息,比如系统运行到了哪一个阶段,到达了哪一个状态。还是以车启动为例子,将启动的代码修改如下。

public void static main(String[] args){
  Car car = new Car();
  car.fire();
  car.clutch();
  car.gear(1);
  car.looseBrake();
  log.info("car is ready to run faster !");
}

可以看到,运行完looseBrake方法之后,使用info记录了车的状态,车已经完成了起步了,可以踩油门加速了。

warn

warn比info的级别更高,用来记录一些警告信息。警告信息表示,程序进入了一个特殊的状态,在该状态下程序可以继续运行,但是不建议让程序进入该状态,因为该状态可能导致结果出现问题。继续修改车启动的例子,将gear方法修改如下。

//挂档
public void gear(int gear){
  log.trace("gear")
  //记录档位
  log.debug(gear)
  if(gear > 1){
    log.warn("gear "+ gear +" is too high !")
  }
  ...
}

车启动的过程中如果以大于1档起步,就使用warn记录警告,告诉调用者不推荐这样使用,实际上2档起步也是可以的,但可能会出问题。

error

error级别的日志是最高优先级了,用来记录运行时的错误信息,表示程序运行过程中出现了需要被解决的问题,往往是一些异常。使用error日志的时候,一般会将详细的异常出现的原因记录。例如以下代码。

public void static main(String[] args){
  Car car = new Car();
  try{
    car.fire();
    car.clutch();
    car.gear(1);
    car.looseBrake();
  }catch(Exception e){
    log.error("run failed !",e.getCause())
  }
  log.info("car is ready to run faster !");
}

上面的代码捕获了起步时出现的异常,并记录了异常信息,这样一旦出现问题,就可以通过日志来定位。

以上就是笔者对于SLF4J定义的日志级别使用场景的一些理解,如果有什么不正确的地方,欢迎批评指正。

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

推荐阅读更多精彩内容

  • idea 添加注释/** 然后回车 选中代码块 Ctrl+Shift+/ 重点推荐阅读:https://www....
    Helen_Cat阅读 19,832评论 0 37
  • 打印日志是一门艺术,但长期被开发同学所忽视。日志就像车辆保险,没人愿意为保险付钱,但是一旦出了问题都又想有保险可用...
    猿天地阅读 1,283评论 0 24
  • 一、日志简介 1.1 日志是什么(WHAT) 日志:记录程序的运行轨迹,方便查找关键信息,也方便快速定位解决问题。...
    GeekerLou阅读 27,305评论 6 20
  • 程序员的日常离不开日志,日志就好比私人秘书,负责运行周期一切trace工作。优秀的日志实践能极大帮助地程序员快速定...
    Java架构阅读 818评论 0 3
  • 日志解决方案这么多,为何我们选择slf4j+log4j2来作为日志系统呢?首先我们来将常见的日志作对比。 1 日志...
    Jerry_Liang阅读 5,422评论 0 5