Logger打印日志

最新推荐文章于 2024-08-26 21:12:21 发布
最新推荐文章于 2024-08-26 21:12:21 发布
阅读量743 收藏 1
点赞数
分类专栏： Logger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Architect_CSDN/article/details/83024069
版权

1. 一个最基本的例子

使用Logging框架写Log基本上就三个步骤

  1. 引入loggerg类和logger工厂类
  2. 声明logger
  3. 记录日志

下面看一个例子

//1. 引入slf4j接口的Logger和LoggerFactory
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class UserService {
  //2. 声明一个Logger，这个是static的方式，我比较习惯这么写。
  private final static Logger logger = LoggerFactory.getLogger(UserService.class);

  public boolean verifyLoginInfo(String userName, String password) {
    //3. log it，输出的log信息将会是："Start to verify User [Justfly]
    logger.info("Start to verify User [{}]", userName);
    return false;
  }
}

其中的第二步，关于Logger对象是否要声明为静态的业界有过一些讨论，Logback的作者最早是推荐使用对象变量的方式来声明，后来他自己也改变了想法。想详细了解的同学可以去看一下: http://slf4j.org/faq.html#declared_static

两种方式的优劣概述如下：

  • 静态Logger对象相对来说更符合语义，节省CPU，节省内存，不支持注入
  • 对象变量Logger支持注入，对于一个JVM中运行的多个引用了同一个类库的应用程序，可以在不同的应用程序中对同个类的Logger进行不同的配置。比如Tomcat上部署了俩个应用，他们都引用了同一个lib。

2. Logger接口的方法

Logger接口分为俩个版本，一个带Marker版本和一个没带Marker版本的。带Marker版本的我没用过就不介绍了。没带Marker版本的接口方法可以分为以下两组：

2.1 判断Logger级别是否开启的方法

  • public boolean isTraceEnabled();
  • public boolean isDebugEnabled();
  • public boolean isInfoEnabled();
  • public boolean isWarnEnabled();
  • public boolean isErrorEnabled();

这组方法的作用主要是避免没必要的log信息对象的产生，尤其是对于不支持参数化信息的Log框架(Log4j 1, commons-logging)。如下面的例子所示，如果没有加debug级别判断，在Debug级别被禁用的环境（生产环境）中，第二行的代码将没有必要的产生多个String对象。

1 if(logger.isDebugEnabled()){
2   logger.debug("["+resultCount+"]/["+totalCount+"] of users are returned");
3 }

如果使用了参数信息的方法，在如下代码中，即使没有添加debug级别（第一行）判断，在生产环境中，第二行代码只会生成一个String对象。

1 if(logger.isDebugEnabled()){
2   logger.debug("[{}]/[{}] of users in group are returned", resultCount,totalCount);
3 }

因此，为了代码的可读性，我一般情况下使用参数化信息的方法，并且不做Logger级别是否开启的判断，换句话说，这组方法我一般情况下不会用。

2.2 log信息的方法

2.2.1 方法说明

Logger中有五个级别：track,debug,info,warn,error。对于每个级别，分别有五个log方法，以info级别为例子：

  • public void info(String msg);

无参数的log方法，例子：

logger.info("开始初始化配置文件读取模块");

输出

2014-08-11 23:36:17,783 [main] INFO  c.j.training.logging.service.UserService - 开始初始化配置文件读取模块

  • public void info(String format, Object arg);

支持一个参数的参数化log方法，例子：

logger.info("开始导入配置文件[{}]","/somePath/config.properties");

输出

2014-08-11 23:36:17,787 [main] INFO  c.j.training.logging.service.UserService - 开始导入配置文件[/somePath/config.properties]

  • public void info(String format, Object arg1, Object arg2);

支持俩个参数的参数化log方法，例子：

logger.info("开始从配置文件[{}]中读取配置项[{}]的值","/somePath/config.properties","maxSize");

输出

2014-08-11 23:36:17,789 [main] INFO  c.j.training.logging.service.UserService - 开始从配置文件[/somePath/config.properties]中读取配置项[maxSize]的值

  • public void info(String format, Object... arguments);

支持多个参数的参数化log方法，对比上面的俩个方法来说，会多增加构造一个Object[]的开销。例子：

logger.info("在配置文件[{}]中读取到配置项[{}]的值为[{}]","/somePath/config.properties","maxSize", 5);

输出

2014-08-11 23:36:17,789 [main] INFO  c.j.training.logging.service.UserService - 在配置文件[/somePath/config.properties]中读取到配置项[maxSize]的值为[5]

  • public void info(String msg, Throwable t);

无参数化记录log异常信息

