为什么要使用日志
在项目开发的过程中, 添加合适的日志是一个必不可少的过程,给程序添加合适的日志有以下两个好处。
可以通过查看日志的输出,了解程序的运行状况,判断程序是否按预期进行运行。
程序出现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定义的日志级别使用场景的一些理解,如果有什么不正确的地方,欢迎批评指正。