ページ内ナビ
概要
CheckstyleはJava source codeがcoding standardやbest practiceに従っているかを検査するcode quality toolです。Google Java Style GuideやSun Code Conventionsを基点にしつつ、XML configurationでcheckを細かく組み替えられます。
特徴と向いている用途
公式資料に基づく紹介・実機未検証 · 内容確認日:
主な特徴
向いている用途
teamのJava coding conventionを自動化したいprojectに向く
formatだけでなくimport、control flow、class/member構造等のruleをrepository内設定として固定し、review前に機械的な違反を検出したい場合に有効です。
出典:[2]
導入前の確認
rule upgradeによる新規violationを段階的に取り込む
Checkstyleのupgradeではrule追加やbehavior変更により既存codeで新しいviolationが出る可能性があります。14.3.0ではJava moduleとしてのmodule-info.java対応が追加されています。
出典:[3]
参考にした公式資料
- [1]checkstyle/checkstyle — GitHub repository(2026-10-06)
- [2]Checkstyle — README(2026-10-06)
- [3]Checkstyle 14.3.0 release(2026-10-06)
編集部からの補足
命名・layout・import・control flow等のcoding ruleをteam規約としてCIへ固定したい場合に向きます。SpotBugsやPMDのbug/design analysisとは目的が異なるため、役割を分けて併用できます。
3ステップで試す
- 1
ソースを取得
git clone --depth 1 https://github.com/checkstyle/checkstyle.git - 2
リポジトリへ移動
cd checkstyle - 3
公式手順を確認
READMEのInstallation / Quick Start / Getting Startedにある公式コマンドを続けて実行してください。
find . -maxdepth 1 -iname 'README*' -exec sed -n '1,220p' {} \; -quit
成長
成長の推移 · 直近30日
9,590 Stars
推移データを蓄積中です。
Built with
カテゴリとタグ
GitHubデータ
関連情報
関連記事を投稿するこのOSSの使い方や活用事例をMarkdownで投稿できます。管理者が承認した後に公開されます。
あわせて探訪
- DBeaver51,964 Stars
共通タグ 1件 · 共通カテゴリ 1件 · 同じ言語
多数のdatabaseを一つのdesktop SQL workspaceから操作する
Java - Guava51,920 Stars
共通タグ 1件 · 共通カテゴリ 1件 · 同じ言語
immutable collection・multimap・graph・concurrency・I/O等のJava utilityをまとめて利用する
Java - Retrofit43,934 Stars
共通タグ 1件 · 共通カテゴリ 1件 · 同じ言語
HTTP APIを型付きJava・Kotlinインターフェースとして呼び出す
Java - Netty35,068 Stars
共通タグ 1件 · 共通カテゴリ 1件 · 同じ言語
event loopとChannel pipelineを組み合わせ、高接続数のprotocol server/clientをJavaで構築する
Java - PMD5,494 Stars
共通タグ 4件 · 共通カテゴリ 2件 · 同じ言語
ASTと400超のruleでJavaを含む複数言語のbug・design・code smellを検出する
Java - SpotBugs3,949 Stars
共通タグ 4件 · 共通カテゴリ 2件 · 同じ言語
Java bytecodeを静的解析してbug pattern・誤用・潜在的不具合を検出する
Java
情報の誤りを報告
掲載内容に誤りや古い情報があればお知らせください。