logger.info("读取配置文件时出现异常",new FileNotFoundException("File not exists"));

输出

2014-08-11 23:36:17,794 [main] INFO  c.j.training.logging.service.UserService - 读取配置文件时出现异常
java.io.FileNotFoundException: File not exists
  at cn.justfly.training.logging.service.UserServiceTest.testLogResult(UserServiceTest.java:31) ~[test-classes/:na]
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.6.0_45]
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) ~[na:1.6.0_45]
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) ~[na:1.6.0_45]
  at java.lang.reflect.Method.invoke(Method.java:597) ~[na:1.6.0_45]


参数化说明

在上面的例子中，我们可以看到log信息中的{}将会按照顺序被后面的参数所替换。这样带来了一个好处：如果在运行时不需要打印该Log，则不会重复产生String对象。

2.2.2 如何Log Exception

2.2.2.1 把Exception作为Log方法的最后一个参数

上面讲的参数化Log方法的中的最后一个参数如果是一个Exception类型的对象的时候，logback将会打印该Exception的StackTrace信息。看下面的这个例子：

logger.info("读取配置文件[{}]时出错。","/somePath/config.properties",new FileNotFoundException("File not exists"));

上面的代码在执行的时候会输出如下内容：

2014-08-12 00:22:49,167 [main] INFO  c.j.training.logging.service.UserService - 读取配置文件[/somePath/config.properties]时出错。
java.io.FileNotFoundException: File not exists
  at cn.justfly.training.logging.service.UserServiceTest.testLogResult(UserServiceTest.java:30) [test-classes/:na]
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.6.0_45]
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) ~[na:1.6.0_45]
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) ~[na:1.6.0_45]
  at java.lang.reflect.Method.invoke(Method.java:597) ~[na:1.6.0_45]
  at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:47) [junit.jar:na]
  at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12) [junit.jar:na]
  at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:44) [junit.jar:na]
  at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17) [junit.jar:na]
  at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:271) [junit.jar:na]

2.2.2.2 Exception不会替换log信息中的参数

另外需要注意的时，该Exception不会作为参数化内容中的参数进行替换。比如下面的代码：

logger.info("读取配置文件[{}]时出错。异常为[{}]","/somePath/config.properties",new FileNotFoundException("File not exists"));

其执行结果如下所示，第二个参数没有进行替换

2014-08-12 00:25:37,994 [main] INFO  c.j.training.logging.service.UserService - 读取配置文件[/somePath/config.properties]时出错。异常为[{}]
java.io.FileNotFoundException: File not exists
  at cn.justfly.training.logging.service.UserServiceTest.testLogResult(UserServiceTest.java:30) [test-classes/:na]
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.6.0_45]
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) ~[na:1.6.0_45]
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) ~[na:1.6.0_45]
  at java.lang.reflect.Method.invoke(Method.java:597) ~[na:1.6.0_45]

2.2.2.3 参数化Exception

如果你就是不想要打印StackTrace，就是要将其参数化的话怎么弄？一般情况下不建议这么做，因为你把Exception中有用的东西吃掉了。但是如果你非要这么做的话，也不是不可以，有俩个方法：

  • 把Exception的toString()方法的返回值作为参数

例子如下所示，注意我们不用ex.getMessage()而是用toString()方法，原因在于不是每个Message实例都有Message，但是默认的toString()方法里面包括有Message

logger.info("读取配置文件[{}]时出错。异常为[{}]","/somePath/config.properties",new FileNotFoundException("File not exists").toString());

执行结果为：

2014-08-12 00:29:24,018 [main] INFO  c.j.training.logging.service.UserService - 读取配置文件[/somePath/config.properties]时出错。异常为[java.io.FileNotFoundException: File not exists]

  • 不要让Exception成为最后一个参数

例子如下：

logger.info("读取参数[{}]的时候出错：[{}], 请检查你的配置文件[{}]","maxSize",new FileNotFoundException("File not exists"),"/somePath/config.properties");

执行结果为：

2014-08-12 00:35:11,125 [main] INFO  c.j.training.logging.service.UserService - 读取参数[maxSize]的时候出错：[java.io.FileNotFoundException: File not exists], 请检查你的配置文件[/somePath/config.properties]

3. Log什么

前面讲了怎么使用Loggger的方法log日志，下面继续讲讲在什么地方需要记录什么级别的log，以及需要记录什么内容。

3.1 如何使用不同级别的Log

SLF4J把Log分成了Error，Warn，Info，Debug和Trace五个级别。我们可以把这俩个级别分成两组

3.1.1 用户级别

