Tai-e(中国語:太阿、発音:[ˈtaɪə:])は、Java 向けの新しい静的解析フレームワークです(詳細は ISSTA 2023 論文 をご覧ください)。私たちが提案した新しい設計と、Soot、WALA、Doop、SpotBugs といった古典的フレームワークの設計の両方から、いわば「最良」の設計を取り入れているのが特徴です。 Tai-e は習得が容易で、使いやすく、効率的で、拡張性が高いため、その上で新しい解析を簡単に開発できます。
現在、Tai-e は以下の主要な解析コンポーネントを提供しています(さらに多くの解析も 準備中です):
clone() 検出器Tai-e は Java で開発されており、Windows、Linux、macOS を含む主要なオペレーティングシステムで動作します。
開発者への敬意として、研究活動において Tai-e フレームワークを説明する ISSTA 2023 の論文をぜひ引用してください:
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 の最新バージョンに関するものであることにご注意ください。 特定の安定版のドキュメントが必要な場合は、ドキュメントインデックスを参照してください。 さらに、ドキュメントはリポジトリ内に含まれており、ソースコードとともに維持されています。 特定のバージョンの Tai-e のリファレンスドキュメント(AsciiDoc 形式)は、index.adoc から始まる docs/en ディレクトリを参照することでアクセスできます。 これにより、Tai-e のバージョン固有のドキュメントにアクセスできます。
リファレンスドキュメントに加えて、Tai-e の Javadocs も 有用な参照リソースとして利用できます。
Tai-e を活発に開発・更新しているため、注目すべき変更、特に新機能や破壊的変更を CHANGELOG に記録しています。 Tai-e を更新した後に問題を見つけた場合は、CHANGELOG で有用な情報を確認するとよいでしょう。