Maven-plugins

提供:Dev Guides
移動先:案内検索

Maven-プラグイン

Mavenプラグインとは何ですか?

Mavenは実際にはすべてのタスクがプラグインによって実際に行われるプラグイン実行フレームワークです。 Mavenプラグインは一般的に使用されます-

  • jarファイルを作成する
  • 戦争ファイルを作成する
  • コードファイルをコンパイルする
  • コードの単体テスト
  • プロジェクトドキュメントを作成する *プロジェクトレポートを作成する

プラグインは通常、次の構文を使用して実行できる目標のセットを提供します-

mvn [plugin-name]:[goal-name]

たとえば、次のコマンドを実行することにより、maven-compiler-pluginのcompile-goalを使用してJavaプロジェクトをコンパイルできます。

mvn compiler:compile

プラグインの種類

Mavenは次の2種類のプラグインを提供しました-

Sr.No. Type & Description
1
  • Build plugins*

これらはビルドプロセス中に実行され、pom.xmlの<build/>要素で構成する必要があります。

2

Reporting plugins

これらはサイト生成プロセス中に実行され、pom.xmlの<reporting/>要素で構成する必要があります。

以下は、いくつかの一般的なプラグインのリストです-

Sr.No. Plugin & Description
1

clean

ビルド後にターゲットをクリーンアップします。 ターゲットディレクトリを削除します。

2

compiler

Javaソースファイルをコンパイルします。

3

surefire

JUnit単体テストを実行します。 テストレポートを作成します。

4

jar

現在のプロジェクトからJARファイルをビルドします。

5

war

現在のプロジェクトからWARファイルをビルドします。

6

javadoc

プロジェクトのJavadocを生成します。

7

antrun

ビルドの任意のフェーズからantタスクのセットを実行します。

例で maven-antrun-plugin を広く使用して、コンソールにデータを印刷しました。 ビルドプロファイルの章を参照してください。 よりよく理解して、C:\ MVN \ projectフォルダーにpom.xmlを作成してみましょう。

<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/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.companyname.projectgroup</groupId>
   <artifactId>project</artifactId>
   <version>1.0</version>
   <build>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-antrun-plugin</artifactId>
            <version>1.1</version>
            <executions>
               <execution>
                  <id>id.clean</id>
                  <phase>clean</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>clean phase</echo>
                     </tasks>
                  </configuration>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </build>
</project>

次に、コマンドコンソールを開き、pom.xmlを含むフォルダーに移動して、次の mvn コマンドを実行します。

C:\MVN\project>mvn clean

Mavenは、クリーンライフサイクルのクリーンフェーズの処理と表示を開始します。

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------
[INFO] Building Unnamed - com.companyname.projectgroup:project:jar:1.0
[INFO]    task-segment: [post-clean]
[INFO] ------------------------------------------------------------------
[INFO] [clean:clean {execution: default-clean}]
[INFO] [antrun:run {execution: id.clean}]
[INFO] Executing tasks
     [echo] clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------
[INFO] Total time: < 1 second
[INFO] Finished at: Sat Jul 07 13:38:59 IST 2012
[INFO] Final Memory: 4M/44M
[INFO] ------------------------------------------------------------------

上記の例は、次の重要な概念を示しています-

  • プラグインは、plugins要素を使用してpom.xmlで指定されます。
  • 各プラグインには複数の目標があります。 phase要素を使用して、プラグインが処理を開始する場所からフェーズを定義できます。 clean フェーズを使用しました。 *プラグインの目標にバインドすることにより、実行するタスクを構成できます。 echo タスクを_maven-antrun-plugin_の *run ゴールにバインドしました。
  • ローカルリポジトリで利用できない場合、Mavenはプラグインをダウンロードし、処理を開始します。