关于java:别再乱打日志了这份-Java-日志规范应有尽有建议收藏

36次阅读

共计 8415 个字符，预计需要花费 22 分钟才能阅读完成。

1 简介

在程序中写日志是一件十分重要，然而很容易被开发人员漠视的中央。写好程序的日志能够帮忙咱们大大加重前期保护压力。在理论的工作中，开发人员往往迫于微小工夫压力，而写日志又是一个十分繁琐的事件，往往没有引起足够的器重。

开发人员应在一开始就养成良好的日志撰写习惯，并且应在理论的开发工作中为写日志预留足够的工夫。

1.1 日志的作用

个别程序日志出自上面几个方面的需要：

  1. 记录用户操作的审计日志，甚至有的时候就是监管部门的要求。
  2. 疾速定位问题的本源
  3. 追踪程序执行的过程。
  4. 追踪数据的变动
  5. 数据统计和性能剖析
  6. 采集运行环境数据

个别在程序上线之后，一旦产生异样，第一件事就是要弄清楚过后产生了什么。用户过后做了什么操作，环境有无影响，数据有什么变动，是不是重复产生等，而后再进一步的确定大抵是哪个方面的问题。确定是程序的问题之后再交由开发人员去重现、钻研、提出解决方案。这时，日志就给咱们提供了第一手的材料。

1.2 撰写日志的要求

既然撰写日志是有需要，而且也能在将来帮忙咱们进步工作效率的事件，久远来看是十分无利的一件事件。因而咱们应该在本人开发的程序中符合规范的撰写日志，在写日志时要留神以下的问题。

1.2.1 日志的可读性

日志时给人读的，不仅仅是让本人明确，也要让没有接触过咱们源代码的其余程序员也可能高深莫测。有的共事在日志中打印非凡的标识符号，例如“++++++++++”，“===========”，“—————”，这些符号令人目迷五色。这是一种不好的编程习惯。

另外，把日志分类输入到不同的文件也有利于咱们排除烦扰，迅速找到咱们须要的信息。而且，最好在打印日志时输入英文，避免中文不反对而打印出乱码的状况。

1.2.2 日志的性能

无论咱们把日志写到文件还是数据库，都须要耗费 IO 资源。适当的管制日志的输入也有利于进步程序的性能。

例如：尽量避免在在大的循环中打印意义不大的日志内容。输入日志之前最好能判断日志的级别 (例如. debug 前先调用isDebugEnabled() 作出判断)。

1.2.3 占用磁盘空间

通常，咱们都是把日志写入磁盘上的日志文件中。适当的应用滚动日志并且定时革除旧文件是有益处的。我见过这样一个例子，程序运行几次后就跑不起来了，前几次都是失常的。

怎么都想不明确程序有什么问题，最初才发现竟然是日志文件占满了磁盘空间。在理论的利用中呈现上 G 的日志文件也往往不少见，要在这样规模的日志文件中找出对解决问题有用的信息也是一大挑战。

1.2.4 日志的时效性

有的时候咱们并不能及时的发现问题。须要追溯之前的日志。所以咱们是须要保留一段时间以内的日志便于追溯。

1.2.5 日志级别

通常咱们在产品环境中日志的级别都在 INFO 以上，所以咱们必须保障在这样的状况下程序依然可能输入足够咱们作出判断的信息。

例如常见的零碎具备如下的日志级别：

// 定义 FATAL 级别输入宏
#define DRV_LOG_FATAL(fmt, ...)           hlog_format(HLOG_LEVEL_FATAL, "PluginDriver",   "[%s(%d)]"fmt, __FUNCTION__,   __LINE__, ##__VA_ARGS__)

// 定义 ERROR 级别输入宏
#define DRV_LOG_ERROR(fmt, ...)           hlog_format(HLOG_LEVEL_ERROR, "PluginDriver",   "[%s(%d)]"fmt, __FUNCTION__,   __LINE__, ##__VA_ARGS__)

// 定义 WARN 级别输入宏
#define DRV_LOG_WARN(fmt, ...)          hlog_format(HLOG_LEVEL_WARN, "PluginDriver",   "[%s(%d)]"fmt, __FUNCTION__,   __LINE__, ##__VA_ARGS__)  

