Maven プロジェクトレポートの作成

2024-04-242024
31.3% (114.8/366)
April
79.6% (23.8/30)
Week 17
41.1% (2.8/7)
Day 24 Wed
88.2% (21.1/24)

訪問者

total: 33920
today: 9
yesterday: 3
now: 12

↑

更新

MenuBar

pom.xml
maven-javadoc-plugin
maven-jxr-plugin
maven-checkstyle-plugin
surefire-report-maven-plugin
maven-pmd-plugin
taglist-maven-plugin
cobertura-maven-plugin
maven-findbugs-plugin
JavaNCSS Plugin
作成したプロジェクトサイトをWebサーバにコピーしたい
test が 2回走る対策
JaCoCo (yet another cobertura)

pom.xml †

pom.xml に maven-site-plugin を登録し、locale に jp を設定します。
- 何も設定しない場合には英語版のみが出力される
- 複数の言語のプロジェクトレサイトを作る場合には en,jp などカンマ区切りで指定する
~~pom.xml の <reporting> に、レポートを出力する plugin を追記します。~~ ~~← Maven3 からやり方が変わった~~
~~maven-site-plugin の <configuration> にレポートを出力する plugin を追記します~~ ← maven-site-plugin 3.3 から Maven 2 の書き方に戻った https://maven.apache.org/plugins/maven-site-plugin/maven-3.html
```
[削除] pom.xml の コード例
```
Maven 3.3 からの書き方は → Maven Site
あとは、mvn site を実行すると
Project Documentation と一緒にレポートが出力されます。

↑

maven-javadoc-plugin †

http://maven.apache.org/plugins/maven-javadoc-plugin/
Javadoc を出力するための plugin です

日本語を出力するためには以下の設定が必要です

<docencoding>UTF-8</docencoding>
<charset>UTF-8</charset>
<encoding>UTF-8</encoding>
<bottom>Copyright &amp;copy; 2007-2008 SNAIL LTD. AllRights Reserved.</bottom>

出力結果

↑

maven-jxr-plugin †

http://maven.apache.org/plugins/maven-jxr-plugin/
JavaのソースコードをHTMLとして出力します。ここで出力された HTML は、他のいろいろな plugin からのリンク先となります。

日本語を出力するためには以下の設定が必要です

<inputEncoding>MS932</inputEncoding>
<outputEncoding>UTF-8</outputEncoding>

出力結果
現在のところ、[View Javadoc] のリンク先が上手く生成されません。夜間バッチで、mnv site を動かすのであれば、一緒に sed か何かで置換してあげる必要があるかもしれない。

↑

maven-checkstyle-plugin †

http://maven.apache.org/plugins/maven-checkstyle-plugin/
Check Style を使って、ソースコードがコーディング規約に則っているかを調べます
エラー箇所は、maven-jxr-plugin で作成された html へのリンクが作られます
出力結果
早速 package.html がないと怒られています
- なんで、**/*.java しかチェックしていないはずなのに・・・と、少し悩んでしまいました
- SUN のコーディング規約上は、ソースコードの package ディレクトリには、package.html が要るのね
- src/main/java/com/snail/hello/package.html を作ってあげます
```
<html>
<body>
このパッケージには、テストプログラムが入っています。
</body>
</html>
```
コーディング規約を変えたい
```
<plugin>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <configuration>
    <inputEncoding>UTF-8</inputEncoding>
    <outputEncoding>UTF-8</outputEncoding>
    <configLocation>src/conf/checkstyle/my-checks.xml</configLocation>
  </configuration>
</plugin>
```
- pom.xml の <configuration> で、コーディング規約を定義することが出来る
- 同じファイルを Eclipse-CS プラグインからも使うことが出来るので、Eclipse で規約違反の例外を消しておくと、プロジェクトレポートの警告もなくなる。

↑

surefire-report-maven-plugin †

http://maven.apache.org/plugins/maven-surefire-report-plugin/
すべてのユニットテストを実行して、テストレポートをまとめます
エラー箇所は、maven-jxr-plugin で作成された html へのリンクが作られます
出力結果

普段は、テストをやらない

<plugin>
 <artifactId>maven-surefire-plugin</artifactId>
 <configuration>
   <!-- テストをスキップしたいとき --> 
   <skip>true</skip>
 </configuration>
</plugin>

Maven管理下にないライブラリをテストで使うとき

<plugin>
 <artifactId>maven-surefire-plugin</artifactId>
 <configuration>
   <additionalClasspathElements>
     <additionalClasspathElement>src/main/webapp/WEB-INF/lib/myFrameWork.jar</additionalClasspathElement>
     <additionalClasspathElement>src/main/webapp/WEB-INF/lib/myUtil.jar</additionalClasspathElement>
   </additionalClasspathElements>
 </configuration>
</plugin>

テストクラスを特定のクラスだけにする

<plugin>
 <artifactId>maven-surefire-plugin</artifactId>
 <configuration>
   <includes>
     <include>**/*Test.java</include>
   </includes>
 </configuration>
