[Object-Oriented & Java]

Writing Robust Java Code

Writing Robust Java Codeは、Scott W. Ambler氏によるJavaコーディング標準と指針が記述された文書です。この文書は、理解しやすく保守しやすく拡張しやすいコードを書くことを目的としています。一般的な標準だけでなく、コーディングにおける指針が豊富に書かれています。

バージョン番号の17.01dは、スタートレックに登場するエンタープライズ号の艦籍番号にちなんで付けられているらしい（著者はスタートレックファン）。

日本語訳公開版(v17.01d)

Writing Robust Java Codeのバージョン17.01dを日本語訳したものを著者のScott W.Ambler氏の承諾を得て公開しています。

オリジナル(v17.01d)

Writing Robust Java Codeのオリジナルは下記URLにあります。

• http://www.ambysoft.com/javaCodingStandards.html　(英語)

古い版（v17.01c）の日本語訳

一応取ってありますが、新しいv17.01dの方をご覧下さい。

• HTML4形式
• LaTeX2ε形式(gzip形式で圧縮)

参考URL

他のJavaコーディング標準

• SunのCode Convention for the Java Program Language
  Sun謹製のコーディング規約。でもSun社内ではあまり使っていないらしいもはや使われていない。更新もされていないようだし。Sunのエンジニアによると"is gone"だそうです^*1。
• 上記の日本語訳（by 沼田哲史さん）
• Javaコーディング標準オブジェクト倶楽部バージョン
  日本のXPの草分け平鍋さんによって書かれたもの。
• Draft Java Coding Standard(by Doug Lea)
• How To Write Unmaintainable Code
  保守を困難にする規約集です:-)
• 超図解Javaルールブック（電通国際情報サービスのJavaコーディング規約を基にした書籍、残念ながら絶版）
• 電通国際情報サービス版Javaコーディング規約2004
  「超図解Javaルールブック」の基となっている規約です。コーディングの心得 五か条を筆頭に記載し、ポリシーを明確にしている点、規約が違反サンプル、修正サンプルの形式で貫いている点が良。Java 5で導入された機能がないので更新が望まれます。
• How to Write Doc Comments for the Javadoc Tool
  SunによるJavadocコメントの書き方
• SMG株式会社の公開しているJavaコーディング規約
  電通国際情報サービス版Javaコーディング規約2004を踏襲してルールの追加・修正をしています。
  よいところ）静的解析ツールを考慮(2.2(6))、規約の改訂ルール(2.3)、用語の統一(6.3.1)、不要コメント(8.2.2)
  疑問なところ）Eclipse前提(3)、パッケージ構成(4)、匿名クラスの使用禁止(5.3(5))、コンバータメソッド(6.2.4(5))、ループ変数(6.2.5(2))、括弧({})がJava標準スタイルでない（7.1.2(2)）、テストメソッド名(9.2)、パフォーマンス上配列推奨(10.1)、処理途中リターン禁止(12.1.3)、ハイパフォーマンスコーディング(12.2)、ループ内文字列連結禁止(12.2.2)、Java標準loggingを否定(11)
  規約の記述に、電通国際情報サービス版のスタイル（違反サンプルと修正サンプルを提示）のところと、単なる箇条書きが混ざって一貫性がない点は要改善事項と思います。
• JPL Java Coding Standard
  米NASA JPL（ジェット推進研究所）が作成した、地上機器向けソフトウェアのコーディング標準。53のルールから構成され、ミッションクリティカルを意識したコーディングルールとなっているのが特徴です。各ルールに参照としてEffective Javaのルールや、FindBugs、PMDのルールなどが記載されているので、規約に対応して静的検証ツールのルール設定がしやすく考慮されています。

*1 SunのCode Conventionはあまり積極的に保守されたり使われてはいない、とJosh Bloch氏が述べていた。

developerWorks:Components日本語記事

IBMのdeveloperWorksサイトに、Scott W. Ambler氏の記事（日本語訳）がいくつか掲載されています。Writing Robust Java Codeに書かれた標準や指針についての詳しい解説、補足として読むことができます。

• Java 命名規則
• Java メンバー関数の文書化
• Java プログラムにおけるメンバー関数の visibility （2008/02/19現在行方不明）
• Java プログラムにおける効果的なフィールド visibility
• Java accessorのvisibility
  アクセッサをpublicにする必要はない。
• Accessorを使用するとJavaコードの堅牢性が高まります
  アクセッサの勧め
• Java accessorのなぜなぜ集
  アクセッサを使うべき場合／使うべきでない場合の比較。

Ambler氏の記事以外にもコーディング標準に参考となる記事が多々掲載されています。

