オプション

1. pluginのupdateを強制的に確認しつつ実行
   1. 「-U」オプション「-cpu」「--check-plugin-updates」の間違い。
      
2. offlineモード
   1. 「-o」
3. SNAPHOTのupdateを強制的に確認しつつ実行
1. 「-U」「--update-snapshots」
4. ヒープサイズの指定
   1. 環境変数「MAVEN_OPTS」に「-Xmx128m」とか。
5. サブプロジェクトを再帰的に処理しない。
1. 「-N」「--non-recursive」

各種プラグインの使い方（ヘルプ）を表示する

• mvn help:describe -Dplugin=${プラグインのgroupId}:${プラグインのartifactId}:${プラグインのバージョン}
  
• プラグインのバージョンは省略可能
  
• apache標準のプラグイン(groupId=org.apache.maven.plugins)のものは、groupIdは省略でき、artifactIdも省略形が使用できる。
• "full"パラメータをtrueに設定すると、詳細なヘルプが表示される。
• -Dfull=true
• "output"パラメータでファイル名を設定するとファイルに出力できる。
• -Doutput=target/help.txt

• helpプラグイン自体のヘルプを詳細に表示する。groupIdは省略して、artifactIdは省略形を使用した場合。
• mvn help:describe -Dplugin=help -Dfull=true
  
• codehausのwagonプラグインのヘルプを詳細に表示する。groupIdもartifactIdも指定した場合。
• mvn help:describe -Dplugin=org.codehaus.mojo:wagon-maven-plugin -Dfull=true
  

artifactの検索

Snapshotについて

version番号に"+-SNAPSHOT"にマッチする文字列を指定する事で、通常のartifactとは違う配布方式をとる事ができる。

deployする側

1. //distributionManagement/snapshotRepositoryで設定したServerに配布される。
2. //distributionManagement/snapshotRepository/uniqueVersionに"true"を設定すると、配 布する時のjar名が"artifactId-+-SNAPSHOT.jar"ではなく、"artifactId-+日付.時刻.jar"となる。

   <distributionManagement>
     <snapshotRepository>
       <id>ftp-hoge</id>
       <url>ftp://hoge/fuga</url>
     </snapshotRepository>
   </distributionMangement>
   

使用する側

1. repositories/repository/snapshots/updatePolicy要素に"always"を設定する事で「常に最新かどうかのチェックを行う」という動作をしてくれる。

   <repositories>
     <repository>
       <id>shin1</id>
       <url>http://hoge.fuga.com/shin1</url>
       <snapshots>
         <updatePolicy>always</updatePolicy>
       </snapshots>
     </repository>
   </repositories>
   

Repository

• Maven Snapshots
  <repository>
    <id>Maven Snapshots</id>
    <url>http://snapshots.maven.codehaus.org/maven2/</url>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
    <releases>
      <enabled>false</enabled>
    </releases>
  </repository>
• Codehaus Snapshots
  <pluginRepository>
    <id>Codehaus Snapshots</id>
    <url>http://snapshots.repository.codehaus.org/</url>
  </pluginRepository>
• eclipse関連
  <repository>
    <id>Eclipse</id>
    <url>http://repo2.maven.org/eclipse/</url>
  </repository>
• java.net
  <repository>
    <id>maven2-repository.dev.java.net</id>
    <name>Java.net Repository for Maven</name>
    <url>http://download.java.net/maven/2/</url>
    <layout>default</layout>
  </repository>
  <repository>
    <id>java.net</id>
    <url>http://download.java.net/maven/1</url>
    <layout>legacy</layout>
  </repository>
• coderepos
  <repository>
    <id>coderepos.org</id>
    <name>CodeRepos svn repository</name>
    <url>http://svn.coderepos.org/share/lang/java/misc/maven2repo</url>
  </repository>
  
• seasar
  <repositories>
    <repository>
      <id>maven.seasar.org</id>
      <name>The Seasar Foundation Maven2 Repository</name>
      <url>http://maven.seasar.org/maven2</url>
    </repository>
  </repositories>
