Liferay Workspaceは、開発ニーズに合わせて設定できる開発環境を提供します。ここでは、ワークスペースがデフォルトで提供するファイル/フォルダについて説明し、それから、ワークスペースを設定します。
Liferay (Gradle) Workspaceの最上位ファイル/フォルダの概要は、以下のとおりです。
bundles（作成済み）: Liferay DXPバンドルのデフォルトフォルダ。configs: さまざまな環境の設定ファイルを保持します。これらのファイルは、ワークスペースにあるすべてのLiferay DXPサーバーおよびプロジェクトのグローバル設定ファイルとして機能します。configsフォルダの使用の詳細については、Testing Modulesのセクションを参照してください。ext（作成済み）: Ext OSGiモジュールとExtプラグインを保持しています。gradle: ワークスペースで使用される、Gradleラッパーを保持しています。modules: カスタムモジュールを保持しています。これは、Liferay JS Toolkitで作成されたフロントエンドのポートレットも保持でき ます。plugins-sdk（作成済み）: 以前のリリースから移行するプラグインを保持しています。 これらのプロジェクトタイプは、可能であれば最終的にwarsフォルダに移行させる必要があります。これはLiferay DXP 7.0を対象としており、Plugins SDKからLiferay Workspaceに移行する方法を提供します。詳細については、Using a Plugins SDK from Your Workspaceのセクションを参照してください。Plugins SDKは、Liferay DXP 7.1では使用できなくなりました。themes: Liferay Theme Generatorを使用して構築されたLiferay JS Theme Toolkitを使用する、Node.jsスタイルのテーマを保持しています。wars: 従来のWARスタイルのWebアプリケーションプロジェクトとテーマプロジェクト（つまり、themeプロジェクトテンプレートによって作成されたものなど）を保持します。build.gradle: 一般的なGradleビルドファイル。gradle.properties: ワークスペースのプロジェクトの場所とLiferay DXPのサーバー設定をグローバルに指定します。gradle-local.properties: ワークスペースのユーザー固有のプロパティを設定します。 これにより、複数のユーザーが単一のワークスペースを使用して、自分のマシン上のワークスペースに特定のプロパティを設定することができます。gradlew: Gradleコマンドラッパーを実行します。settings.gradle: プラグインをワークスペースに適用し、その依存関係を設定します。
LiferayのMaven Workspaceを代わりに使用している場合は、フォルダ階層は同じですが、Gradleビルドファイルがpom.xmlファイルにスワップアウトされています。このようなワークスペースプロジェクトの設定方法の詳細については、Maven Workspaceチュートリアルを参照してください。
ワークスペースのルートフォルダに含まれるビルド/プロパティファイルは、ワークスペースのGradleプロパティを設定し、モジュールのビルドプロセスを促進します。
ワークスペースの使用を開始する前に、gradle.propertiesファイルにお使いのワークスペースのGradleプロパティを設定する必要があります。このファイルには、多くのコメント化されたプロパティがあります。これらは、ワークスペースで設定されるデフォルトのプロパティです。
変数を変更する場合は、変数のコメントを外して、カスタム値に設定します。たとえば、モジュールを[ROOT]/modules以外のフォルダに保存する場合、liferay.workspace.modules.dir変数のコメントを外して、別の値に設定します。
グローバルなGradleプロパティを維持しつつ、それらを自分用に（たとえば、ローカルテスト用に）変更したい場合は、gradle.propertiesファイルを独自のgradle-local.propertiesファイルで上書きすることができます。
gradle.propertiesファイル内のすべてのプロパティは、ファイル内にドキュメント化されています。
各プロパティの機能と利用可能な機能の詳細については、ワークスペースで作成されたgradle.propertiesファイルにアクセスしてください。また、これらのプロパティのリストについては、Gradle Workspace Propertiesのセクションを参照してください。
これで、ワークスペースのデフォルトのフォルダ構造と、Gradleプロパティを変更する方法がわかったので、次にLiferayバンドルをワークスペースに追加する方法を説明します。
Liferayバンドルをワークスペースに追加する
Liferay Workspaceは、Liferayサーバーを作成および保持することができます。これにより、実行中のLiferayインスタンスに対してプラグインをビルド/テストできます。Liferayインスタンスを作成する前に、ワークスペースのルートフォルダにあるgradle.propertiesファイルを開きます。ワークスペースのLiferayインスタンスには、設定可能なプロパティがいくつかあります。liferay.workspace.bundle.urlプロパティのダウンロードURLを設定することにより、作成およびインストールを希望しているLiferayバンドルのバージョンを設定できます（例: https://releases-cdn.liferay.com/portal/7.1.0-ga1/liferay-ce-portal-tomcat-7.1.0-ga1-20180703012531655.zip）。
また、Liferayバンドルが作成されるフォルダはliferay.workspace.home.dirプロパティで設定することもできます。デフォルトでは、bundlesに設定されています。
DXPサブスクライバーの場合は、ワークスペース用のLiferay DXPバンドルをダウンロードできます。これを行うには、liferay.workspace.bundle.urlプロパティをapi.liferay.comでホストされているZIPに設定します。例えば、
liferay.workspace.bundle.url=https://api.liferay.com/downloads/portal/7.1.10/liferay-dxp-tomcat-7.1.10-ga1-20180703090613030.zip
必要なDXPバンドルの完全に修飾されたZIP名/番号を見つけるのが難しい場合があります。LiferayのAPIサイトに直接アクセスして見つけることはできないため、DXPのダウンロードを手動で開始し、ファイル名をメモして、それをhttps://api.liferay.com/downloads/portal/に付ける必要があります。
また、liferay.workspace.bundle.token.downloadプロパティをtrueに設定して、ワークスペースがLiferayのAPIサイトにアクセスできるようにする必要があります。
Gradleプロパティを確定したら、ワークスペースのルートフォルダに移動して、以下を実行します。
blade server init
これは、ワークスペースの事前にバンドルされたBlade CLIツールを使用して、Gradleプロパティで指定したLiferay DXPバージョンをダウンロードし、Liferayインスタンスをbundlesフォルダにインストールします。
ダウンロードプロセスをスキップする場合は、ワークスペースのROOTフォルダにbundlesフォルダを手動で作成し、Liferay DXPバンドルをそのフォルダに解凍します。
ワークスペース内から、ディストリビューションが可能なLiferayバンドル（ZipまたはTar）を作成することもできます。これを行うには、ワークスペースのルートフォルダに移動し、以下のコマンドを実行します。
./gradlew distBundle[Zip|Tar]
ディストリビューションファイルは、ワークスペースの/buildフォルダから入手できます。
Liferay Workspaceは、Liferayモジュール開発のための優れた開発環境です。Liferay WorkspaceでWARスタイルのアプリケーションの開発も行いたい場合、それも可能です。
Gradle Workspaceのプロパティ
ワークスペースのgradle.propertiesファイルでは、以下の設定可能なプロパティが使用できます。
liferay.workspace.bundle.cache.dir: ダウンロードしたバンドルのZipファイルが保存されるディレクトリを設定します。デフォルト値は、ユーザーホームディレクトリ内の.liferay/bundlesフォルダです。liferay.workspace.bundle.token.download:liferay.workspace.bundle.urlプロパティがDXPバンドルZipに設定されている場合に、これをtrueに設定します。このプロパティを使用すると、~/.liferayフォルダにあるトークンを使用して、バンドルをダウンロードするときにユーザー資格情報を検証できます。デフォルト値は、falseです。liferay.workspace.bundle.token.email.address: DXPバンドルのダウンロード時に使用するメールアドレスを設定します。これは、認証トークンを作成するために使用されます。メールアドレスは、DXPサブスクリプションに登録されているものと一致する必要があります。このファイルにメールアドレスとパスワードを入力せずに新しいトークンを作成したい場合は、Liferayプロファイルの[アカウント設定]ページに移動し、[認証トークン]メニューでトークンを作成することにより、手動で作成できます。トークンは、~/.liferayフォルダ内に存在する必要があります。liferay.workspace.bundle.token.force: これをtrueに設定して、既存のトークンをcreateTokenタスクによって新しく作成されたトークンでオーバーライドします。デフォルト値は、falseです。liferay.workspace.bundle.token.password: DXPバンドルをダウンロードするときに使用するパスワードを設定します。これは、認証トークンを作成するために使用されます。パスワードは、DXPサブスクリプションに登録されているものと一致する必要があります。詳細については、liferay.workspace.bundle.token.email.addressプロパティを参照してください。liferay.workspace.bundle.token.password.file: Liferayバンドルの認証トークンのパスワードを保持するように、ファイルを設定します。デフォルトのファイル値は、~/.liferay/tokenです。liferay.workspace.bundle.url: ダウンロードするバンドルZipを指すURLを設定します。URLがDXPバンドルを指す場合（例: https://api.liferay.com/…）、liferay.workspace.bundle.token.downloadプロパティをtrueに設定します。デフォルト値は、Liferay Portal CEの最新バージョンのURLです。liferay.workspace.default.repository.enabled: これをtrueに設定して、Liferay CDNをルートプロジェクトのデフォルトリポジトリとして設定します。デフォルト値は、trueです。liferay.workspace.environment: 現在の開発に適した設定で環境を設定します。configsフォルダは、同じワークスペースで異なる環境を保持するために使用されます。環境設定を整理し、その設定で環境インストールを作成できます。common、dev、local、prod、およびuatの五つの環境があります。デフォルト値は、localです。liferay.workspace.home.dir:liferay.workspace.bundle.urlプロパティからダウンロードしたLiferayバンドルを含むフォルダを設定します。デフォルト値は、bundlesです。liferay.workspace.modules.default.repository.enabled: これをtrueに設定して、Liferay CDNをモジュール/OSGiプロジェクトのデフォルトリポジトリとして設定します。デフォルト値は、trueです。liferay.workspace.ext.dir: すべてのExt OSGiモジュールとExtプラグインを含むフォルダを設定します。デフォルト値は、extです。liferay.workspace.modules.dir: すべてのモジュール/OSGiプロジェクトを含むフォルダを設定します。デフォルト値は、modulesです。liferay.workspace.modules.jsp.precompile.enabled: これをtrueに設定して、OSGiモジュールのJSPファイルをコンパイルし、ディストリビューションが可能なZip/Tarに追加します。デフォルト値は、falseです。liferay.workspace.plugins.sdk.dir: Plugins SDK環境を含むフォルダを設定します。デフォルト値は、plugins-sdkです。liferay.workspace.target.platform.version: Liferay PortalまたはDXPバンドルのバージョンを開発対象に設定します。このプロパティは、OSGiのresolveタスクや特殊な依存関係の管理などのターゲットプラットフォーム機能を有効にします。Liferay CEの最新リリースには7.1.1、DXPの最新リリースには7.1.10を使用してください。liferay.workspace.themes.dir: Liferay JS Theme Toolkitを使用している、Node.jsスタイルのテーマプロジェクトを含んだフォルダを設定します。デフォルト値は、themesです。liferay.workspace.themes.java.build: Liferay Portal Tools Theme Builderを使用してテーマプロジェクトをビルドするには、これをtrueに設定します。デフォルト値は、falseです。liferay.workspace.wars.dir: 従来のWARスタイルのプロジェクトを含んでいるフォルダを設定します。デフォルト値は、warsです。
これで、Liferay Workspaceを完全に活用するための準備が整いました。