Java代码变动影响分析工具JCCI使用教程

1. 项目介绍

JCCI（Java Code Commit Impact）是一个开源的Java代码变动影响分析工具。它通过分析Git提交的差异，帮助开发者了解代码改动对项目的影响范围。JCCI基于纯Python开发，利用javalang库进行Java文件语法解析，以及unidiff库解析Git diff信息，从而定位代码改动所影响的类和方法，并生成树形图数据以展示影响链路。

2. 项目快速启动

环境准备

• Python版本：Python 3.9及以上
• SQLite版本：3.38及以上

安装JCCI

从GitHub克隆项目到本地：

git clone https://github.com/baikaishuipp/jcci.git
cd jcci

安装项目依赖：

pip install -r requirements.txt

使用JCCI

以下是一个基本的使用示例：

from jcci.src.jcci.analyze import JCCI

# 分析两个commit之间的代码变动影响
commit_analyze = JCCI('[e-mail]', 'username1')
commit_analyze.analyze_two_commit('master', 'commit_id1', 'commit_id2')

# 分析特定类的方法影响
class_analyze = JCCI('[e-mail]', 'username1')
class_analyze.analyze_class_method('master', 'commit_id1', 'package/src/main/java/ClassA.java', '20,81')

# 分析两个分支之间的代码变动影响
branch_analyze = JCCI('[e-mail]', 'username1')
branch_analyze.analyze_two_branch('branch_new', 'branch_old')

在以上代码中，project_git_url是项目的Git地址，username1是一个标识符，用于避免并发分析同一项目时的冲突。在实际使用时，需要替换为实际的Git地址和用户标识符。

生成分析结果

分析完成后，会生成后缀为.cci的文件，该文件包含了分析结果的关系图数据。可以通过下载jcci-result.html文件，并在本地打开，选择生成的.cci文件来查看分析结果。

3. 应用案例和最佳实践

• 案例1：在重构代码时，使用JCCI分析代码改动对项目其他部分的影响，确保重构不会引入意外的bug。
• 案例2：在添加新功能或修复bug时，使用JCCI确定改动可能影响的范围，以便进行更精确的测试。

最佳实践：

• 在每次代码提交前，使用JCCI进行影响分析，作为代码审查的一部分。
• 结合持续集成（CI）流程，自动化运行JCCI，以快速发现潜在的代码影响问题。

4. 典型生态项目

目前，JCCI作为一个独立的工具，尚未明确地集成到其他大型生态项目中。但是，它可以在任何使用Java语言并且采用Git作为版本控制系统的项目中使用。开发者可以结合自己的项目需求，将JCCI集成到项目的开发流程中，提高代码质量和维护效率。