• ローカルフォルダ
  <repository>
    <id>local</id>
    <url>file:${basedir}/lib</url>
  </repository>
  
• wicket stuff
  <repository>
    <id>wicket-stuff.org</id>
    <url>http://wicketstuff.org/maven/repository/</url>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>

Profile

各plugin

test

1. testをskipする。「-Dmaven.test.skip=true」
2. test対象を指定する。「-Dtest=hoge」ワイルドカードも使える。
3. testの失敗を無視して続行する。「-Dmaven.test.failure.ignore=true」

projecthelp,help

1. pom.xml内で省略されている、default設定を出力
   1. mvn projecthelp:effective-pom
2. 読み込んだsetting.xmlを出力
   1. mvn help:effective-settings -Doutput=effective-settings.xml

archetype

1. artifactの作成
   1. mvn archetype:create -DgroupId=${groupId} -DartifactId=${artifactId}
   2. [TODO]最近、どのマシンだかで使った場合に対話形式でGroupIdとかを設定できたんだが…？
      mvn archetype:generate
      だとarchetypeArtifctId他いくつかの属性値を対話形式で設定できる。
      
   3. 「archetypeArtifactId」属性でarchetypeの種類を指定できる。maven-archetype-webappなら webappとか。maven標準でないarchetypeArtifactを使う場合は「archeTypeGroupId」の指定も必要。

source

1. 生成物を全部削除して、ソースとjarをinstall
   1. mvn clean source:jar install
2. test-jarゴールを指定すると、テストソースがパッケージングされる。
   

compiler

1. java5の使用とソースのエンコードをutf-8に設定する。
   <plugin>
       <artifactId>maven-compiler-plugin</artifactId>
       <configuration>
           <source>1.5</source>
           <target>1.5</target>
           <encoding>UTF-8</encoding>
       </configuration>
   </plugin>

clean

1. cleanする時の削除対象のフォルダに、target以外も対象としたい時とか。
   <plugin>
       <artifactId>maven-clean-plugin</artifactId>
       <configuration>
           <filesets>
               <fileset>
                   <directory>${basedir}/lib</directory>
               </fileset>
           </filesets>
           <failOnError>false</failOnError>
       </configuration>
   </plugin>

package

• test-jarゴールを指定すると、テスト用のclassがパッケージングされる。
  ただし、testフェーズをskipする場合はtest-jarが作成されない。testを実行せずにtest-jarを作成したい場合は、以下のようにして「存在しないテストケースをtestパラメタで指定する」「test対象が存在しない場合にエラーを発生させない」という状態で実行する。
• -Dtest=DETARAMEPATTERN -DfailIfNoTests=false
  

dependency

1. 依存jarをlibとlib/sourcesに出力する。eclipseのpdeと併用する時に便利。
   <plugin>
       <artifactId>maven-dependency-plugin</artifactId>
       <executions>
           <execution>
               <id>jar</id>
               <phase>process-resources</phase>
               <goals>
                   <goal>copy-dependencies</goal>
               </goals>
               <configuration>
                   <outputDirectory>${basedir}/lib</outputDirectory>
                   <excludeGroupIds>org.eclipse,org.eclipse.ui</excludeGroupIds>
                   <includeScope>compile</includeScope>
                   <excludeScope>test</excludeScope>
                   <overWriteReleases>false</overWriteReleases>
                   <overWriteSnapshots>true</overWriteSnapshots>
                   <overWriteIfNewer>true</overWriteIfNewer>
               </configuration>
           </execution>
           <execution>
               <id>source-jar</id>
               <phase>process-resources</phase>
               <goals>
                   <goal>copy-dependencies</goal>
               </goals>
               <configuration>
                   <outputDirectory>${basedir}/lib/sources</outputDirectory>
                   <excludeGroupIds></excludeGroupIds>
                   <includeScope>compile</includeScope>
                   <excludeScope>test</excludeScope>
                   <overWriteReleases>false</overWriteReleases>
                   <overWriteSnapshots>true</overWriteSnapshots>
                   <overWriteIfNewer>true</overWriteIfNewer>
                   <classifier>sources</classifier>
                   <failOnMissingClassifierArtifact>false</failOnMissingClassifierArtifact>
               </configuration>
           </execution>
       </executions>
   </plugin>

