EN JP CN

kwcheck for Java をお使いになる前に

kwcheck for Java をお使いになる前に

kwcheck for Java をお使いになる前に

kwcheck for Java をお使いになる前に

kwcheck は、IDE プラグイン形式では Klocwork によってサポートされていない IDE およびテキストエディターを使用する、C/C++ および Java デベロッパー向けのデスクトップ解析ツールです。GUI ツールの Klocwork Desktop も使用できます。

ローカルプロジェクトの設定

ローカルプロジェクトを設定し、kwcheck createを使用してサーバープロジェクトに接続します。

kwcheck create --url http://server2:8080/my_project

この手順は、初回にのみ実行します。

ビルド設定をキャプチャする

kwant を使用してビルド設定をキャプチャします。

次の例は Ant 1.7.x 以降でビルドしたプロジェクトに当てはまります。プロジェクトが Ant 1.6.x でビルドされている場合は、手動統合 -- Ant ビルドファイルの編集を参照してください。プロジェクトに .jsp ファイルが含まれる場合は、.jsp ファイルを含むプロジェクトの build specification (ビルドスペック)を参照してください。

kwant で build specification (ビルドスペック) を作成するには

  1. ant clean を実行します。
  2. build.xml ファイルを含むディレクトリに移動します。(ant の -f オプションを設定してファイル名を指定した場合は、この手順を省略します)。
  3. kwant を実行します。
    kwant —-output /home/klocwork/freemind.out
    

Maven を使用している場合は、kwmaven を使用してビルド設定をキャプチャできます。次の例は Maven 1.5 以降でビルドしたプロジェクトに当てはまります。

kwmaven で build specification (ビルドスペック) を作成するには:

  1. mvn clean を実行します。
  2. pom.xml ファイルを含むディレクトリに移動します。(-f オプションを設定してファイル名を指定した場合は、この手順を省略します)。
  3. kwmaven install を実行します。
    kwmaven —-output /home/klocwork/freemind.out install
    

build specification (ビルドスペック) の更新ファイルの追加や削除、またはコンパイルフラグの変更のたびに、kwant または kwmaven で新しい build specification (ビルドスペック) を作成し、kwcheck importでプロジェクトにインポートします。build specification (ビルドスペック) の詳細については、Java build specification (ビルドスペック) の作成 を参照してください。

build specification (ビルドスペック) のインポート

build specification (ビルドスペック) は kwcheck import を使用してインポートします。

kwcheck import my_project.out

解析を実行する

  1. kwcheck runでコードを解析します。
    kwcheck run
    
  2. kwcheck listを使用して検出された指摘を表示します。
    kwcheck list -F detailed
    
    注: 解析を実行したときに新しく検出された指摘はローカルな指摘です。システム指摘を表示するには、--system オプションを指定します。
    トレースバックは、検出された指摘に寄与するソースコードのステートメントを識別します。

検出された指摘の詳細については、Java チェッカーリファレンスを参照してください。

欠陥を修正し、残りは無視します。

  1. 本物の欠陥を修正します。
  2. 解析を再実行します。
    kwcheck run
    
  3. 検出された指摘が表示されます。
    kwcheck list -F detailed
    
    指摘がリストに表示されなくなれば、その指摘は修正済みです。
  4. 気にならない指摘は、kwcheck set-status で無視します。
    kwcheck set-status 23-25,30,32 --status Ignore -c "this is 3rd party software"
    
    これで変更内容がその他のデベロッパーや Klocwork Static Code Analysis にも表示されます。その他のデベロッパーによる変更でもデスクトッププロジェクトが更新されるようになりました。この状況は、別の統合ビルド解析の前でも発生します。