LiferayプラグインSDKは、Liferay DXP 7.1では利用できません。 プラグインSDKの削除については、記事Deprecated Apps in 7.1: What To Doで詳細をご覧ください。 Liferay Workspaceは、Liferayの開発環境として定評のある、プラグインSDKの後継です。 GradleやMavenなどの代替ビルドシステムを使用していない場合は、これを使用する必要があります。
Workspaceの主な機能は次のとおりです。
- モジュールとコンポーネントのテンプレート
- サンプルプロジェクト
- ポータルサーバーの設定
- プロジェクト検証
- 統合テスト
- フォルダ構造の柔軟性
- プラグインを移行してLiferay DXPバンドルをインストールし、ポータルインスタンスを起動/停止するコマンド
このシリーズの後半のチュートリアルプラグインアップデートでは、Liferay開発スタジオで自動的に既存のプラグインをLiferay DXP 7.1に適応させる方法を説明します。 また、オプションで従来のプラグインをWorkspaceへ移行する方法を説明するチュートリアルも用意しています。
Workspaceフォルダ構造の例を以下に示します。
Workspaceの構造は次のとおりです。
bundles/（生成）→ Liferay DXPバンドルのデフォルトフォルダconfigs/→ ポータルサーバー設定を保持ext/→ ExtモジュールとExt WARファイルを保持gradle/→ Gradleラッパーファイルを保持modules/→ モジュールプロジェクトを保持plugins-sdk/（生成）→ 以前のリリースからのプラグインを保持themes/→ Liferay JS Theme Toolkitを使用するLiferay Theme Generatorで作成されたテーマプロジェクトを保持wars/→ 従来のWebアプリケーションプロジェクトを保持build.gradle→ 一般的なGradleビルドファイルgradle-local.properties→ ワークスペースのユーザー固有のプロパティを設定gradle.properties→ ポータルサーバー設定とプロジェクトロケーションの指定gradlew / gradlew.bat→ Gradleコマンドラッパーの実行pom.xml（Mavenによって生成されたWorkspaceのみ）→ 共通のMavenビルドファイルsettings.gradle→ Workspaceにプラグインを適用し、その依存関係を設定
ワークスペースモジュール、テーマ、およびWARプロジェクトは、同じポータルサーバー設定を使用します。 開発者は、モジュール開発、ユーザー受け入れテスト、本番などの設定を作成できます。
configs以下の各サブフォルダは、そのportal-ext.propertiesファイルによって定義されたポータルサーバー設定を保持します。 Workspaceのgradle.propertiesファイルのGradleプロパティliferay.workspace.environmentは、使用する設定を指定します。 詳細についてはTesting Projectsセクションを参照してください。
他のGradleプロパティは、Liferay DXPバンドル、モジュール、テーマ、およびプラグインSDKのルートロケーションを設定します。 利用可能なすべてのWorkspaceプロパティのリストについては、Gradle Workspace Propertiesセクションを参照してください。
Workspaceフォルダ構造のプロパティ
| プロパティ | 説明 |
|---|---|
liferay.workspace.environment | 使用するポータルサーバー設定を保持するconfigsサブフォルダの名前 |
liferay.workspace.ext.dir | Extプロジェクトのルートフォルダ |
liferay.workspace.home.dir | Liferay DXPバンドルのルートフォルダ |
liferay.workspace.modules.dir | モジュールプロジェクトのルートフォルダ |
liferay.workspace.plugins.sdk.dir | プラグインSDKのルートフォルダ |
liferay.workspace.themes.dir | テーマプロジェクトのルートフォルダ |
liferay.workspace.wars.dir | WARスタイルプロジェクトのルートフォルダ |
Workspaceには、プラグインSDK Antターゲットに相当するGradleタスクがあります。
プラグインSDKからWorkspaceへのタスクマップ
| プラグインSDK Antのターゲット | Workspace Gradleのタスク | タスクの説明 |
|---|---|---|
build-css | buildCSS | CSSファイルを構築します |
build-lang | buildLang | 言語ビルダーを使用して言語キーを翻訳します |
build-service | buildService | Service Builderを実行します |
clean | clean | すべてのビルド出力を削除します |
compile | classes | クラスをコンパイルします |
deploy | deploy (または blade deploy) | 現在のプロジェクトをLiferay DXPのOSGiフレームワークにインストールします |
jar | jar | プロジェクトをコンパイルし、JARファイルとしてパッケージ化します |
war | assemble | プロジェクトの出力を組み立てます |
その他のWorkspace Gradleのタスクは、追加機能を提供します。
| Workspace Gradleのタスク | タスクの説明 |
|---|---|
buildDB | 汎用SQLスクリプトからデータベースSQLスクリプトを構築します |
buildSoy | JavaScript関数でクロージャテンプレートをコンパイルします |
components | プロジェクトのコンポーネントをリストします |
configJSModules | Liferay DXPのコンボローダーを介して、AMDファイルをロードするために必要な設定ファイルを生成します |
dependencies | プロジェクトの宣言された依存関係をリストします |
formatSource | Liferay Source Formatterを実行してプロジェクトファイルをフォーマット化します |
initBundle | Liferay DXPバンドルをダウンロードしてインストールします |
model | プロジェクトの設定モデルをリストします |
projects | プロジェクトのサブプロジェクトをリストします |
properties | プロジェクトをリストします |
replaceSoyTranslation | goog.getMsg定義を置き換えます |
transpileJS | プロジェクトのJavaScriptファイルを変換します |
これはLiferay Workspaceで利用可能な、Gradleコマンドのサブセットです。 Gradleコマンドの完全なリストについては、ワークスペースのプロジェクトからgradlew tasksを実行します。