一、名词解释
代码影响面(Code Impact Analysis)
是指在代码变更后,分析这些变更对系统中其他部分的影响范围。它帮助开发团队理解代码修改的潜在影响,从而减少意外问题并提高代码质量。
模块级
是指以模块(Module)为单位的代码组织、分析和管理的粒度。模块是代码的基本单元,通常包含一组相关的功能,可以是 JavaScript 文件、UI 组件、页面或其他功能单元。
二、背景 & 价值
在过往交易域稳定性建设中,我们完成了多项关键工作,包括后台应用拆分、历史债务重构、权限配置管控和核心H5页面定期巡检任务等。此外,我们还整合了前端监控平台的各类异常数据分析与告警能力,帮助提前发现系统性风险,以提升系统的整体稳定性。
通过对于以往故障案例的复盘,我们也识别出一些导致系统稳定性问题的潜在隐患,尤其是随着业务复杂度提升,单个版本往往涉及大量页面改动和复杂的依赖关系。现有的影响面评估方式难以全面覆盖这些变更,在这种情况下容易导致出现生产问题时止血时间的拉长,影响了系统的稳定性和用户体验。
在迭代发布视角下,代码影响面的分析尤为重要。每次迭代发布通常涉及多个功能或模块的更新,而这些更新可能会对系统的其他部分产生直接或间接的影响。
问题梳理
风险评估滞后
依赖人工经验判断改动影响面,在涉及多人协作和多个模块的团队开发或Monorepo等复杂场景下尤其低效。
信息维度割裂
现有研发协同平台以需求为纬度聚合研发相关信息,而前端稳定性保障则更需要以页面为纬度聚合迭代相关信息。
变更追踪困难
关键变更信息散落在群聊或各个系统中,缺乏一个统一的平台来聚合这些信息,导致信息同步和协作效率低下。
因此,我们希望实现一套自动化收集模块级代码影响面分析的方案,并以此评估版本需求发布对于系统整体稳定性的影响,从而提前确保重点模块能够得到有效的预警和监控,并创建相应的预案计划。
价值收益
研发自测能力提升
能够更精准地识别更改影响的页面或模块,确保需求影响范围符合预期。
测试覆盖率优化
结合变更影响,确保关键路径的完整测试,提升测试的有效性和覆盖率。
评估系统复杂度
有助于全面评估版本发布影响面范围;对系统各业务模块进行合理资源分配。
三、技术方案
代码影响面分析的完整方案分为多个关键步骤,通过这些步骤可以实现自动化收集模块级代码影响面分析,并评估版本需求发布对系统整体稳定性的影响。
具体可以参考下面的流程图了解👇:
详细设计
影响面分析引擎
通过结合代码变更、依赖关系、业务逻辑等多维度数据,帮助开发团队快速识别和评估代码修改的潜在影响,从而减少生产问题的发生,提升系统的稳定性和代码质量。
※ 依赖关系图构建
- 使用静态分析工具分析项目中模块的依赖关系
- 根据项目类型分别构建依赖关系图
- 展示变更模块对其他模块的影响路径
※ 代码变更分析
- 使用版本对比工具分析代码变更
- 基于DIFF数据,统计变更的函数和变量
- 根据依赖关系图,初步分析变更的影响范围
※ 影响范围标记
- 从变更点出发,追踪调用路径,标记所有受影响的节点
- 将影响范围分为模块、功能、接口和数据四类
- 解析文件路由信息,输出页面列表
根据简化后的代码,可以快速理解核心功能的实现原理。
class CodeEffectAnalyzer { private fileImports: { [key: string]: FileImport[] };
// 收集文件的导入依赖 private collectImports(filePath: string, ast: any): void { traverse(ast, { ImportDeclaration: ({ node }) => { // 记录导入关系 node.specifiers.forEach((specifier) => { this.fileImports[filePath].push({ filePath: path.resolve(path.dirname(filePath), node.source.value), importedName: specifier.imported.name, localName: specifier.local.name, }); }); }, }); }
// 分析文件,提取导出变量和函数 private analyzeFile(filePath: string): FileDetails { const exports: FileExports = {};
// 遍历 AST,提取导出项 traverse(ast, { ExportDefaultDeclaration: (path) => { exports['default'] = generate(path.node).code; }, ExportNamedDeclaration: (path) => { const declaration = path.node.declaration; exports[declaration.id.name] = generate(path.node).code; }, }); return { exports }; } // 影响面分析检索 public analyzeImpact(affectedFiles: string[]): AffectedResult { const analyzeImpactRecursive = (filePath: string): void => { const { exports } = this.analyzeFile(filePath); const modifiedList = Object.keys(exports); // 假设所有导出项都被修改 const referencedList: string[] = []; // 找出引用了修改项的代码 for (const imported of this.fileImports[filePath] || []) { if (modifiedList.includes(imported.importedName)) { referencedList.push(imported.localName); analyzeImpactRecursive(imported.filePath); // 递归分析影响面 } } }; // 分析每个受影响文件 for (const file of affectedFiles) { analyzeImpactRecursive(file); } }}
平台数据聚合
在各个系统平台之间实现系统稳定性数据的一致性和实时更新,以确保各个部分能够获取最新的、准确的信息,进一步实现高效协作和准确分析。
※ 天网权限系统对接
- 获取菜单层级结构和页面路径信息,支持功能权限配置校验
- 数据扁平化转换,微前端场景下提取子应用标识
※ 研发协同平台同步
- 获取迭代需求效能数据,进行汇总与计算
- 建立需求任务与代码模块的关联
※ 前端监控平台集成
- 获取页面性能指标(首屏加载时间-FCP、接口响应耗时)、异常数据(JS异常数、接口成功率)以及流量数据(页面访问量-PV、页面访问数-UV)
- 数据清洗工作(异常值过滤、重复数据移除),数据格式标准化
结果信息可视化
将代码变更的影响范围以直观、易懂的图形或图表形式展示出来,并嵌入研发生命周期,帮助开发团队快速理解变更的潜在影响,并做出相应的决策。
※ 使用可视化工具
- 通过图形化界面直观展示代码变更的影响范围,降低理解门槛
- 交互联动,点击不同模块直接跳转至关联的平台详情页
※ 生成多维报告
- 从多个核心维度分析影响面指标
- 提供各维度的分析数据填充至报告模版
※ 集成 CI/CD 流程
- 在合并请求(MR)阶段触发影响面分析并生成报告
- 同时支持手动创建影响面分析任务
数据库设计
根据架构方案设计,规划出如下四个表数据结构,用来存储发布应用数据、影响面结果数据、页面异常/性能数据、研发效能等信息,支持高效查询和扩展性。
业务效果
迭代发布对系统整体的影响是多维度的,从不同视角进行发布影响面的全面评估,可以协助责任人制定发布重点监控方向,从而有效减少风险。
按人员类型划分成不同角色视角
※ 测试视角
※ 研发视角
※ 管理视角
按影响面维度划分成多个展示效果
※ 任务详情
※ 模块列表
※ 接口信息
※ 需求信息
四、挑战 & 优化
在大型项目中,模块间的依赖关系复杂,如何高效、准确地构建依赖关系图是一个挑战。
挑战1:复杂依赖关系分析
※ 问题描述
- 代码风格与框架差异。 不同项目采用不同技术栈、模块化方案、动态语法及特殊语法导致解析困难重重
- 动态依赖难以追踪。 运行时依赖(如按需加载、环境变量分支逻辑)无法通过静态分析捕获
- 系统路由规则差异。 不同系统采用不同的路由方案,其中微前端场景下,主应用与子应用的路由可能独立管理,形成多层嵌套路由结构
※ 解决思路
- 多语言/框架适配。 统一AST解析引擎,兼容主流模块化规范
- 运行时依赖追踪。 选择动态分析工具并添加日志记录
- 统一路由元信息提取。 多框架路由解析适配器,微前端主子应用路由协同
挑战2:跨内部平台系统集成
※ 问题描述
- 接入流程繁琐。 各内部平台系统需单独申请权限配置令牌,重复操作多,维护成本高
- 数据实时性与一致性。各平台数据更新频率不同,聚合时可能产生冲突
※ 解决思路
- 模块化设计架构。 功能模块独立开发,优先级划分,MVP思维
- 数据版本快照。 版本控制管理,对关键数据人工干预兜底
优化1:跳过额外分析检测
在CI/CD流程中,部分代码变更(如文档更新、配置文件调整)无需触发完整的代码影响面分析。通过检测机制,可减少不必要的资源消耗,提升流水线执行效率。
- 条件判断跳过分析。 根据变更文件类型或所在目录信息,动态决定是否执行分析
- 提交信息比对。 比较两次检测之间的 commit** 差异,无内容主动跳过分析
- 白名单机制。 对特定文件或目录配置白名单,包含无需分析的特定文件或目录
优化2:缓存机制优化
合理的缓存策略和异步任务处理可以优化检测效率,降低 CPU 使用率和内存占用,进而提升系统整体性能。
- 设置适当的缓存失效策略。 以模块或文件的唯一标识(如文件路径、Git提交哈希)作为缓存键,当依赖项或代码发生变更时,清空相关缓存
- 任务异步处理。 将依赖分析和 AST 解析任务异步处理,使用消息队列将任务排入队列,避免阻塞主线程
五、总结展望
通过实现一套自动化收集模块级代码影响面分析的方案,我们可以更精准地评估版本需求发布对于系统整体稳定性的影响,从而提前确保重点模块能够得到有效的预警和监控,并创建相应的预案计划。这将有助于提升研发自测能力、优化测试覆盖率、评估系统复杂度,最终提高系统的稳定性和代码质量。
之后我们将继续优化影响面分析引擎,提升依赖关系分析的准确性和效率,进一步融合多维度数据,完成在线流量报表、全栈大盘数据建设,实现更高效的数据聚合和可视化展示,为开发团队提供更强大的支持。
往期回顾
2. 以细节诠释专业,用成长定义价值——对话@孟同学 |得物技术
3. 得物可观测平台架构升级:基于GreptimeDB的全新监控体系实践
文 / 卓翎
关注得物技术,每周更新技术干货
要是觉得文章对你有帮助的话,欢迎评论转发点赞~
未经得物技术许可严禁转载,否则依法追究法律责任。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。