Error、Warn和Info这三个级别的Log会出现在生产环境上，他们必须是运维人员能阅读明白的

3.1.1.1 Error

  • 影响到程序正常运行、当前请求正常运行的异常情况,例如：
    • 打开配置文件失败
    • 第三方应用网络连接异常
    • SQLException
  • 不应该出现的情况，例如：
    • 某个Service方法返回的List里面应该有元素的时候缺获得一个空List
    • 做字符转换的时候居然报错说没有GBK字符集

3.1.1.2 Warn

  • 不应该出现但是不影响程序、当前请求正常运行的异常情况，例如：
    • 有容错机制的时候出现的错误情况
    • 找不到配置文件，但是系统能自动创建配置文件
  • 即将接近临界值的时候，例如：
    • 缓存池占用达到警告线

3.1.1.3 Info

  • 系统运行信息
    • Service方法的出入口
    • 主要逻辑中的分步骤
  • 外部接口部分
    • 客户端请求参数和返回给客户端的结果
    • 调用第三方时的调用参数和调用结果

3.1.2 开发级别

Debug和Trace这俩个级别主要是在开发期间使用或者当系统出现问题后开发人员介入调试的时候用的，需要有助于提供详细的信息。

3.1.2.1 Debug

  • 用于记录程序变量，例如：
    • 多次迭代中的变量
  • 用于替代代码中的注释

如果你习惯在代码实现中写：

//1. 获取用户基本薪资

//2. 获取用户休假情况

//3. 计算用户应得薪资

不妨这么写试试

logger.debug("开始获取员工[{}] [{}]年基本薪资",employee,year);

logger.debug("获取员工[{}] [{}]年的基本薪资为[{}]",employee,year,basicSalary);
logger.debug("开始获取员工[{}] [{}]年[{}]月休假情况",employee,year,month);

logger.debug("员工[{}][{}]年[{}]月年假/病假/事假为[{}]/[{}]/[{}]",employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);
logger.debug("开始计算员工[{}][{}]年[{}]月应得薪资",employee,year,month);

logger.debug("员工[{}] [{}]年[{}]月应得薪资为[{}]",employee,year,month,actualSalary);

3.1.2.2 Trace

主要用于记录系统运行中的完整信息，比如完整的HTTP Request和Http Response

3.2 Log中的要点

3.2.1 Log上下文

在Log中必须尽量带入上下文的信息，对比以下俩个Log信息，后者比前者更有作用

  • "开始导入配置文件"
  • "开始导入配置文件[/etc/myService/config.properties]"

3.2.2 考虑Log的读者

对于用户级别的Log，它的读者可能是使用了你的框架的其他开发者，可能是运维人员，可能是普通用户。你需要尽量以他们可以理解的语言来组织Log信息，如果你的Log能对他们的使用提供有用的帮助就更好了。

下面的两条Log中，前者对于非代码维护人员的帮助不大，后者更容易理解。

  • "开始执行getUserInfo 方法，用户名[jimmy]"
  • "开始获取用户信息，用户名[jimmy]"

下面的这个Log对于框架的使用者提供了极大的帮助

  • "无法解析参数[12 03, 2013]，birthDay参数需要符合格式[yyyy-MM-dd]"

3.2.3 Log中的变量用[]与普通文本区分开来

把变量和普通文本隔离有这么几个作用

  • 在你阅读Log的时候容易捕捉到有用的信息
  • 在使用工具分析Log的时候可以更方便抓取
  • 在一些情况下不容易混淆

对比以下下面的两条Log，前者发生了混淆：

  • "获取用户lj12月份发邮件记录数"
  • "获取用户[lj1][2]月份发邮件记录数"

3.2.4 Error或者Warn级别中碰到Exception的情况尽量log 完整的异常信息

Error和Warn级别是比较严重的情况，意味着系统出错或者危险，我们需要更多的信息来帮助分析原因，这个时候越多的信息越有帮助。这个时候最好的做法是Log以下全部内容：

  • 你是在做什么事情的时候出错了
  • 你是在用什么数据做这个事情的时候出错了
  • 出错的信息是什么

对比下面三个Log语句，第一个提供了详尽的信息，第二个只提供了部分信息，Exception的Message不一定包含有用的信息，第三个只告诉你出错了，其他的你一无所知。

  • log.error("获取用户[{}]的用户信息时出错",userName,ex);
  • log.error("获取用户[{}]的用户信息时报错，错误信息：[{}]",userName,ex.getMessage());
  • log.error("获取用户信息时出错");

3.2.5 对于Exception，要每次都Log StackTrace吗？

