TypeScript如何实现带泛型约束的日志方法避免魔法值?
日志泛型封装实现方案
核心需求
- 支持后续灵活新增日志级别、日志字段
- 强制类型校验,开发者只能使用预定义的日志字段和级别,避免魔法数字/魔法字符串
- 不同日志场景可传入对应结构的参数,有完善的类型提示
原有实现问题说明
之前用枚举存储日志字段的方案无法运行,核心原因是:枚举的成员是只读的常量,调用log方法时写的entries.user_id = 123本质是尝试修改枚举成员的值,而非传递user_id:123的键值对参数,不符合语法规则。
正确实现代码
1. 基础定义
// 日志级别枚举,预定义所有允许的日志级别 enum LogLevel { error, info } // 预定义所有允许的日志字段及对应类型,后续新增字段只需要在这里扩展 interface AllowedLogFields { user_id: number; service_name: string; // 后续新增字段直接加在这里即可 // request_id: string; // cost_time: number; }
2. 泛型日志方法实现
// 泛型约束:传入的参数必须是AllowedLogFields的子集,同时指定日志级别 function log<T extends Partial<AllowedLogFields>>(level: LogLevel, params: T) { // 内部打印逻辑,比如把级别和参数合并打印 console.log(`[${LogLevel[level]}]`, JSON.stringify(params)); }
3. 调用示例
// 传user_id的场景,类型自动校验,只能传AllowedLogFields里有的字段 log(LogLevel.info, { user_id: 123 }); // 传service_name的场景 log(LogLevel.error, { service_name: 'my_service_name' }); // 传多个字段也支持 log(LogLevel.info, { user_id: 456, service_name: 'order_service' }); // 错误写法会直接报错:比如传未定义的字段、字段类型不对 // log(LogLevel.info, { unknown_field: 'xxx' }); // 编译报错 // log(LogLevel.info, { user_id: '123' }); // 类型不匹配报错
扩展说明
如果需要区分不同场景的日志固定字段,可以再定义不同场景的日志类型:
// 用户行为日志固定字段 interface UserActionLog extends Partial<AllowedLogFields> { user_id: number; // 强制必须传user_id action_type: string; } // 服务监控日志固定字段 interface ServiceMonitorLog extends Partial<AllowedLogFields> { service_name: string; // 强制必须传service_name cost: number; } // 对应重载泛型方法或者单独封装调用即可
内容的提问来源于stack exchange,提问作者Mohsen
相关产品推荐
相关产品推荐