unpack

1. 依存先artifactのjarも含めてcoberturaでカバレッジを取得したいとき。coberturaはclassファイルをカバレッジ対象とするので、${project.build.directory}へ依存先jarを解凍しておくとそれらのclassもカバレッジ対象となる。
2. test-jarに含まれているリソース類を共有したいとか。

• <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
      <execution>
        <id>unpack</id>
        <-- 使用用途によって実行フェーズをシビアに選択する必要がある事が多い -->
        <phase>process-resources</phase>
        <goals>
          <goal>unpack</goal>
        </goals>
        <configuration>
          <artifactItems>
            <artifactItem>
              <groupId>com.shin1ogawa</groupId>
              <artifactId>com.shin1ogawa.hoge</artifactId>
              <version>1.0.0-SNAPSHOT</version>
              <type>jar</type>
              <overWrite>false</overWrite>
              <outputDirectory>${project.build.directory}</outputDirectory>
            </artifactItem>
          </artifactItems>
          <excludes>*.txt, *.properties</excludes>
        </configuration>
      </execution>
    </executions>
  </plugin>
  

assembly

1. ソースをパッケージ(pom.xmlも含む)
   1. mvn assembly:assembly -DdescriptorId=src
2. 依存jarも含めてパッケージ
   1. mvn assembly:assembly -DdescriptorId=jar-with-dependencies

eclipse 

1. EclipseのProjectを生成する。 http://maven.apache.org/plugins/maven-eclipse-plugin/eclipse-mojo.html
1. mvn eclipse:eclipse
1. -DdownloadSources=true ならソースのjarの参照も付加。
2. -DdownloadJavadocs=true ならソースのjavadocの参照も付加。
2. EclipseのworkspaceにM2_REPOを設定する。
   1. maven eclipse:add-maven-repo -Declipse.workspace=XXXXX

• builderやnatureをpom.xmlでconfiguration/buildcommands, configuration/projectnatures, configuration/classpathContainers要素で指定する事ができる。
• .settings配下に配置する、リソースのエンコードの設定やフォーマッタの設定、jdtへの設定もconfiguration/additionlConfig/file要素で指定する事ができる。が、これらはでかくなりがちなので別ファイルにしておいたほうがいいのかも。
• wtpのバージョンもconfiguration/wtpversion要素で指定できる。

install

1. リポジトリに無いjarを手動で登録する(jtaの例)。

1. mvn install:install-file -DgroupId=javax.transaction -DartifactId=jta -Dversion=1.0.1B -Dpackaging=jar -Dfile=jta-1.0.1b.jar

jar

cargo

• pre-integration-testフェーズ
• tomcatをダウンロードし、tomcatを起動(startゴール)
• warをデプロイ(deployer-deployゴール)
• post-integration-testフェーズ
• tomcatを停止(stopゴール)

• http://cargo.codehaus.org/Maven2+plugin
• http://cargo.codehaus.org/Maven2+Plugin+Tips
• http://cargo.codehaus.org/Maven2+Plugin+Reference+Guide

jetty

その他plugin

ソースフォルダを複数指定したい時。

1. /build配下に以下の様な記述を行う。
   <sourceDirectory>src/src1</sourceDirectory>
   ...
   <plugin>
     <groupId>org.codehaus.mojo</groupId>
     <artifactId>build-helper-maven-plugin</artifactId>
     <executions>
       <execution>
         <id>add-source</id>
         <phase>generate-sources</phase>
         <goals>
           <goal>add-source</goal>
         </goals>
         <configuration>
           <sources>
             <source>src/src2</source>
             <source>src/src3</source>
           </sources>
         </configuration>
       </execution>
     </executions>
   </plugin>
2. testソースフォルダを追加したい場合は、上記の「add-source」が「add-test-source」となる。

特定のファイルを別マシンへscpなどしたい時

1. deployプラグインで別マシンへinstallする時と同じように、settings.xmlのservers要素の配下に転送先のserverの設定が必要。
   <server>
     <id>remotehost</id>
     <username>shin1ogawa</username>
     <password>password</password>
   </server>