// 定义 INFO 级别输入宏
#define DRV_LOG_INFO(fmt, ...)          hlog_format(HLOG_LEVEL_INFO, "PluginDriver",   "[%s(%d)]"fmt, __FUNCTION__,   __LINE__, ##__VA_ARGS__)  

// 定义 DEBUG 级别输入宏
#define DRV_LOG_DEBUG(fmt, ...)           hlog_format(HLOG_LEVEL_DEBUG, "PluginDriver",   "[%s(%d)]"fmt, __FUNCTION__,   __LINE__, ##__VA_ARGS__)   
// 定义 TRACE 级别输入宏
#define DRV_LOG_TRACE(fmt,   ...)         hlog_format(HLOG_LEVEL_TRACE, "PluginDriver",   "[%s(%d)]"fmt, __FUNCTION__,   __LINE__, ##__VA_ARGS__)

上述的日志文件中定义了 6 种日志级别，不同级别的含意在下文详述，须要理解到在一个程序开发的过程中须要保护不同的别离为FATAL，ERROR，EARN，INFO，DEBUG，TRACE。

1.2.6 日志内容

咱们在写日志的时候，须要留神输入适当的内容。首先，尽量应用业务相干的形容。咱们的程序是实现某种业务的，那么就最好能形容分明这个时候走到了业务过程的哪一步。

其次，防止在日志中输入一些敏感信息，例如用户名和明码。以及，要放弃编码的统一。如果不能保障就尽量应用英文而不是中文。这样当咱们拿到日志之后就不会因为看到一堆乱码而不知所云了。

1.2.7 日志格局

常见的日志格局中对于每一条日志应含有的信息包含日期、工夫、日志级别、代码地位、日志内容、错误码等信息。

上面是一个工作中的日志文件的一部分内容：

2018-05-22 15:35:53.850 TRACE TDWZLog [0x00001b10] <36> <TDWZProtocol::Init>,TDWZProtocol::Init
2018-05-22 15:35:53.850 TRACE TDWZLog [0x00001b10] <89> <TDWZProtocol::Init>,End in processing TDWZProtocol::Init
2018-05-22 15:35:53.853 TRACE TDWZLog [0x00001b10] <142>    <TDWZProtocol::Connect>,Connect Execute finish
2018-05-22 15:35:53.853 TRACE TDWZLog [0x00002f10] <149>    <GetAlarmEventPro>,Enter GetAlarmEventPro func
2018-05-22 15:39:36.382 WARN TrackLog [0x000029fc] - [internal WARN htrace_server_convert_msgstring_to_contextintls(493) ] detect input id error, trace_id span_id,this chain may not be tracked.
2018-05-22 15:39:36.383 WARN TrackLog [0x000029fc] - [internal WARN htrace_server_receive(195) ] can not detect trace_id in context, this chain may not be tracked.
2018-05-22 15:39:36.383 TRACE TDWZLog [0x000029fc] <231>    <TDWZProtocol::DisConnect>,TDWZProtocol::DisConnect
2018-05-22 15:39:37.502 TRACE TDWZLog [0x00002f10] <225>    <GetAlarmEventPro>,End Get AlarmEventPro Func
2018-05-22 15:39:37.503 TRACE TDWZLog [0x000029fc] <241>    <TDWZProtocol::DisConnect>,close socket
2018-05-22 15:39:37.503 TRACE TDWZLog [0x000029fc] <242>    <TDWZProtocol::DisConnect>,Execute DisConnect function succeed.

能够从该文件中看出个别日志文件中应该含有的信息。

2 日志级别和含意

Log4j 是 Apache 的一个开源我的项目，通过应用 Log4j，咱们能够管制日志信息输入目的地是控制台、文件、GUI 组件甚至是套接口服务器；咱们也能够管制每一条日志的输入格局；通过定义每一条日志信息的级别，咱们可能更加粗疏地管制日志的生成过程。

最令人感兴趣的就是，这些能够通过一个配置文件来灵便地进行配置，而不须要批改利用的代码。

2.1 Log4j 的组成

Log4j 由三个重要的组成形成：日志记录器 (Loggers)，输入端(Appenders) 和日志格式化器(Layout)。

2.1.1 Logger

管制要启用或禁用哪些日志记录语句，并对日志信息进行级别限度

2.1.2 Appenders

指定了日志将打印到控制台还是文件中.

2.1.3 Layout

管制日志信息的显示格局。

