Tai-e(中文:太阿;发音:[ˈtaɪə:])是一个全新的 Java 静态分析框架(详情请参阅我们的 ISSTA 2023 论文),它融合了我们提出的新颖设计以及 Soot、WALA、Doop 和 SpotBugs 等经典框架的设计,堪称“最佳”设计之集大成者。 Tai-e 易于学习、易于使用、高效且高度可扩展,让你能够轻松地在其之上开发新的分析。
目前,Tai-e 提供以下主要分析组件(更多分析正在开发中):
clone() 检测器Tai-e 使用 Java 开发,可运行于 Windows、Linux 和 macOS 等主流操作系统。
出于对开发者的尊重,我们期望你在研究工作中请引用 ISSTA 2023 中描述 Tai-e 框架的论文:
Tian Tan and Yue Li. 2023. Tai-e: A Developer-Friendly Static Analysis Framework for Java by Harnessing the Good Designs of Classics. In Proceedings of the 32nd ACM SIGSOFT International Symposium on Software Testing and Analysis (ISSTA '23), July 17–21, 2023, Seattle, WA, USA (pdf, bibtex).
推荐的方式是从 GitHub Releases 下载发行版 ZIP 包。 该 ZIP 包包含 Tai-e、所有运行时依赖、离线文档,以及适用于 Windows、Linux 和 macOS 的启动脚本。
或者,你也可以从源代码自行构建最新的 Tai-e。这可以通过 Gradle 轻松完成(请确保你的系统上已安装 Java 17(或更高版本)):
./gradlew distZip
分发 ZIP 将生成在 tai-e/build/distributions/ 中。
解压后,通过启动脚本运行 Tai-e:
# on Linux/macOS
./tai-e-<version>/bin/tai-e -h
# on Windows
.\tai-e-<version>\bin\tai-e.bat -h
为了兼容旧版本和脚本,Tai-e 仍然提供一个传统的全功能 JAR 包:
./gradlew fatJar
java -jar build/tai-e-all-<version>.jar -h
Tai-e 被设计为一个独立工具,但你也可以选择将其作为依赖项包含在你的项目中。 它已在 Maven 仓库中提供,使你能够使用 Gradle 和 Maven 等构建工具轻松地将其集成到你的 Java 项目中。 我们同时维护 Tai-e 的稳定版和最新版,以下是 Gradle 和 Maven 脚本格式中对应的坐标:
对于 Gradle:
dependencies {
implementation("net.pascal-lab:tai-e:0.5.4")
}
对于 Maven:
<dependencies>
<dependency>
<groupId>net.pascal-lab</groupId>
<artifactId>tai-e</artifactId>
<version>0.5.4</version>
</dependency>
</dependencies>
对于 Gradle:
repositories {
mavenCentral()
maven { url = uri("https://central.sonatype.com/repository/maven-snapshots/") }
}
dependencies {
implementation("net.pascal-lab:tai-e:0.5.5-SNAPSHOT")
}
对于 Maven:
<repositories>
<repository>
<id>snapshots</id>
<name>Sonatype snapshot server</name>
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>net.pascal-lab</groupId>
<artifactId>tai-e</artifactId>
<version>0.5.5-SNAPSHOT</version>
</dependency>
</dependencies>
你可以在 Gradle 或 Maven 脚本中使用这些坐标,将所需版本的 Tai-e 引入你的项目。
我们在参考文档中提供了 Tai-e 的详细信息,涵盖在 IntelliJ IDEA 中的设置、命令行选项以及开发新的分析等多个方面。
请注意,上述参考文档针对的是 Tai-e 的最新版本。 如果你需要特定稳定版本的文档,请参阅文档索引。 此外,文档也包含在代码仓库中,并与源代码一同维护。 你可以从 index.adoc 开始,浏览 docs/en 目录,以获取特定版本 Tai-e 的参考文档(AsciiDoc 格式)。 这样你就可以访问 Tai-e 特定版本的文档。
除参考文档外,Tai-e 的 Javadocs 也是有用的参考资源。
由于我们正在积极开发和更新 Tai-e,我们在 CHANGELOG 中记录了值得注意的变更,尤其是新功能和破坏性变更。 如果你在更新 Tai-e 后发现问题,可以查看 CHANGELOG 以获取有用信息。
此外,我们还开发了 Tai-e 教学版,其中精心设计了八个编程作业,用于系统地训练学习者实现各种静态分析技术以分析真实的 Java 程序。 教学版与 Tai-e 共享大量代码,因此完成这些作业是熟悉 Tai-e 的好方法。