2. pom.xmlはbuild/plugins配下に以下のように設定。この例ではpackageフェーズが実行されたタイミングで起動している。
   <plugin>
     <groupId>org.codehaus.mojo</groupId>
     <artifactId>wagon-maven-plugin</artifactId>
     <version>1.0-beta-1</version>
     <executions>
       <execution>
         <id>upload-jar</id>
         <phase>package</phase>
         <goals>
           <goal>upload</goal>
         </goals>
         <configuration>
           <serverId>remotehost</serverId>
           <url>scp://192.168.1.109/</url>
           <fromDir>target</fromDir>
           <includes>**/*.jar</includes>
           <excludes>*-sources.jar</excludes>
           <toDir>/home/shin1ogawa/tmp</toDir>
         </configuration>
       </execution>
     </executions>
   </plugin>
   

Reportについて

テンプレート

• surefire-report
• cobertura
• findbugs
• jxr
• pmd
• jdepend
  

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

  <modelVersion>4.0.0</modelVersion>
  <groupId>com.shin1o</groupId>
  <artifactId>com.shin1o.reportsample</artifactId>
  <packaging>jar</packaging>
  <version>1.0.0-SNAPSHOT</version>
  <name>com.shin1o.reportsample</name>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.4</version>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <!-- http://maven.apache.org/plugins/maven-compiler-plugin/ -->
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <encoding>UTF-8</encoding>
          <source>1.5</source>
          <target>1.5</target>
        </configuration>
      </plugin>
      <!-- surefire: http://maven.apache.org/plugins/maven-surefire-plugin/ -->
      <plugin>
        <artifactId>maven-surefire-plugin</artifactId>
        <configuration>
          <systemProperties>
            <property>
              <name>net.sourceforge.cobertura.datafile</name>
              <value>${basedir}/target/cobertura/cobertura.ser</value>
            </property>
          </systemProperties>
          <!-- スラッシュ区切り、javaを指定。
          <excludes>
            <exclude>com/shin1o/exclude/**/*.java</exclude>
          </excludes>
          -->
        </configuration>
      </plugin>
      <!-- surefire-report: http://maven.apache.org/plugins/maven-surefire-report-plugin/ -->
      <!-- testフェーズでもsurefire-reportが必要なら有効にする。
      <plugin>
        <artifactId>maven-surefire-report-plugin</artifactId>
        <executions>
          <execution>
            <phase>test</phase>
            <goals>
              <goal>report-only</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      -->
    </plugins>
  </build>

  <reporting>
    <plugins>
      <!-- jxr: http://maven.apache.org/plugins/maven-jxr-plugin/ -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jxr-plugin</artifactId>
        <configuration>
          <inputEncoding>UTF-8</inputEncoding>
          <outputEncoding>UTF-8</outputEncoding>
        </configuration>
      </plugin>
      <!-- cobertura: http://mojo.codehaus.org/cobertura-maven-plugin/ -->
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>cobertura-maven-plugin</artifactId>
        <configuration>
          <formats>
            <format>xml</format>
            <format>html</format>
          </formats>
          <instrumentation>
            <!-- ignoreはパッケージ名で指定。
            <ignores>
              <ignore>com.shin1o.exclude.*</ignore>
            </ignores>
            -->
            <!-- includes/excludesはスラッシュ区切り,classを指定
            <includes>
              <include>com/shin1o/include/**/*.class</include>
            </includes>
            <excludes>
              <exclude>**/*Test*.class</exclude>
            </excludes>
            -->
          </instrumentation>
        </configuration>
      </plugin>
      <!-- surefire-report: http://maven.apache.org/plugins/maven-surefire-report-plugin/ -->
      <plugin>
        <artifactId>maven-surefire-report-plugin</artifactId>
        <reportSets>
          <reportSet>
            <reports>
              <report>report-only</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      <!-- site: http://maven.apache.org/plugins/maven-site-plugin/ -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <configuration>
          <inputEncoding>UTF-8</inputEncoding>
          <outputEncoding>UTF-8</outputEncoding>
        </configuration>
      </plugin>
      <!-- javadoc: http://maven.apache.org/plugins/maven-javadoc-plugin/ -->
      <plugin>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          <author>true</author>
          <source>1.5</source>
          <showPackage>false</showPackage>
          <showPrivate>true</showPrivate>
          <encoding>UTF-8</encoding>
          <charset>UTF-8</charset>
          <docencoding>UTF-8</docencoding>
          <links>
            <link>http://java.sun.com/j2se/1.5.0/ja/docs/ja/api/</link>
          </links>
        </configuration>
      </plugin>
      <!-- project-info: http://maven.apache.org/plugins/maven-project-info-reports-plugin/ -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
      </plugin>
      <!-- jdepend: http://mojo.codehaus.org/jdepend-maven-plugin/ -->
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>jdepend-maven-plugin</artifactId>
      </plugin>
      <!-- pmd/cpd: http://maven.apache.org/plugins/maven-pmd-plugin/ -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-pmd-plugin</artifactId>
        <configuration>
          <linkXref>true</linkXref>
          <sourceEncoding>UTF-8</sourceEncoding>
          <minimumTokens>100</minimumTokens>
          <targetJdk>1.5</targetJdk>
        </configuration>
      </plugin>
      <!-- findbugs http://mojo.codehaus.org/findbugs-maven-plugin/ -->
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>findbugs-maven-plugin</artifactId>
        <configuration>
          <xmlOutput>true</xmlOutput>
          <effort>Max</effort>
        </configuration>
      </plugin>
      <!-- dashboard: http://maven.apache.org/plugins/dashboard-maven-plugin/ -->
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>dashboard-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </reporting>

  <repositories>
    <repository>
      <id>Maven Snapshots</id>
      <url>http://snapshots.maven.codehaus.org/maven2/</url>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
      <releases>
        <enabled>false</enabled>
      </releases>
    </repository>
  </repositories>

  <pluginRepositories>
    <pluginRepository>
      <id>Codehaus Snapshots</id>
      <url>http://snapshots.repository.codehaus.org/</url>
    </pluginRepository>
  </pluginRepositories>
</project>

依存性の定義について

maven公式|http://maven.apache.org/pom.html#Dependencies

optional

他から依存されたときに、無駄に依存を強制しないようにするため。例えば、自分は必ずhoge.jarが必要だが、自分に依存するartifactは必ずしも必要ないかもしれない、といった場合にoptional=trueを設定しておくと、行儀が良いかもしれない。

dependency/exclusions/exclusion

依存先の依存を引っ張ってこないようにする時は、ここで無視したいgroupIdとartifactIdを指定する。

親子関係の注意点

1. parentproject\trunk
   1. pom.xml
   2. subproject1
      1. pom.xml(parentprojectをparentとして指定)
   3. subproject2
   4. ...

こんな構成のとき、subproject1のみinstallしても、親のpom.xmlがリポジトリに無いときに別projetからsubproject1を解決できない。当たり前といえば当たり前だが、手を抜こうとして最初はまった。 

dependencyのテンプレート

大概追加している依存artifactのテンプレ。

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.5</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.hamcrest</groupId>
    <artifactId>hamcrest-library</artifactId>
    <version>1.1</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.easymock</groupId>
    <artifactId>easymockclassextension</artifactId>
    <version>2.4</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>aopalliance</groupId>
    <artifactId>aopalliance</artifactId>
    <version>1.0</version>
</dependency>
<dependency>
    <groupId>commons-lang</groupId>
    <artifactId>commons-lang</artifactId>
    <version>2.4</version>
</dependency>
<dependency>
    <groupId>commons-collections</groupId>
    <artifactId>commons-collections</artifactId>
    <version>3.2.1</version>
</dependency>
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>1.4</version>
</dependency>
<dependency>
    <groupId>commons-beanutils</groupId>
    <artifactId>commons-beanutils</artifactId>
    <version>1.8.0</version>
    <exclusions>
        <exclusion>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.5.6</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.5.6</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>0.9.15</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>0.9.15</version>
</dependency>