2.2 日志级别

Log4j 中将要输入的 Log 信息定义了 6 种级别，顺次为TRACE、DEBUG、INFO、WARN、ERROR 和 FATAL，当输入时，只有级别高过配置中规定的 级别的信息能力真正的输入，这样就很不便的来配置不同状况下要输入的内容，而不须要更改代码，十分方便快捷。

2.2.1 TRACE

TRACE designates finer-grained informational events than the DEBUG.Since:1.2.12，很低的日志级别，个别不会应用。TRACE 个别跟踪的是函数的调用，并且 TRACE 不应该含有变量参数，而仅能提醒函数的调用关系。

2.2.2 DEBUG

个别用于细粒度级别上，对调试应用程序十分有帮忙，次要用于开发过程中打印一些运行信息。

2.2.3 INFO

INFO 音讯在粗粒度级别上突出强调应用程序的运行过程。打印一些你感兴趣的或者重要的信息，这个能够用于生产环境中输入程序运行的一些重要信息，然而不能滥用，防止打印过多的日志。

2.2.4 WARN

WARN 示意会呈现潜在谬误的情景，有些信息不是错误信息，然而也要给程序员一些提醒。该级别示意程序会主动调整到失常的状态，相似参数未传入，应用了默认的参数，仍合乎程序员预期之内的状况。

2.2.5 ERROR

ERROR 指出尽管产生谬误事件，但依然不影响零碎的持续运行。打印谬误和异样信息，如果不想输入太多的日志，能够应用这个级别。个别在 WARN 之后的级别在打印谬误时，应该同时打印错误码。

2.2.6 FATAL

FATAL 指出每个重大的谬误事件将会导致应用程序的退出，这个级别比拟高，重大谬误，程序无奈复原，必须通过重启程序来解决。

2.3 日志级别大小关系

日志级别就像开关一样，来决定哪些日志办法被调用，哪些不被调用。在 log4j 中，日志级别的关系如下所示：

ALL<TRACE<DEBUG<INFO<WARN<ERROR<FATAL<OFF

设置了对应的级别之后，日志框架就只调用大于等于这个级别的办法。Log4j 倡议只应用如下的四个界别

DEBUG<INFO<WARN<ERROR

3 日志标准示例

模拟，缮写是比拟好的学习形式，借鉴前人撰写日志的良好格调以造成本人的格调是不错的形式。上面是一些不错的日志记录。

3.1 TRACE 日志记录示例

DRV_LOG_TRACE("Connect Execute start");
DRV_LOG_TRACE("Connect Execute finish");
DRV_LOG_TRACE("DisConnect func");
DRV_LOG_TRACE("Execute DisConnect function succeed.");
DRV_LOG_TRACE("Enter UploadEvent Func");
DRV_LOG_TRACE("extInfo = %s", Extension);
DRV_LOG_TRACE("Send a Msg");
DRV_LOG_TRACE("- Connect Execute start");
DRV_LOG_TRACE("- Connect Execute finish");
DRV_LOG_TRACE("- Enter GetAlarmEventPro func");
DRV_LOG_TRACE("- Receive an info");
DRV_LOG_TRACE("- End Get AlarmEventPro Func");
DRV_LOG_TRACE("- DisConnect func");
DRV_LOG_TRACE("- Execute DisConnect function succeed.");
DRV_LOG_TRACE("- Enter UploadEvent Func");
DRV_LOG_TRACE("- Leave UploadEvent Func");
DRV_LOG_TRACE("- ============ 电网报警触发");
DRV_LOG_TRACE("- ============ 开始发送电流电压值");
DRV_LOG_TRACE("- ============ 距离超过分钟再次发送电流电压值");

3.2 INFO 日志记录示例

DRV_LOG_INFO("- UpdataEvent  nchal= %d,EventID = %d.",iChannelNo,nEventType);
DRV_LOG_INFO("- do not support doControl");
DRV_LOG_INFO("- channelId = %s, nStatusType = %d", channelId.c_str(), nStatusType);

3.3 DEBUG 日志记录示例

