The Influence of Code Smells in Efferent Neighbors on Class Stability

这是一份关于论文《The Influence of Code Smells in Efferent Neighbors on Class Stability》（代码异味在传出邻居中对类稳定性的影响）的详细技术总结。

1. 研究背景与问题 (Problem)

核心问题：
软件维护中，不稳定的类（即频繁修改或修改幅度大的类）会增加维护成本和引入副作用的风险。虽然现有研究普遍认为“代码异味”（Code Smells，即表明潜在设计问题的代码表面特征）会降低可维护性，但大多数稳定性研究仅关注被修改类本身是否包含异味。

研究缺口：

1. 忽略传出依赖的影响： 一个类可能本身是“干净”的，但由于其传出邻居（Efferent Neighbors，即该类依赖的其他类）发生了修改，导致“涟漪效应”（Ripple Effects）传播，迫使该类不得不进行修改。如果这些传出邻居包含代码异味，这种不稳定性可能会加剧。
2. 忽略异味的关联与交互： 代码异味很少单独存在。它们可能在同一个类中共现（Interrelation/Collocation），或者通过静态依赖在不同类之间耦合（Coupling）。特别是当两个异味实例通过静态依赖直接连接时，会产生异味交互（Interaction），这可能进一步恶化可维护性，但这一领域尚缺乏实证研究。

研究目标：
本研究旨在实证分析传出邻居中的代码异味（包括异味的存在、数量、种类）以及异味间的关联与交互（Coupling 和 Interaction）是否会影响目标类的稳定性。

---

2. 研究方法 (Methodology)

本研究采用大规模实证研究（Empirical Study）设计，具体步骤如下：

2.1 数据收集 (Data Mining)

• 样本来源： 从 GitHub 上选取排名前 100 的热门开源 Java 项目。
• 筛选标准： 拥有超过 100 个 Fork、至少 20 名贡献者、至少一年的提交历史（且该年内至少有 50 次提交）、Java 代码占比超过 80%、非教育类项目。
• 时间窗口： 选取每个项目的一个快照（Snapshot），并分析其随后一年的提交历史作为观察期。

2.2 变量定义

• 因变量 (Dependent Variables, DVs) - 类稳定性：
  • 变更频率 (Change Frequency, ChF)： 观察期内修改该类提交的次数。
  • 变更规模 (Change Size, ChS)： 观察期内该类增加或删除的代码行数（去除空行和注释）。
• 自变量 (Independent Variables, IVs)：
  • 类自身异味： 是否存在异味、异味数量、异味种类。
  • 传出邻居异味： 传出邻居中是否存在异味、异味总数、异味种类总数。
  • 传出异味耦合 (Efferent Code Smell Coupling)： 目标类和其传出邻居是否同时存在异味。
  • 传出异味交互 (Efferent Code Smell Interaction)： 目标类中的异味实例与传出邻居中的异味实例之间是否存在直接的静态依赖连接。
• 控制变量 (Control Variables, CVs)：
  • 类大小 (Class Size)、传出邻居数量 (Efferent Coupling)。
  • 针对特定假设，额外控制类自身或邻居的异味存在情况，以排除混淆因素。

2.3 工具与检测

• 代码异味检测： 使用 JSpIRIT 工具，检测 10 种异味（5 种类级别：God Class, Brain Class, Data Class, Refused Bequest, Tradition Breaker；5 种方法级别：Feature Envy, Brain Method, Dispersed Coupling, Intensive Coupling, Shotgun Surgery）。
• 依赖分析： 使用 CodeQL 提取静态依赖（调用、创建、包含、转换、使用、抛出、返回、参数、继承、实现等 10 种关系）。
• 变更分析： 使用 Git 命令和 RefactoringMiner 识别提交历史、计算代码变更量，并排除类合并/拆分等重构操作以确保分析单元的一致性。

2.4 统计分析

