NetBeans SQE (Check Style, Find Bugs, PMD, Dependency Finder)

目次

FrontPage
・Windows11
・Chromebook
・Random
・機械学習
・さくらVPS
・Fedora13
・SuSe10
・Docker
・Ansible
・Java
・Scala
・Python
・Ruby
・Lisp
・Computer
・GIS
・HTML
・Culture
・Link

訪問者

total: 14642
today: 1
yesterday: 1
now: 1

更新

最新の10件

人気の10件

MenuBar

整理中

SQE のインストール †

• SQE (Software Quality Environment) は、Java の世界におけるソース静的解析の定番アプリを Net Beans から使うための plugin
  • Find Bugs
  • PMD
  • Check Style
  • Dependency Finder
• http://kenai.com/projects/sqe/pages/Home

1. [ツール]-[プラグイン]-[設定] で、SQE の配布サイト( http://deadlock.netbeans.org/hudson/job/sqe/lastStableBuild/artifact/build/full-sqe-updatecenter/updates.xml )を追加
   
2. [使用可能なプラグイン] から、Find Bugs、PMD、Check Style、Dependency Finder をインストール
   

SQE によるコードの静的解析 †

1. ツールバーに、コードチェックと、依存関係チェックを起動するためのアイコンができる
   
2. プロジェクトを選択して、コードチェックを動かすと、結果が一覧表示される
   
3. プロジェクトを選択して、依存関係チェックを動かすと、結果が出力される。パッケージ単位での依存関係が図示される
   

Find Bugs のメッセージ文字化け対策 †

• 文字コードが UTF-8 の環境だと、findbugs のメッセージが文字化けする
  
• SQE に付属している findbugs のメッセージファイルの文字コードを UTF-8 に変更する必要がある
  1. SQE に付属している findbugs.jar を展開

     $ pwd
     /Applications/NetBeans/NetBeans 7.0.app/Contents/Resources/NetBeans/sqe/modules/ext
     $ ls
     DependencyFinder.jar            checkstyle.jar                  jaxen-dom4j-adapter.jar
     annotations.jar                 commons-beanutils-core.jar      jaxen.jar
     antlr.jar                       commons-lang.jar                jcommon.jar
     asm-3.1.jar                     dom4j.jar                       jfreechart-experimental.jar
     asm-analysis-3.1.jar            fb-bcel.jar                     jfreechart.jar
     asm-commons-3.1.jar             findbugs-ant.jar                jsr305.jar
     asm-tree-3.1.jar                findbugs.jar                    log4j.jar
     asm-util-3.1.jar                google-collections.jar          plugin
     asm-xml-3.1.jar                 jFormatString.jar               pmd.jar
     buggy.icns                      jakarta-oro.jar
     $ mv findbugs.jar findbugs.jar.original
     $ mkdir tmp
     $ cd tmp                 
     $ jar -xf ../findbugs.jar.original

  2. メッセージファイルを UTF-8 に変換する

     $ pwd
     /Applications/NetBeans/NetBeans 7.0.app/Contents/Resources/NetBeans/sqe/modules/ext/tmp
     $ ls
     META-INF                fancy-hist.xsl          messages.xml            summary.xsl
     bugcollection.xsd       fancy.xsl               messages_fr.xml         version.properties
     bugrank.txt             findbugs.xml            messages_ja.xml
     default.xsl             findbugsplugin.xsd      net
     edu                     messagecollection.xsd   plain.xsl
     $ mv messages_ja.xml messages_ja.xml.original
     $ cat messages_ja.xml.original | iconv -f sjis -t utf-8 | sed -e "s/Shift_JIS/UTF-8/" > messages_ja.xml

     sed は、<?xml version="1.0" encoding="Shift_JIS"?> を <?xml version="1.0" encoding="UTF-8"?> に変換している
  3. 圧縮

     $ pwd
     /Applications/NetBeans/NetBeans 7.0.app/Contents/Resources/NetBeans/sqe/modules/ext/tmp
     $ jar -cf ../findbugs.jar *

  4. あとかたづけ

     $ cd ..
     $ pwd
     /Applications/NetBeans/NetBeans 7.0.app/Contents/Resources/NetBeans/sqe/modules/ext
     $ rm -rf tmp

• これで正常に表示されるようになった
  

SQE 共通設定 †

• 特にプロジェクト側で設定していない場合には、SQE 共通設定が使われる

Findbugs のチェックルール変更 †

• [NetBeans?]-[環境設定]
  
• FindBugs? Bug Descriptions → http://findbugs.sourceforge.net/bugDescriptions.html
• NRI FindBugs? 利用ガイド → http://works.nri.co.jp/service/pdf/FindBugs.pdf

PMD のチェックルール変更 †

• [NetBeans?]-[環境設定]
• PMD Rulesets Index → http://pmd.sourceforge.net/rules/index.html
  

Check Style のチェックルール変更 †

• [NetBeans?]-[環境設定]
  
• SQE には、Check Style ルールの GUI エディタは付いていない
• ファイルを直接編集する必要あり

  [~/.netbeans/7.0/config/Preferences/org/nbheaven/sqe/codedefects]$ ls
  checkstyle.properties           checkstyle.xml                  custom-checkstyle.properties

• Checkstyle 5.3 → http://checkstyle.sourceforge.net/
• とりあえず編集する必要があるのは (特に Windows 環境で必須)
  • 文字コード

    <module name="Checker">
      <property name="charset" value="UTF-8"/>
      ...
    </module>

    • Checker に、charset = UTF-8 を設定
    • 5.2 までは Tree Walker モジュールの配下に設定していた
    • http://checkstyle.sourceforge.net/config.html
  • 改行コード

    <module name="NewlineAtEndOfFile">
      <property name="lineSeparator" value="lf"/>
      <property name="fileExtensions" value="java, xml, py"/>
    </module>

    • NetBeans? の改行コードは LF
    • Windows 環境では、改行コードは CR+LF なので、New Line At End Of File (最終行に空行があるか)チェックのパラメータに改行コードが LF であることを明示する必要がある
    • http://checkstyle.sourceforge.net/config_misc.html

Maven連携 †

• Mavenプロジェクトの場合には、SQE は、pom.xml に設定されている Findbugs、PMD、Checkstyle のチェックルールを使う。(設定されていなければ共通定義を使う)
• 以下整理中

Findbugs †

PMD †

Checkstyle †

• http://maven.apache.org/plugins/maven-checkstyle-plugin/index.html
• http://maven.apache.org/plugins/maven-checkstyle-plugin/checkstyle-mojo.html
  • configLocation は、普通はファイルを指定。ただし、次の4つは組み込みのモノが使われる

    There are 4 predefined rulesets.
    
       config/sun_checks.xml: Sun Checks.
       config/turbine_checks.xml: Turbine Checks.
       config/avalon_checks.xml: Avalon Checks.
       config/maven_checks.xml: Maven Source Checks.

Default value is: config/sun_checks.xml.

• sun_checks.xml って、どこに有んの？
  • http://www.masatom.in/pukiwiki/Maven/Checkstyle%A5%D7%A5%E9%A5%B0%A5%A4%A5%F3/ 曰 /home/[userid]/.maven/plugins/maven-checkstyle-plugin-2.3
  • Mac OS X ではどこ？

Java#NetBeans