DRV_LOG_DEBUG("- 输入报警状况: 电网编号:%d, 报警数量:%d, 报警内容:%s.",datas.data1.chn,datas.data1.alarm_num,datas.data1.alarms);
DRV_LOG_DEBUG("- 输入报警状况: 电网编号:%d, 报警数量:%d, 报警内容:%s.",datas.data2.chn,datas.data2.alarm_num,datas.data2.alarms);
DRV_LOG_DEBUG("- 输入报警状况: 电网编号:%d, 报警数量:%d, 报警内容:%s.",datas.data3.chn,datas.data3.alarm_num,datas.data3.alarms);
DRV_LOG_DEBUG("- 输入报警状况: 电网编号:%d, 报警数量:%d, 报警内容:%s.",datas.data4.chn,datas.data4.alarm_num,datas.data4.alarms);
DRV_LOG_DEBUG("- ============datas.data1.huab = %d",datas.data1.huab);
DRV_LOG_DEBUG("- ============datas.data1.hiab = %d",datas.data1.hiab);
DRV_LOG_DEBUG("- ============datas.data2.huab = %d",datas.data2.huab);
DRV_LOG_DEBUG("- ============datas.data2.hiab = %d",datas.data2.hiab);
DRV_LOG_DEBUG("- ============datas.data3.huab = %d",datas.data3.huab);
DRV_LOG_DEBUG("- ============datas.data3.hiab = %d",datas.data3.hiab);
DRV_LOG_DEBUG("- ============datas.data4.huab = %d",datas.data4.huab);
DRV_LOG_DEBUG("- ============datas.data4.hiab = %d",datas.data4.hiab);
DRV_LOG_DEBUG("- Alarm is : %s",szEvent.c_str());
DRV_LOG_DEBUG("- GetChannelExtInfo channelId=%s", channelId.c_str());
DRV_LOG_DEBUG("- nChan = %d, szInfo = %s", nChan, szInfo);

3.4 WARN 日志记录示例

DRV_LOG_WARN("[0x%08x] - invaild event msg,discard it", DRV_INVALID_ARG);
DRV_LOG_WARN("[0x%08x] - Can't find channel by channelId");
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x]Connect device failed", DRV_CONNECT_FAILED, sdkErrCode);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x]dw_start_receive failed", DRV_ERROR, sdkErrCode);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x]Communicate failed, socket recv error", DRV_ERROR, DW_SOCKET_RECV_ERROR);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x>other error", DRV_ERROR, iGetResult);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x>other error", DRV_ERROR, iGetResult);
DRV_LOG_WARN("[0x%08x] - SetEventCallBack should be called first", DRV_ERROR);

3.5 ERROR 日志记录示例

DRV_LOG_ERROR("Init DwSDK filded;<errCode=%d>", initRet); 
DRV_LOG_ERROR("Connect device failed");
DRV_LOG_ERROR("Create thread failed");
DRV_LOG_ERROR("dw_start_receive failed");
DRV_LOG_ERROR("Communicate failed, socket recv error");
DRV_LOG_ERROR("other error<errCode=%d>", iGetResult);
DRV_LOG_ERROR("SetEventCallBack should be called first");

DRV_LOG_ERROR("[0x%08x] - [DWSdk.errorcode=0x%08x]Init DwSDK filded", DRV_INIT_FAILED, initRet);
DRV_LOG_ERROR("- [HPR.errorcode=0x%08x]Create thread failed", HPR_GetLastError());

上述代码中 [0x%08x] 有下述作用：

该语句呈现于格式化输入时的格局字符串中。模式为

"0x%08x"

其中，0x为一般字符，输入的时候会原样输入为0x。

%08x为整型以 16 进制形式输入的格局字符串，会把后续对应参数的整型数字，以 16 进制输入。08 的含意为，输入的 16 进制值占 8 位，有余局部左侧补 0。

于是，如果执行

printf("0x%08x", 0x1234);

会输入0x00001234。

版权申明：本文为 CSDN 博主「思影影思」的原创文章，遵循 CC 4.0 BY-SA 版权协定，转载请附上原文出处链接及本申明。原文链接：https://blog.csdn.net/lk14250…

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2022 最新版)

2. 劲爆！Java 协程要来了。。。

3.Spring Boot 2.x 教程，太全了！

4. 别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

正文完
java
发表至： java
2022-08-12
 0
Spring Cloud 参考文档（Spring Cloud Config快速入门）
关于java:跨域实现
关于java:如何实现一个简易版的-Spring-如何实现-Constructor-注入
关于java:Java中如何使用日志库在代码中添加日志