<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>第5章 FindBugs GUI の使用方法</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ マニュアル"><link rel="up" href="index.html" title="FindBugs™ マニュアル"><link rel="prev" href="running.html" title="第4章 FindBugs™ の実行"><link rel="next" href="anttask.html" title="第6章 FindBugs™ Ant タスクの使用方法"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">第5章 <span class="application">FindBugs</span> GUI の使用方法</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="running.html">戻る</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="anttask.html">次へ</a></td></tr></table><hr></div><div class="chapter" title="第5章 FindBugs GUI の使用方法"><div class="titlepage"><div><div><h2 class="title"><a name="gui"></a>第5章 <span class="application">FindBugs</span> GUI の使用方法</h2></div></div></div><div class="toc"><p><b>目次</b></p><dl><dt><span class="sect1"><a href="gui.html#d0e1058">1. プロジェクトの作成</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1099">2. 分析の実行</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1104">3. 結果の閲覧</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1119">4. 保存と読み込み</a></span></dt></dl></div><p>この章では、<span class="application">FindBugs</span> グラフィカルユーザーインタフェース (GUI) の使用方法を説明します。</p><div class="sect1" title="1. プロジェクトの作成"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1058"></a>1. プロジェクトの作成</h2></div></div></div><p><span class="command"><strong>findbugs</strong></span> コマンドで <span class="application">FindBugs</span> を起動してから、メニューで <span class="guimenu">File</span> → <span class="guimenuitem">New Project</span> を選択してください。そうすると、次のようなダイアログが表示されます:</p><div class="mediaobject"><img src="project-dialog.png"></div><p>
</p><p>「Class archives and directories to analyze」テキストフィールドの横にある 「Add」ボタンを押すと、バグを分析する java クラスを含んでいる Java アーカイブファイル (zip, jar, ear, or war file) を選択して指定できます。複数の アーカイブ/ディレクトリーを追加することが可能です。</p><p>また、分析を行う Java アーカイブのソースコードを含んだソースディレクトリーを指定することもできます。そうすると、バグの可能性があるソースコードの場所が、<span class="application">FindBugs</span> 上でハイライトして表示されます。ソースディレクトリーは、Java パッケージ階層のルートディレクトリーを指定する必要があります。例えば、ユーザのアプリケーションが <code class="varname">org.foobar.myapp</code> パッケージの中にある場合は、 <code class="filename">org</code> ディレクトリーの親ディレクトリーをソースディレクトリーリストに指定する必要があります。</p><p>もうひとつ、任意指定の手順があります。それは、補助用の Jar ファイルおよびディレクトリーを 「Auxiliary classpath locations」のエントリーに追加することです。分析するアーカイブ/ディレクトリーにも標準の実行時クラスパスにも含まれていないクラスを、分析するアーカイブ/ディレクトリーが参照している場合は、この項目を設定した方がいいでしょう。クラス階層に関する情報を使用するバグディテクタが、 <span class="application">FindBugs</span> にはいくつかあります。したがって、<span class="application">FindBugs</span> が分析を行うクラスの完全なクラス階層を参照できれば、より正確な分析結果を取得することができます。</p></div><div class="sect1" title="2. 分析の実行"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1099"></a>2. 分析の実行</h2></div></div></div><p>アーカイブ、ディレクトリーおよびソースディレクトリーの指定ができれば、「Finish」ボタンを押して Jar ファイルに含まれるクラスに対する分析を実行します。巨大なプロジェクトを古いコンピュータ上で実行すると、かなりの時間(数十分)がかかることに注意してください。大容量メモリである最近のコンピュータなら、大きなプログラムであっても数分程度で分析できます。</p></div><div class="sect1" title="3. 結果の閲覧"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1104"></a>3. 結果の閲覧</h2></div></div></div><p>分析が完了すると、次のような画面が表示されます :</p><div class="mediaobject"><img src="example-details.png"></div><p>
</p><p>左上のペインにはバグ階層ツリーが表示されます。これは、分析でみつかったバグの検索結果が階層的に表示されたものです。</p><p>上部のペインでバグ検索結果を選択すると、下部の「Details」ペインにバグの詳細説明が表示されます。更に、ソースがみつかれば、右上のソースコードペインにバグの出現箇所に該当するソースコードが表示されます。上図の例で表示されているバグは、ストリームオブジェクトがクローズされていないというものです。ソースコード・ウィンドウにおいて当該ストリームオブジェクトを生成している行がハイライトされています。</p><p>バグの検索結果に対してテキストで注釈を入れることができます。階層ツリー図のすぐ下にあるテキストボックスに注釈を入力してください。記録しておきたい情報を何でも自由に入力することができます。バグ結果ファイルの保存および読み込みを行ったときに、注釈も保存されます。</p></div><div class="sect1" title="4. 保存と読み込み"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1119"></a>4. 保存と読み込み</h2></div></div></div><p>メニュー項目から <span class="guimenu">File</span> → <span class="guimenuitem">Save as...</span> を選択すると、ユーザーの作業結果を保存することができます。「Save as...」ダイアログにあるドロップダウン・リストの中から「FindBugs analysis results (.xml)」を選択ことで、ユーザーが指定した jar ファイルリストやバグ検索結果などの作業結果を保存することができます。また、jar ファイルリストのみを保存する選択肢 (「FindBugs project file (.fbp)」) やバグ検索結果のみを保存する選択肢 (「FindBugs analysis file (.fba)」) もあります。保存したファイルは、メニュー項目から <span class="guimenu">File</span> → <span class="guimenuitem">Open...</span> を選択することで、読み込むことができます。</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="running.html">戻る</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="anttask.html">次へ</a></td></tr><tr><td width="40%" align="left" valign="top">第4章 <span class="application">FindBugs</span>™ の実行 </td><td width="20%" align="center"><a accesskey="h" href="index.html">ホーム</a></td><td width="40%" align="right" valign="top"> 第6章 <span class="application">FindBugs</span>™ <span class="application">Ant</span> タスクの使用方法</td></tr></table></div></body></html>