在一些Exception处理机制中，我们会每层或者每个Service对应一个RuntimeException类，并把他们抛出去，留给最外层的异常处理层处理。典型代码如下:

try{
  
}catch(Exception ex){
  String errorMessage=String.format("Error while reading information of user [%s]",userName);
  logger.error(errorMessage,ex);
  throw new UserServiceException(errorMessage,ex);
}

这个时候问题来了，在最底层出错的地方Log了异常的StackTrace，在你把这个异常外上层抛的过程中，在最外层的异常处理层的时候，还会再Log一次异常的StackTrace，这样子你的Log中会有大篇的重复信息。

我碰到这种情况一般是这么处理的：Log之！原因有以下这几个方面：

  • 这个信息很重要，我不确认再往上的异常处理层中是否会正常的把它的StackTrace打印出来。
  • 如果这个异常信息在往上传递的过程中被多次包装，到了最外层打印StackTrace的时候最底层的真正有用的出错原因有可能不会被打印出来。
  • 如果有人改变了LogbackException打印的配置，使得不能完全打印的时候，这个信息可能就丢了。
  • 就算重复了又怎么样？都Error了都Warning了还省那么一点空间吗？
Architect_csdn
关注
专栏目录
Java程序员修炼之道 之 Logging(2/3) - 怎么写Log
紫风乱写
08-13 3774
本文介绍了在代码中应该在什么时候需要Log什么信息；使用何种级别的Log；如何Log异常信息；Log中的一些要点。另外也分析了静态Logger变量和对象Logger变量的优劣。
logger日志系统
TABE_的博客
10-05 660
logger日志系统设计logger日志系统实现logger日志系统lockqueue.hlogger.hlogger.cc 设计logger日志系统 图中画圆圈的是我们实现的mprpc框架，这个框架是给别人使用的，把本地的服务发布成远程的RPC服务，框架里最重要的两个成员就是RpcProvider和RpcChannel，他们在运行的过程中会有很多正常的输出信息和错误的信息，我们不可能都cout它们到屏幕上，因为运行时间长了，屏幕上输出的信息特别多，如果万一有什么问题，我们也不好定位，真正用起来的话不方便
Android日志框架
最新发布
qq_42111674的博客
08-26 458
此日志框架使用 Handler 机制，保证多线程下日志输出顺序不会乱。demo使用策略设计模式，降低代码的耦合程度。
Logger方法打印日志
qq_48313401的博客
11-19 2819
Logger方法打印日志以及几种格式
Logger的打印日志
mr-yhl的博客
11-08 2032
这里写自定义目录标题为什么要使用日志日志的级别在springboot项目中实现日志控制1.在pom文件中导入相关jar包2.在application.yml文件下日志级别控制：3.测试：4. 测试结果 为什么要使用日志 在开发的时候需要输出部分信息到控制台 相比较与print输出,日志可以控制级别 用日志的方式的,可以带有级别的关键字,便于分析 可以记录到日志文件中,供日后查阅 日志的级别 logger中提供了五个级别,由大到小分别是:DEBUG INFO WARNING ERROR CRITICA
使用logging模块打印日志
weixin_42176112的博客
02-11 925
logging模块是python里面用来操作日志的模块 logging模块中主要有4个类： Logger 记录器，暴露了应用程序代码能直接使用的接口； Handler 处理器，将（记录器产生的）日志记录发送至合适的目的地 StreamHandler 控制台输出 FileHandler 文件输出 TimedRotatingFileHandler 按照时间自动分割日志文件 RotatingFil...
Android-logger日志打印工具
08-13
"Android-logger日志打印工具"是一个专门为Android平台设计的日志库，它提供了比Android原生`Log`类更加强大、灵活和可定制的日志输出功能。下面将详细介绍这个工具的主要特性、使用方法以及它如何提升Android应用的...
java swing用Logger输出错误日志.docx
06-09
这篇文档主要讨论了如何在Java Swing应用中使用`Logger`来生成和管理错误日志。 `Logger`是Java的日志记录工具，它提供了多种级别（如SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST）来区分不同严重程度的...
利用logger拦截打印完整的okhttp网络请求和响应日志
yushuangping的博客
08-24 7244
最近项目中使用的网络请求工具是Retrofit，底层封装的是OkHttp，通常调试网络接口时都会将网络请求和响应相关数据通过日志的形式打印出来。OkHttp也提供了一个网络拦截器okhttp-logging-interceptor，通过它能拦截okhttp网络请求和响应所有相关信息（请求行、请求头、请求体、响应行、响应行、响应头、响应体）。 使用okhttp网络日志拦截器： impleme...
日志打印-Logger使用
zyl042的博客
01-19 1104
Import： import java.util.logging.*; import java.util.Date; import java.text.SimpleDateFormat; 主方法： 内部类是为了输出字符串； 不使用会生成xml格式内容； private Logger logger = Logger.getLogger(Log_true.class.getName()...
Logger-功能强大使用方便的Log日志打印工具类
李可乐的专栏
05-17 5481
介绍Android开发中Log日志打印对开发者来说是非常重要的功能。但是感觉Log写多了也是烦，每次都需要设置一个TAG过滤值和具体的打印信息，而且打印的信息也不够丰富。 这里我推荐一个功能强大的Log日志打印工具类-Logger。(不是java.util.logging.Logger，只是恰好同名而已)使用使用非常简单，直接调用静态类方法。提供Debug/Info/Error三个级别的打印方法。
Logger日志文件查看
12-30
.log文件查看， 日志文件查看 log工具，可以查看日志文件
日志参数打印LoggerFactory
热门推荐
xinpz的博客
02-11 1万+
1. 导入 slf4j 日志包 import org.slf4j.Logger; import org.slf4j.LoggerFactory; 2. 获取 slf4j 日志对象 private static Logger log = LoggerFactory.getLogger(XhPayController.class); 3. 日志打印 // 2.入参打印 log...
python logging 日志打印
咕噜咕噜
07-14 1805
日志 日志是跟踪软件运行时所发生的事件的一种方法。软件开发者在代码中调用日志函数，表明发生了特定的事件。事件由描述性消息描述，该描述性消息可以可选地包含可变数据（即，对于事件的每次出现都潜在地不同的数据）。事件还具有开发者归因于事件的重要性；重要性也可以称为级别或严重性。 logging提供了一组便利的函数，用来做简单的日志。它们是 debug()、 info()、 warning()、 error() 和 critical()。 logging函数根据它们用来跟踪的事件的级别或严重程度来命名。.
logger打印日志
上善若水的博客
12-27 1295
log4j中输入信息的级别有debug,info,warn,error,fatal 5个级别他们对应的是输出信息的级别,级别越低信息输入越详细.使用debug级别的时候,info中的信息也能输出 使用info的时候,debug对应的信息显示不出来一般在开发的时候使用debug, 开发完成后使用error 在实际应用中有很多库的信息都是由debug打印出来，所以如果你打开debug模式的话会看到
Apache Log4j2 API官方使用指南（一） —— Marker类怎么用
JayXu's Blog
05-03 5165
文章目录Markers Markers One of the primary purpose of a logging framework is to provide the means to generate debugging and diagnostic information only when it is needed, and to allow filtering of that in...
【转】最详细的Log4J使用教程一、入门实例二、Log4J基本使用方法三、Spring中使用Log4J四、实战经验总结
weixin_43721056的博客
04-11 1004
原文地址：http://www.codeceo.com/article/log4j-usage.html 日志是应用软件中不可缺少的部分，Apache的开源项目log4j是一个功能强大的日志组件,提供方便的日志记录。在apache网站：jakarta.apache.org/log4j可以免费下载到Log4j最新版本的软件包。 一、入门实例 1、 新建一个Java工程，导入Log4j包，pom文件中对应的配置代码如下： <!-- log4j support --> <dependency&g
logback（二）springboot配置日志文件格式、logback-spring配置文件详解、logback为日志自定义颜色【史上最详细】
lh155136的博客
07-05 6597
参考官网直达车logback（一）理论概述 logback（二）springboot配置日志文件格式、logback-spring配置文件详解 logback（三）mybatis-plus结合logback将sql语句输出到日志文件首先看一下，我们启动springboot项目默认会出现如下格式 当我们输出一行日志时，会打印如下日志 这个时候发现“哈哈哈”不知道是那个方法、哪行，我们就可以按照自己想要的格式来修改日志输出格式下面这个配置是可以直接使用的 logback-spring.xml文件，放到resou
SpringBoot日志配置
Zero_uou的博客
06-12 2006
一、日志文件的作用 日志，通常不会在需求阶段作为一个功能单独提出来，也不会在产品方案中看到它的细节。但是，这丝毫不影响它在任何一个系统中的重要的地位。 为了保证服务的高可用，发现问题一定要即使，解决问题一定要迅速，所以生产环境一旦出现问题，预警系统就会通过邮件、短信甚至电话的方式实施多维轰炸模式，确保相关负责人不错过每一个可能的bug。 预警系统判断疑似bug大部分源于日志。比如某个微服务接口由于各种原因导致频繁调用出错，此时调用端会捕获这样的异常并打印ERROR级别的日志，当该错误日志达到一定次数出
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值