Maven-build-profiles

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

Maven-ビルドプロファイル

ビルドプロファイルとは何ですか?

ビルドプロファイルは設定値のセットであり、Mavenビルドのデフォルト値を設定または上書きするために使用できます。 ビルドプロファイルを使用すると、プロダクションv/s開発環境などのさまざまな環境に合わせてビルドをカスタマイズできます。

プロファイルは、activeProfiles/profiles要素を使用してpom.xmlファイルで指定され、さまざまな方法でトリガーされます。 プロファイルはビルド時にPOMを変更し、さまざまなターゲット環境(たとえば、開発、テスト、および運用環境でのデータベースサーバーのパス)にパラメーターを与えるために使用されます。

ビルドプロファイルの種類

ビルドプロファイルには、主に3つのタイプがあります。

Type Where it is defined
Per Project Defined in the project POM file, pom.xml
Per User Defined in Maven settings xml file (%USER_HOME%/.m2/settings.xml)
Global Defined in Maven global settings xml file (%M2_HOME%/conf/settings.xml)

プロファイルのアクティブ化

Mavenビルドプロファイルは、さまざまな方法でアクティブ化できます。

  • コマンドコンソール入力を明示的に使用します。
  • Maven設定を通じて。
  • 環境変数(ユーザー/システム変数)に基づきます。
  • OS設定(たとえば、Windowsファミリー)。
  • ファイルの存在/欠落。

プロファイルのアクティブ化の例

あなたのプロジェクトの次のディレクトリ構造を想定してみましょう-

Mavenビルドプロファイル

今、 src/main/resources の下に、3つの環境固有のファイルがあります-

Sr.No. File Name & Description
1

env.properties

プロファイルが記載されていない場合に使用されるデフォルト構成。

2

env.test.properties

テストプロファイルを使用する場合のテスト構成。

3

env.prod.properties

prodプロファイルが使用される場合の実動構成。

明示的なプロファイルのアクティブ化

次の例では、maven-antrun-plugin:runゴールを添付してフェーズをテストします。 これにより、さまざまなプロファイルのテキストメッセージをエコーできます。 pom.xmlを使用してさまざまなプロファイルを定義し、mavenコマンドを使用してコマンドコンソールでプロファイルをアクティブにします。

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>
   <profiles>
      <profile>
         <id>test</id>
         <build>
            <plugins>
               <plugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-antrun-plugin</artifactId>
                  <version>1.1</version>
                  <executions>
                     <execution>
                        <phase>test</phase>
                        <goals>
                           <goal>run</goal>
                        </goals>
                        <configuration>
                           <tasks>
                              <echo>Using env.test.properties</echo>
                              <copy file="src/main/resources/env.test.properties"
                                 tofile="${project.build.outputDirectory}
                                /env.properties"/>
                           </tasks>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
      </profile>
   </profiles>
</project>

コマンドコンソールを開き、pom.xmlを含むフォルダーに移動して、次の mvn コマンドを実行します。 -Pオプションを使用して、引数としてプロファイル名を渡します。

C:\MVN\project>mvn test -Ptest

Mavenは、テストビルドプロファイルの結果の処理と表示を開始します。

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------
[INFO] Building Unnamed - com.companyname.projectgroup:project:jar:1.0
[INFO] task-segment: [test]
[INFO] ------------------------------------------------------------------
[INFO] [resources:resources {execution: default-resources}]