• 模型： 使用负二项广义线性模型 (Negative Binomial GLMs) 进行回归分析。
• 理由： 软件工程的计数数据（如提交次数、代码行数）通常不服从正态分布且存在过离散（Overdispersion）现象，负二项模型比泊松模型更合适。
• 随机效应： 在模型中加入项目级别的随机截距 (Project-level Random Intercepts)，以消除不同项目间因开发习惯、项目年龄等因素带来的系统性偏差。
• 假设检验： 使用单侧检验，并采用 Benjamini-Hochberg (BH) 程序控制错误发现率（FDR）。

---

3. 研究问题与假设 (Research Questions & Hypotheses)

研究提出了四个核心研究问题（RQ）：

1. RQ1 (类自身异味)： 类中的代码异味是否影响其稳定性？（验证异味数量、种类与稳定性的负相关关系）。
2. RQ2 (传出邻居异味)： 传出邻居中的代码异味是否影响目标类的稳定性？（验证即使目标类本身干净，邻居的异味是否会导致其不稳定）。
3. RQ3 (传出异味耦合)： 当目标类和传出邻居同时存在异味（耦合）时，是否比单一存在异味更不稳定？
4. RQ4 (传出异味交互)： 当目标类和传出邻居的异味实例通过静态依赖直接连接（交互）时，是否进一步加剧不稳定性？

---

4. 预期贡献与结果 (Expected Contributions & Results)

注：由于这是一份研究计划/提案（Proposal）性质的论文（基于摘要和引言部分的时态和描述），文中主要陈述了研究设计和预期贡献，尚未报告最终的统计数值结果。以下是基于研究设计的预期贡献：

4.1 主要贡献

1. 大规模实证研究设计： 对 100 个顶级 Java 项目进行为期一年的深度挖掘，所有源代码和分析脚本将公开，确保完全可复现。
2. 理论突破： 首次提供关于传出邻居异味对类稳定性影响的严格证据。这将挑战仅关注“类自身”的传统观点，揭示依赖驱动的稳定性风险。
3. 细化异味影响机制： 区分并量化了异味共现、异味耦合（跨类）和异味交互（直接依赖连接）对稳定性的不同影响，填补了关于异味交互效应的研究空白。
4. 实践指导： 研究结果将为代码异味检测工具的优先级排序、重构策略（特别是针对依赖链的重构）提供实证依据，帮助团队更有效地维护系统稳定性。

4.2 预期发现方向

• 预期证实：传出邻居中的异味会显著降低目标类的稳定性，即使目标类本身没有异味。
• 预期证实：异味耦合（Coupling）和异味交互（Interaction）会进一步放大不稳定性，且交互（直接依赖连接）的影响可能比单纯的耦合更严重。

---

5. 研究意义 (Significance)

1. 理论意义：

   • 扩展了软件稳定性理论，从“内在稳定性”（类自身属性）扩展到“涟漪效应稳定性”（外部依赖属性）。
   • 深化了对代码异味“关联性”和“交互性”的理解，证明了异味不仅仅是局部问题，而是可以通过静态依赖网络传播的系统性问题。

2. 实践意义：

   • 重构优先级： 开发者在决定重构顺序时，不应只看类本身的异味，还应检查其依赖的类（传出邻居）是否存在异味。
   • 架构设计： 提示架构师在系统设计阶段需关注依赖链上的异味传播风险，避免将不稳定的组件作为核心依赖。
   • 工具改进： 现有的静态分析工具应增加对“传出邻居异味”和“跨类异味交互”的检测与预警功能。

3. 局限性说明：

   • 研究仅限于 Java 项目，结论推广到其他语言需谨慎。
   • 依赖检测基于静态分析，可能无法完全捕捉动态依赖或运行时行为。
   • 时间窗口为一年，可能存在时间上的不匹配（快照时的状态与一年后的状态差异），但已通过统计模型和随机效应进行缓解。

总结

该论文提出了一项严谨的实证研究，旨在揭示代码异味在软件依赖网络中的传播效应。通过量化传出邻居异味及其交互对类稳定性的影响，该研究将推动软件维护从“局部修复”向“全局依赖治理”转变，为提升软件系统的长期可维护性提供重要的理论支持和实践指南。