RefDiff 使用指南

项目简介

RefDiff 是一个强大的工具，旨在从 Git 仓库的提交历史中挖掘代码重构行为。它支持包括 Java、JavaScript 和 C 在内的多种编程语言。通过分析不同版本间的代码变化，RefDiff 能够识别出一系列重构操作，如方法重命名、移动、提取类或方法等。

1. 目录结构及介绍

RefDiff 的项目结构组织有序，便于理解和扩展：

• doc: 包含项目的相关文档资料。
• gradle/wrapper: Gradle 构建系统的包装器，确保跨平台的一致构建环境。
• refdiff-core: 核心库，实现了跨语言的重构检测逻辑。
• refdiff-{java/js/c}: 分别对应于 Java、JavaScript 和 C 语言的插件实现。
• refdiff-evaluation: 评估模块，用于测试和验证 RefDiff 的准确性。
• refdiff-example: 提供了示例代码，展示如何使用 RefDiff 进行重构检测。
• .gitignore: 指定了在 Git 版本控制中应忽略的文件类型。
• LICENSE: 许可证文件，表明项目遵循 MIT 开源协议。
• README.md: 项目的主要说明文件，包含了快速入门和核心概念。

2. 项目的启动文件介绍

RefDiff 不像传统应用有一个单一的“启动”文件，而是依赖于 Gradle 构建系统来编译和运行。主要的交互入口在于命令行下执行特定任务。若想进行实际的重构检测，你会在 refdiff-example 中找到示例代码，比如 RefDiffExample.java，这是理解如何集成 RefDiff 到你的流程中的起点。

示例启动步骤

1. 克隆项目到本地：

   git clone https://github.com/aserg-ufmg/RefDiff.git
   

2. 使用 Gradle 设置 Eclipse 工作空间（可根据需要选择相应的IDE）：

   cd RefDiff
   gradlew eclipse # 对于Linux或Mac用户，可能需要./gradlew eclipse
   

3. 导入到IDE并运行 RefDiffExample.java 来观察其用法。

3. 项目的配置文件介绍

RefDiff 主要依赖 Gradle 配置文件进行构建和依赖管理。关键的配置文件是：

• build.gradle: 此文件定义了项目的构建脚本，包括依赖项、构建任务等。它是Gradle读取的核心配置文件，用来指定项目的构建规则和第三方库的引入。

如果你希望对特定语言的插件进行配置或者调整构建过程，修改将在这进行。例如，添加新依赖、改变编译参数或设置版本信息等。

注意，虽然有配置文件的概念，但RefDiff更侧重于通过编程接口进行定制而非传统的配置文件更改。对于语言特异性配置，通常涉及编辑或创建对应的插件类，并且这些改动更多地体现在代码层面上。

综上所述，RefDiff 的使用和配置主要是通过代码示例和Gradle构建脚本来驱动的，没有独立的传统配置文件来设定日常运行选项。开发人员需通过编码和 Gradle 的配置来调整和控制项目的使用细节。