[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources,
i.e. build is platform dependent!

[INFO] Copying 3 resources
[INFO] [compiler:compile {execution: default-compile}]
[INFO] Nothing to compile - all classes are up to date
[INFO] [resources:testResources {execution: default-testResources}]

[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources,
i.e. build is platform dependent!

[INFO] skip non existing resourceDirectory C:\MVN\project\src\test\resources
[INFO] [compiler:testCompile {execution: default-testCompile}]
[INFO] Nothing to compile - all classes are up to date
[INFO] [surefire:test {execution: default-test}]
[INFO] Surefire report directory: C:\MVN\project\target\surefire-reports

-------------------------------------------------------
T E S T S
-------------------------------------------------------

There are no tests to run.
Results :
Tests run: 0, Failures: 0, Errors: 0, Skipped: 0
[INFO] [antrun:run {execution: default}]
[INFO] Executing tasks
[echo] Using env.test.properties
[INFO] Executed tasks

[INFO] ------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------

[INFO] Total time: 1 second
[INFO] Finished at: Sun Jul 08 14:55:41 IST 2012
[INFO] Final Memory: 8M/64M
[INFO] ------------------------------------------------------------------

演習として、次の手順を実行できます-

  • pom.xmlのprofiles要素に別のprofile要素を追加します(既存のprofile要素をコピーして、profile要素が終了する場所に貼り付けます)。
  • このプロファイル要素のIDをtestからnormalに更新します。
  • タスクセクションを更新してenv.propertiesをエコーし​​、env.propertiesをターゲットディレクトリにコピーします。
  • 上記の3つの手順を繰り返し、idをprodに更新し、env.prod.propertiesのタスクセクションを更新します。
  • それで全部です。 これで、3つのビルドプロファイル(normal/test/prod)の準備ができました。

コマンドコンソールを開き、pom.xmlを含むフォルダーに移動して、次の mvn コマンドを実行します。 -Pオプションを使用して、プロファイル名を引数として渡します。

C:\MVN\project>mvn test -Pnormal

C:\MVN\project>mvn test -Pprod

ビルドの出力を確認して、違いを確認します。

Maven設定によるプロファイルのアクティブ化

%USER_HOME%/。m2ディレクトリで利用可能なMaven settings.xml ファイルを開きます。*%USER_HOME%*はユーザーのホームディレクトリを表します。 settings.xmlファイルがない場合は、新しいファイルを作成してください。

以下の例に示すように、アクティブプロファイルノードを使用して、テストプロファイルをアクティブプロファイルとして追加します。

<settings 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/settings-1.0.0.xsd">
   <mirrors>
      <mirror>
         <id>maven.dev.snaponglobal.com</id>
         <name>Internal Artifactory Maven repository</name>
         <url>http://repo1.maven.org/maven2/</url>
         <mirrorOf>*</mirrorOf>
      </mirror>
   </mirrors>
   <activeProfiles>
      <activeProfile>test</activeProfile>
   </activeProfiles>
</settings>

コマンドコンソールを開き、pom.xmlを含むフォルダーに移動して、次の mvn コマンドを実行します。 -Pオプションを使用してプロファイル名を渡さないでください。 Mavenは、アクティブなプロファイルであるテストプロファイルの結果を表示します。

C:\MVN\project>mvn test

環境変数を介したプロファイルのアクティブ化

次に、maven settings.xmlからアクティブなプロファイルを削除し、pom.xmlに記載されているテストプロファイルを更新します。 以下に示すように、アクティベーション要素をプロファイル要素に追加します。

テストプロファイルは、システムプロパティ「env」が値「test」で指定されたときにトリガーされます。 環境変数「env」を作成し、その値を「test」に設定します。

<profile>
   <id>test</id>
   <activation>
      <property>
         <name>env</name>
         <value>test</value>
      </property>
   </activation>
</profile>

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

C:\MVN\project>mvn test

オペレーティングシステムを介したプロファイルのアクティブ化

以下に示すように、OSの詳細を含めるアクティベーション要素。 このテストプロファイルは、システムがWindows XPの場合にトリガーされます。

<profile>
   <id>test</id>
   <activation>
      <os>
         <name>Windows XP</name>
         <family>Windows</family>
         <arch>x86</arch>
         <version>5.1.2600</version>
      </os>
   </activation>
</profile>

コマンドコンソールを開き、pom.xmlを含むフォルダーに移動して、次の mvn コマンドを実行します。 -Pオプションを使用してプロファイル名を渡さないでください。 Mavenは、アクティブなプロファイルであるテストプロファイルの結果を表示します。

C:\MVN\project>mvn test

存在/欠落ファイルによるプロファイルのアクティブ化

以下に示すように、OSの詳細を含めるためのアクティベーション要素になりました。 target/generated-sources/axistools/wsdl2java/com/companyname/group がない場合、テストプロファイルがトリガーされます。

<profile>
   <id>test</id>
   <activation>
      <file>
         <missing>target/generated-sources/axistools/wsdl2java/
           com/companyname/group</missing>
      </file>
   </activation>
</profile>

コマンドコンソールを開き、pom.xmlを含むフォルダーに移動して、次の mvn コマンドを実行します。 -Pオプションを使用してプロファイル名を渡さないでください。 Mavenは、アクティブなプロファイルであるテストプロファイルの結果を表示します。

C:\MVN\project>mvn test