• Javaの理論と実践：それをドキュメント化しなければならないか - Javadocに準拠した統合ドキュメンテーションの利点と欠点
• Javaの理論と実践：ファイナル・アンサー？ - finalキーワードを有効に使用するためのガイドライン
• Javaの理論と実践：安全な構築のテクニック - 構築中に「this」参照を漏洩させない
• Javaの理論と実践：Generics、了解！ - Genericsの使い方を学ぶ上での落とし穴を知り、回避する
• Javaの理論と実践：Genericsのワイルドカードを使いこなす、第1回 - ワイルドカードのキャプチャーを理解する
• Javaの理論と実践：Genericsのワイルドカードを使いこなす、第2回 - getとputの原則
• Javaの理論と実践：volatileを扱う - volatile変数を使うためのガイドライン
• Javaの理論と実践：例外をめぐる議論 - チェックすべきか、チェックせずにおくべきか
• Javaの理論と実践：良いハウスキーピング習慣を身につける - 不必要なリソースが残っていませんか
• ヒント：例外をスローできない場合
• 訛りのないJava言語を話す

コーディングスタイルに関するページ

• Essential Java Styleのエッセンス(^^;
  書籍"Essential Java Style - pattern for implementation"(Jeff Langr)の要約

コーディング標準に関するツール

書式整形

• Artistic Style(AStyle)
  C/C++/C#/Javaのソースコードを指定にしたがって再レイアウトする整形ツール。
• Jacobe
  ソースコードを設定にしたがって再レイアウトする整形ツール。

静的検証

• Jlint
  Java言語のバイトコードおよびソースコードを解析し、コンパイラでは検査していない問題点を指摘するツール。
• lint4j
  Javaソースコードを解析し、排他・スレッド問題、性能・スケーラビリティ問題、シリアライズ、データフロー等の問題を指摘するツール。
• CheckStyle
  コーディング標準に従っているかをチェックすることができます。チェック対象は、Javadocコメント有無、変数名、メソッド名、クラス名、ファイル先頭ヘッダ、import文、行の桁数、メソッド行数、ファイル行数、パラメータ数、タブ有無、空白、行折り返し、修飾子の順序、冗長、可視性、{}の強制、空ブロック、{}の位置、などです。
  Checkstyleホームページの日本語翻訳ページ
• JCSC
  コーディング規約への整合性チェックとメトリクス計測を行うツール。
• Hammurapi
  120のルールに従ってソースコードを検証するツール。
• FindBugs
  Java言語のバイトコードを解析し、バグパターンリストと照合して潜在的な問題点を指摘するツール。ルールの一例は、equalsメソッドと hashCodeメソッドが整合性を持ってオーバーライドされているか、メソッドの戻り値が無視されているか、null参照呼び出しを引き起こす可能性が あるか、初期化前にフィールドを読み出すか、など。一覧はFindBugsのサイトに掲載されています。
• PMD
  ソースコードの静的解析ツール。未使用のローカル変数/引数、空のcatch文/if文、重複したimport文、シングルトンにすべきクラス、短すぎ/長すぎる命名などを調査する。Eclipseをはじめ各種開発ツールへのプラグインが充実している。

メトリクス計測

• CyVis
  バイトコード（クラスファイル）からメトリクス計測可能、つまりソースファイル不要。GUIツールのほか、Antタスク、コマンドライン実行可能。
• SourceMonitor
  Windows用ツール。C/C++/C#/VB.NET/VB/Delphi/HTML/Javaのサイズ（LOC、クラス数、メソッド数、複雑度）を計測。
• JavaNCSS
  循環複雑度を含むいくつかのメトリクス
• JDepend
  依存関係に関するメトリクス
• Crap4j
  循環複雑度と自動テスト実行時のカバレッジから問題点を定量評価
• Ecipse Metrics Plugin
  Eclipseのプラグイン
• Metrics
  Eclipseのプラグイン
• CAP
  Eclipseのプラグイン

参考文献

• "The Elements of Java Style", Allan Vermeulen, Scott W. Ambler, Greg Bumgardner, Eldon Metz, Trevor Misfeldt, Jim Shur, Patrick Thompson著, Cambridge University Press, 2000
• 「コードコンプリート」、Steve McConnel著、石川勝訳、アスキー出版局、1994

• 「Javaコーディング標準徹底理解　−その意義、作成法、適用に際してのポイントを学ぶ」、高橋徹、JavaWorld誌2003年7月号記事およびJavaWorld for Beginners（ムック）記事、IDG
  拙著の記事です。

• 「超図解 Javaルールブック」、電通国際情報サービス著、エクスメディア刊、2004　（出版社倒産により入手難）

• 「クリーンコード」、Robert C.Martin、
• 「実装パターン」、Kent Beck