📝 docs(logging): update logging examples to show direct usage pattern
- 修改前后端日志示例,移除集中式logger对象 - 展示在使用处直接引入debug并定义命名空间的方式 - 添加具体的日志使用示例代码 - 简化日志使用流程,避免额外的工具类依赖
This commit is contained in:
@@ -29,28 +29,34 @@ k8s:deployment:create # K8S-部署-创建
|
||||
|
||||
### 前端示例
|
||||
```typescript
|
||||
// src/client/utils/logger.ts
|
||||
// 在需要使用日志的文件中直接引入debug
|
||||
import debug from 'debug';
|
||||
|
||||
export const logger = {
|
||||
error: debug('frontend:error'),
|
||||
api: debug('frontend:api'),
|
||||
auth: debug('frontend:auth'),
|
||||
ui: debug('frontend:ui')
|
||||
};
|
||||
// 按需定义命名空间
|
||||
const errorLogger = debug('frontend:error');
|
||||
const apiLogger = debug('frontend:api');
|
||||
const authLogger = debug('frontend:auth');
|
||||
const uiLogger = debug('frontend:ui');
|
||||
|
||||
// 使用示例
|
||||
errorLogger('用户登录失败: %s', error.message);
|
||||
apiLogger('API请求: %s', url);
|
||||
```
|
||||
|
||||
### 后端示例
|
||||
```typescript
|
||||
// src/server/utils/logger.ts
|
||||
// 在需要使用日志的文件中直接引入debug
|
||||
import debug from 'debug';
|
||||
|
||||
export const logger = {
|
||||
error: debug('backend:error'),
|
||||
api: debug('backend:api'),
|
||||
db: debug('backend:db'),
|
||||
middleware: debug('backend:middleware')
|
||||
};
|
||||
// 按需定义命名空间
|
||||
const errorLogger = debug('backend:error');
|
||||
const apiLogger = debug('backend:api');
|
||||
const dbLogger = debug('backend:db');
|
||||
const middlewareLogger = debug('backend:middleware');
|
||||
|
||||
// 使用示例
|
||||
errorLogger('数据库连接失败: %s', error.message);
|
||||
dbLogger('查询执行: %s', sql);
|
||||
```
|
||||
|
||||
## 5. 最佳实践
|
||||
|
||||
Reference in New Issue
Block a user