Maven Workspace

Liferay Maven Workspaceは、MavenでビルドされたLiferayプロジェクトの保持および管理のために構築された環境です。このワークスペースは、さまざまなMavenプラグインと設定済みのプロパティを適用することにより、Liferayプロジェクトの管理を支援します。Liferay Maven Workspaceが提供するMavenプロジェクトの完全な開発ライフサイクルにより、Liferay DXP向けの開発はこれまでになく簡単になります。このチュートリアルでは、Liferay Maven Workspaceの開発ライフサイクルを活用する方法を説明します。

まず最初に、Maven Workspaceをインストールする方法を説明します。

インストール

Maven Workspaceは、アーキタイプまたはBlade CLIからワークスペースプロジェクトを作成することによりインストールされます。以下のコマンドを実行すると、アーキタイプを介してワークスペースが作成できます。

mvn archetype:generate \
-DarchetypeGroupId=com.liferay \
-DarchetypeArtifactId=com.liferay.project.templates.workspace \
-DgroupId=[GROUP_ID] \
-DartifactId=[WORKSPACE_NAME] \
-Dversion=[VERSION]

Blade CLIがインストールされていて、アーキタイプを作成する代わりにそれを使用したい場合は、以下のコマンドを実行します。

blade init -b maven [WORKSPACE_NAME]

これで、Maven Workspaceが現在のフォルダに作成されます。Maven Workspaceには他のツールやCLIは必要ありません。

基本構造

デフォルトのMaven Workspaceには、以下のフォルダ/ファイルが含まれています。

• [MAVEN_WORKSPACE]
  • configs
    • common
    • dev
    • local
    • prod
    • uat
  • modules
    • pom.xml
  • themes
    • pom.xml
  • wars
    • pom.xml
  • pom.xml

configsフォルダの詳細については、Testing Modulesのセクションを参照してください。modules、themes、およびwarsフォルダは、このタイプのプロジェクトを保持します。 親pom.xmlは、ワークスペースをMavenプロジェクトとして設定し、Maven WorkspaceがLiferay DXP 7.1プロジェクトを処理するために必要なBundle Supportプラグインを適用します。POMでワークスペースプロパティを設定することもできます。この点ついては、後半で説明します。

次は、ワークスペースを使用したバンドルの初期化およびパッケージ化の方法について説明します。

LiferayバンドルをMaven Workspaceに追加する

Liferay Maven Workspaceは、Liferayサーバーの作成および保持ができます。これにより、実行中のLiferayインスタンスに対してプラグインをビルド/テストできます。Liferayインスタンスを作成する前に、ワークスペースのルートフォルダにあるpom.xmlファイルを開き、liferay.workspace.bundle.urlプロパティのダウンロードURLを設定して、作成およびインストールするLiferayバンドルのバージョンを設定します。例えば、

<properties>
<liferay.workspace.bundle.url>
https://releases-cdn.liferay.com/portal/7.1.0-ga1/liferay-ce-portal-tomcat-7.1.0-ga1-20180703012531655.zip
</liferay.workspace.bundle.url>
...
</properties>

Liferayバンドルの場所をliferay.workspace.home.dirプロパティで設定することもできます。これは、デフォルトではbundlesに設定されています。

**重要：**POMのcom.liferay.portal.tools.bundle.supportプラグインがバージョン3.2.0以降を使用するように設定されていることを確認してください。liferay.workspace.bundle.urlプロパティは、Bundle Supportプラグインの古いバージョンを使用するワークスペースでは機能しません。プラグインのアップデート方法については、Updating a Maven Workspaceのセクションを参照してください。

ワークスペースのプロパティを確定したら、ワークスペースのルートフォルダに移動して、以下を実行します。

blade server init

これは、ワークスペースの事前にバンドルされたBlade CLIツールを使用して、POMファイルで指定したLiferay DXPのバージョンをダウンロードし、bundlesフォルダにLiferay DXPインスタンスをインストールします。Blade CLIを使用しない場合、あるいはBlade CLIがインストールされていない場合、このコマンドに相当する純粋なMavenはmvn bundle-support:initです。

ダウンロードプロセスをスキップする場合は、ワークスペースのROOTフォルダにbundles手動でフォルダを作成し、Liferay Portalバンドルをそのフォルダに抽出できます。

また、ワークスペース内からディストリビューションが可能なLiferay DXPバンドル（Zip）を作成することもできます。これを行うには、ワークスペースのルートフォルダに移動し、以下のコマンドを実行します。

mvn bundle-support:dist

ディストリビューションファイルは、ワークスペースの/targetフォルダから入手できます。

Maven Workspaceのプロパティの設定方法

ルートのpom.xmlファイルで設定できるワークスペースプロパティは、いくつかあります。

• liferay.workspace.bundle.url: Liferay DXPバンドルのダウンロードに使用されるURL。 詳細については、Adding a Liferay Bundle to a Maven Workspaceを参照してください。
• liferay.workspace.environment: 使用するサーバー設定を保持するconfigsのサブフォルダの名前。詳細については、Testing Modulesを参照してください。

プロパティを設定するには、プロパティ名にタグを追加します。これらをPOMで設定する方法の例については、以下のプロパティ設定を参照してください。

<properties>
<liferay.workspace.bundle.url>https://releases-cdn.liferay.com/portal/7.1.0-ga1/liferay-ce-portal-tomcat-7.1.0-ga1-20180703012531655.zip</liferay.workspace.bundle.url>
<liferay.workspace.environment>local</liferay.workspace.environment>
</properties>

次は、Maven Workspaceにモジュール/プロジェクトを追加およびデプロイする方法を説明します。

モジュールの管理

Maven Workspaceによって、Mavenプロジェクトの管理はこれまでになく簡単になります。プロジェクトを作成するには、このタイプのためのプロジェクト（例: modules、warsなど）に適切なワークスペースのフォルダに移動します。次に、プロジェクトのアーキタイプを作成します。利用可能なアーキタイプの完全なリストは、Project Templatesセクションで表示できます。プロジェクトが作成されると、Maven Workspaceのすべての機能を活用できます。

Maven Workspaceでは、Mavenを使用してプロジェクトをLiferay DXPにデプロイすることもできます。詳細については 、Deploying a Project Built with Maven to Liferay DXPのチュートリアルを参照してください。

Maven Workspaceのテストインフラストラクチャを活用して、特定の環境でMavenプロジェクトをシミュレートすることも可能です。詳細については、Testing Modulesのセクションを参照してください。

Mavenプロジェクトが固まり、準備ができたら、プロジェクトを公開することをお勧めします。Maven Workspaceではリリース機能は提供されていませんが、ワークスペースで外部リリースツールを使用する簡単な方法があります。詳細については、Releasing Modulesセクションを参照してください。

次に、Maven Workspaceをアップデートする方法について説明します。

Maven Workspaceのアップデート

Liferay Workspaceは新しい機能と共に定期的にアップデートされるため、それに応じてワークスペースのインスタンスをアップデートすることをお勧めします。Maven Workspaceをアップデートするには、ワークスペースのルートpom.xmlファイルで設定されたBundle Supportプラグインを以下のようにアップデートする必要があります。

<plugin>
<groupId>com.liferay</groupId>
<artifactId>com.liferay.portal.tools.bundle.support</artifactId>
<version>3.2.5</version>
...
</plugin>

これで、バージョンが最新の利用可能なリリースにアップデートします。Bundle Supportプラグインの利用可能なリリースは、こちらで参照できます。