日志输出最佳实践

博主： zhaojun
发布时间：2022 年 12 月 12 日
1200 次浏览
暂无评论
2230字数
分类：默认分类

## 在动作后打日志

```java
// don't do that
log.info("Making request to REST API")
restClient.makeRequest()

// do that
restClient.makeRequest()
log.info("Made request to REST API")
```

第一个例子是反例，这个日志无法说明 REST 调用是否成功，你可能会看到日志输出，并在之后抛出了一个日志，可能会对查看日志的人造成困惑，不知道到底调用成功没。

第二个例子为正例，如果业务代码运行正常会输出日志，反之会抛出异常，同时日志也不会打印。

> INFO 格式的日志适用此规则，DEBUG 模式还有例外，会在下面介绍。

## 分离参数和日志信息

```java
// don't do that
restClient.makeRequest()
log.info("Made request to {} on REST API.", url)

// do that
restClient.makeRequest()
log.info("Made request to REST API. [url={}]", url)
```

日志有两部分，一部分是人工写的帮助判断状态的提示信息，另一部分是实际操作中的参数。
第一个例子中，不容易区分参数到底是哪个，尤其当日志较长时，可读性会大大降低。
第二个例子中，可更清晰的查看参数信息，且便于使用一些表达式解析参数。

## 区分 WARNING 和 ERROR

简单来说，两者的区别为：
- `WARNING`：做了某些操作，但是有问题。
- `ERROR`：做了某些操作，但压根没起作用或压根无法做。

如：

```java
try {
    restClient.makeRequest()
    log.info("Made request to REST API. [url={}]", url)
} catch(e: UnauthorizedException) {
    log.warn("Request to REST API was rejected because user is unauthorized. [url={}, result={}]", url, result)
} catch(e: Exception) {
    log.error("Request to REST API failed. [url={}, exception={}]", url, exception)
}
```

REST 调用可能具有以下三种结果：
- 它可以正常工作，这是 INFO 级别的（在工作后）
- 它可能会造成一些预期的异常，这是 WARNING 级别的。
- 它可能因出现预期外位置的异常导致失败，这是 ERROR 级别的。

> 注意：当 WARNING 和 ERROR 在无需处理时，不应该记录。如 Java 中 ClientAbortException 异常，一般来说是不需要处理的

## 业务使用 INFO、技术使用 DEBUG

INFO 日志应该像一本书，它应该告诉你发生了什么：
```java
INFO  | User registered for newsletter. [user="Thomas", email="thomas@tuhrig.de"]
INFO  | Newsletter send to user. [user="Thomas"]
INFO  | User unsubscribed from newsletter. [user="Thomas", email="thomas@tuhrig.de"]
```
DEBUG 日志应该描述发生该过程的工作原理：

```java
DEBUG | Saved user to newsletter list. [user="Thomas", email="thomas@tuhrig.de"]
DEBUG | Send welcome mail. [user="Thomas", email="thomas@tuhrig.de"]
INFO  | User registered for newsletter. [user="Thomas", email="thomas@tuhrig.de"]
DEBUG | Started cron job to send newsletter of the day. [subscribers=24332]
INFO  | Newsletter send to user. [user="Thomas"]
INFO  | User unsubscribed from newsletter. [user="Thomas", email="thomas@tuhrig.de"]
```

## 参考链接

- https://tuhrig.de/my-logging-best-practices/

最后修改：2022 年 12 月 12 日

如果觉得我的文章对你有用，请我喝杯咖啡吧。

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

评论 *

私密评论

名称 *

🎲

邮箱 *

地址

日志输出最佳实践

zhaojun • 2022 年 12 月 12 日

## 在动作后打日志

```java
// don't do that
log.info("Making request to REST API")
restClient.makeRequest()

// do that
restClient.makeRequest()
log.info("Made request to REST API")
```

第二个例子为正例，如果业务代码运行正常会输出日志，反之会抛出异常，同时日志也不会打印。

> INFO 格式的日志适用此规则，DEBUG 模式还有例外，会在下面介绍。

## 分离参数和日志信息

```java
// don't do that
restClient.makeRequest()
log.info("Made request to {} on REST API.", url)

// do that
restClient.makeRequest()
log.info("Made request to REST API. [url={}]", url)
```

## 区分 WARNING 和 ERROR

简单来说，两者的区别为：
- `WARNING`：做了某些操作，但是有问题。
- `ERROR`：做了某些操作，但压根没起作用或压根无法做。

如：

> 注意：当 WARNING 和 ERROR 在无需处理时，不应该记录。如 Java 中 ClientAbortException 异常，一般来说是不需要处理的

## 业务使用 INFO、技术使用 DEBUG

## 参考链接

- https://tuhrig.de/my-logging-best-practices/

日志输出最佳实践

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

谈裸辞和开源的体会

剑指 Offer 04. 二维数组中的查找

宝塔 nginx 增加编译模块

通过 Github Actions 自动构建 ZFile 镜像并推送到 Docker Hub

优化 Java 项目 Docker 镜像内存占用从 500 M 到 100M

vue 或 react 动态加载混合 JavaScript 片段

一款基于 Shiro 的权限管理系统，支持 restful 风格 URL.

Spring Boot 统一异常处理最佳实践 -- 拓展篇

Spring 使用事件监听来解耦代码

Spring 如何获取 AOP 代理类的实际对象 Class

日志输出最佳实践

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

日志输出最佳实践

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款