TypeScript 如何遍历 license-checker 输出 JSON 并解析为 JsonData 对象列表
TypeScript 解析 license-checker 输出 JSON 并生成指定类型列表的实现
场景说明
license-checker 输出的 JSON 为扁平化键值对结构:
- 根节点是普通对象,键为带版本号的包全标识(例如
@angular/core@10.1.4) - 每个键对应的值,匹配你已定义的
JsonData接口描述的包元信息
由于根节点不是数组结构,无法直接作为列表处理,需要先提取对象的所有属性值。
实现步骤
1. 补全类型定义
你已经定义了单条包信息的 JsonData 接口,还需要为整个根JSON对象补充类型定义,避免TypeScript类型推导报错:
export interface JsonData { licenses: string; repository: string; publisher: string; name: string; version: string; description: string; licenseFile: string; licenseText: string; path: string; } // 根JSON对象的类型:任意字符串为键,值为JsonData结构 type RawLicenseJson = Record<string, JsonData>;
2. 提取值生成类型化列表
使用内置的 Object.values() 方法是最便捷的实现方式,该方法会返回传入对象所有自身可枚举属性值组成的数组,完全匹配 JsonData[] 的类型要求:
// 假设已拿到license-checker输出的原始JSON字符串 const rawJsonString = '{"@angular/core@10.1.4":{...},...}'; // 解析JSON并做类型断言 const parsedJson = JSON.parse(rawJsonString) as RawLicenseJson; // 直接提取所有值,得到类型化的包信息列表 const licenseList: JsonData[] = Object.values(parsedJson);
3. 可选:保留原始包全标识
如果后续逻辑需要用到根对象上的键值(例如 @angular/core@10.1.4),可以使用 Object.entries() 拿到键值对后映射生成列表项:
// 扩展接口,新增包全标识字段 export interface LicenseItemWithId extends JsonData { fullPackageId: string; } const licenseListWithId: LicenseItemWithId[] = Object.entries(parsedJson).map( ([pkgFullId, pkgInfo]) => ({ fullPackageId: pkgFullId, ...pkgInfo }) );
注意事项
JSON.parse默认返回any类型,类型断言仅在确认JSON结构与接口定义匹配时使用;如果需要更高健壮性,可以在遍历过程中增加少量运行时校验,检查每个包对象是否存在必填字段,避免个别异常包导致后续逻辑报错。- 不要使用
for...in语法遍历该对象,它会顺带遍历对象原型链上的可枚举属性,相比之下Object.values/Object.entries仅遍历对象自身属性,更安全高效。 - 如果是本地读取license-checker生成的JSON文件,只需要通过文件系统API读取文件内容得到字符串后,走上述解析流程即可,无额外差异。
内容的提问来源于stack exchange,提问作者betaros
相关产品推荐
相关产品推荐

