first commit

This commit is contained in:
yangzhaohan
2026-06-22 15:53:41 +08:00
commit 568cb6bcd4
9 changed files with 173 additions and 0 deletions
+27
View File
@@ -0,0 +1,27 @@
# 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);
```
+11
View File
@@ -0,0 +1,11 @@
module: log
summary: 统一日志封装,提供结构化日志输出,屏蔽底层日志框架细节。
dos:
- 业务代码通过 LogUtil 输出日志,统一格式。
- 关键操作节点必须记录结构化日志(who / what / when / result)。
donts:
- 不要在业务代码中直接使用 SLF4J / Logback API。
- 日志中不要输出敏感信息(密码、Token 等)。
examples:
- path: src/main/java/{{basePkgPath}}/log/LogUtil.java
note: 日志工具入口。