</plugin>

↑

maven-pmd-plugin †

http://maven.apache.org/plugins/maven-pmd-plugin/
PMD(ソースコード上の問題点) と CPD(コピペ箇所) のレポートを出力します。
出力結果

↑

taglist-maven-plugin †

http://maven.apache.org/plugins/taglist-maven-plugin/
ソースコード中の TODO の一覧を作ります
今のところ日本語は文字化けします(ソースコードの文字コードを指定するオプションが無い)
出力結果

↑

cobertura-maven-plugin †

http://maven.apache.org/plugins/cobertura-maven-plugin/
Unitテストのカバレッジを調べるプラグイン

↑

maven-findbugs-plugin †

http://mojo.codehaus.org/findbugs-maven-plugin/
FindBugs? で危険なコードがないかを調べます

↑

JavaNCSS Plugin †

http://mojo.codehaus.org/javancss-maven-plugin/index.html
NCSS(Non Commenting Source Statements)。要するに実効行数のレポートを調べるplugin
日本語が書いてある行で JavaNCSS Plugin が失敗するときには、pom.xml に、ソースの文字コードを指定する
- http://docs.codehaus.org/display/MAVENUSER/POM+Element+for+Source+File+Encoding
- Maven 3
```
<project>
 <build>
   <sourceEncoding>UTF-8</sourceEncoding>
 </build>
</project>
```
- Maven2
```
<project>
 <properties>
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 </properties>
</project>
```

↑

作成したプロジェクトサイトをWebサーバにコピーしたい †

pomの最後( ルートタグの子要素になる )に次の記述を付け足す

<distributionManagement>
  <site>
    <id>website</id>
    <url>file://D:/TracLight/reports/myproject</url>
  </site>
</distributionManagement>

url には、ftp や scp も使える

mvn site ではなく、mvn site-deploy を実行する。
Hudson などの CI*1アプリを使って、毎晩自動的にサイトレポートが作られ Web サーバにアップロードされているようにする
- 毎朝プロジェクトの状況を正確に把握できて( ﾟДﾟ)うまー
  - クラス数
  - テスト合格率
  - テストカバレッジ
  - TODO コメントの数
  - Check Style によるコーディング規約のチェック結果
  - など・・・
- あるいは、毎朝状況が絶望的なことが明らかになって(´д`)まずーかもれしないが・・・

↑

test が 2回走る対策 †

実行コマンドとして mvn site ではなく、mvn surefire-report:report-only を使う
http://maven.apache.org/plugins/maven-surefire-report-plugin/
Maven2のテストフェーズについてあれこれ、とある誰かの覚え書き、2009

↑

JaCoCo? (yet another cobertura) †

http://www.eclemma.org/jacoco/trunk/doc/maven.html
カバレッジ集計用 plugin
老舗の Cobertura の対抗馬
Eclipse で EclMMA plugin を使っている場合には、エンジンが同じ JaCoCo? を使った方が良いかも

Java Maven