| name | java-code-review |
| description | Javaコードの品質・安全性・保守性・パフォーマンスをレビューするスキル。JavaファイルやJava関連のPRレビュー、ユーザーがJavaコードレビューを求めたときに使用する。 |
Java Code Review
ゴール
Javaコードを以下の観点からレビューする。
- 正しさ: 仕様どおりに動作し、例外やバグを生まないか
- 安全性: セキュリティ上の問題がないか
- 保守性: 読みやすく変更しやすい構造になっているか
- パフォーマンス: 明らかなボトルネックや無駄な処理がないか
- 一貫性: プロジェクトのコーディング規約や設計方針に沿っているか
このスキルは、Javaファイル単体のレビューと、PR全体のレビューの両方で使う。
レビュー手順(全体の流れ)
- 変更の概要を把握する
- 何のための変更か(バグ修正/機能追加/リファクタリングなど)
- 公開APIに影響があるか(インターフェース・DTO・REST API など)
- 影響範囲を把握する
- 呼び出し元/呼び出し先クラス
- データベースや外部サービスとの連携箇所
- 主要な観点でコードを確認する(以下のチェックリストに沿う)
- 気づいた点を優先度付きでコメントする
- [Critical]: バグ・セキュリティ・設計上の重大な問題
- [Major]: 保守性・性能などの重要な改善点
- [Minor]: 命名・スタイル・微細なリファクタリング提案
- 最後にまとめコメントを書く
- 変更の良い点
- 必ず修正してほしい点
- 任意で検討してほしい改善案
共通チェックリスト
正しさ・堅牢性
設計・保守性
パフォーマンス・リソース管理
セキュリティ
テスト
Spring / Webアプリでの追加観点(該当する場合)
コメントの書き方ガイド
レビューコメントは、具体的で提案を含む形で記述する。
- Bad: 「この命名は微妙です」
- Good: 「このメソッドはバリデーションのみを行っているので、
validateUserInput のような名前にすると役割が明確になりそうです」
推奨フォーマット:
- [Critical] 内容: バグ・セキュリティ・仕様不整合など
- [Major] 内容: 構造・パフォーマンス・分かりにくさなど
- [Minor] 内容: 命名・コメント・スタイルなど
出力フォーマット(テンプレート)
Javaコードをレビューするときは、次の形式で出力する。
### 概要
- 変更の目的と全体的な印象を1〜3行でまとめる。
### 良い点
- 良い点1
- 良い点2
### 指摘事項
- [Critical] 箇所と理由、修正案
- [Major] 箇所と理由、修正案
- [Minor] 箇所と理由、修正案
### 補足・提案(任意)
- 将来的なリファクタリング案や設計上の提案があれば記載
このテンプレートに沿って、過不足なく・優先度付きでコメントをまとめること。