文章目录
选择合适的日志等级
在开发中我们有常见的四种日志打印等级,debug、info、warn、error,要选择合适的等级打印,不要上来直接 info。
- error: 错误日志,指比较严重的问题,会对系统和有业务造成伤害。运维监控重点关注。
- warn: 警告日志,不会对系统运行造成大的影响,一般由开发人员关注。
- info: 关键日志,为了保留系统运行关键指标,比如函数的入参、出参,时间等信息。
- debug: 开发日志,在开发调试阶段,记录对象数据在关键处理步骤中的变化情况、快速定位。
要打印函数的入参、出参
记录日志并不是要把所有信息都记录下来,那日志存储就要大到上天。我们只记录关键有效的日志,有效日志才是 battle 🆚 时杀手锏。
哪些算是有效日志?比如函数的入口处,打印入参,还包括用户唯一标识 (uid)、链路标识 (traceId) 等。函数出口打印返回值及时间等。
public String GetName(Request req, Integer id){
log.debug("method start param: {}", req.UserID);
String name = "JavaPub";
log.debug("method end result: {}", name);
return name;
}
打印日志对象要做判空处理,避免阻断流程
为了打印一行日志,程序写挂了。空指针异常在任何代码中都是最常见的异常之一。
反例:当 book 对象是 NULL 的话,这行日志就会抛空指针异常。
public void doSome(Book book){
log.info("do do and print log: {}". book.getName());
// do something...
...
}
不要使用日志系统的(Log4j、Logback),要使用 Slf4j
Slf4j 是使用门面模式的日志框架,可以解耦具体的日志实现。可以在不修改代码的情况下,更换底层的日志框架。
正例:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(JavaPub.class);
对低级别的日志输出,必须进行日志级别开关判断
对于 trace、debug、info 这些比较低的日志级别,必须进行日志级别开关。
正例:
开关判断逻辑通常放在日志工具类中。
public void doSomething(){
User user = new User(1, "技术自媒体", "JavaPub");
if (logger.isDebugEnabled()) {
logger.debug("print debug log. 666 is {}", user.getName());
}
}
反例:
public void doSth(){
String name = "JavaPub";
logger.trace("print debug log" + name);
logger.debug("print debug log" + name);
logger.info("print info log" + name);
// 业务逻辑
...
}
当日志级别是 warn 时,以上日志不会打印,但是会执行字符串拼接操作,如果打印值是对象的话,还会执行 toString()
方法,浪费了系统资源,因此建议加上日志开关判断。
不要用e.printStackTrace()打印日志
反例:
public void doSomething(){
try{
// 业务代码
...
} catch (Exception e){
e.printStackTrace();
}
}
e.printStackTrace()
打印出的日志包含堆栈信息,导致我们的日志信息不规整、增加定位问题的难度。如果使用 ELK 分析日志也会非常困难。e.printStackTrace()
语句产生的字符串记录的是堆栈信息,如果信息太长太多,字符串常量池所在的内存块没有空间了,即内存满了,系统请求也将被阻塞。
正例:
public void doSomething(){
try{
// 业务逻辑
...
} catch (Exception e){
log.error("程序异常 failed", e);
}
}
打印全部的异常信息,方便定位问题
反例:
没有打印系统异常 e
,无法定位出现了什么类型的异常。
public void doSth(){
### 最后
不知道你们用的什么环境,我一般都是用的Python3.6环境和pycharm解释器,没有软件,或者没有资料,没人解答问题,都可以免费领取(包括今天的代码),过几天我还会做个视频教程出来,有需要也可以领取~
给大家准备的学习资料包括但不限于:
Python 环境、pycharm编辑器/永久激活/翻译插件
python 零基础视频教程
Python 界面开发实战教程
Python 爬虫实战教程
Python 数据分析实战教程
python 游戏开发实战教程
Python 电子书100本
Python 学习路线规划
![](https://img-blog.csdnimg.cn/d29631674929476f9c3b30f7ff58dff0.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaTM0Nzc5NTc5MA==,size_16,color_FFFFFF,t_70)
**网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。**
**[需要这份系统化学习资料的朋友,可以戳这里无偿获取](https://bbs.csdn.net/topics/618317507)**
**一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!**