yangzhaohan
28 lines
640 B
Markdown
28 lines
640 B
Markdown
# brick-common-log 编码规范
|
|
|
|
## 职责边界
|
|
|
|
log 模块提供统一的结构化日志封装，业务代码通过 `LogUtil` 输出日志，不直接依赖 SLF4J/Logback。
|
|
|
|
## 使用准则
|
|
|
|
- 日志统一通过 `LogUtil` 输出。
|
|
- 关键操作（增删改、外部调用）必须记录结构化日志。
|
|
- 禁止在日志中输出密码、Token、手机号等敏感信息。
|
|
|
|
## 正例
|
|
|
|
```java
|
|
LogUtil.info("user.login", "userId", userId, "ip", ip);
|
|
```
|
|
|
|
## 反例
|
|
|
|
```java
|
|
// 直接使用 SLF4J
|
|
logger.info("user {} logged in from {}", userId, ip);
|
|
|
|
// 日志输出敏感信息
|
|
LogUtil.info("user.login", "password", password);
|
|
```
|