プラグインSDKからLiferay Workspaceへ

LiferayプラグインSDKは、Liferay DXP 7.1では利用できません。 プラグインSDKの削除については、記事Deprecated Apps in 7.1: What To Doで詳細をご覧ください。 Liferay Workspaceは、Liferayの開発環境として定評のある、プラグインSDKの後継です。 GradleやMavenなどの代替ビルドシステムを使用していない場合は、これを使用する必要があります。

Workspaceの主な機能は次のとおりです。

このシリーズの後半のチュートリアルプラグインアップデートでは、Liferay開発スタジオで自動的に既存のプラグインをLiferay DXP 7.1に適応させる方法を説明します。 また、オプションで従来のプラグインをWorkspaceへ移行する方法を説明するチュートリアルも用意しています。

図1:LiferayDev Studio DXPのUpgrade Plannerは、プラグインのアップグレードプロセスにおける多くの面を自動化します。

Workspaceフォルダ構造の例を以下に示します。

図2:Liferay Workspaceはプロジェクトを集約し、同じサーバー設定とGradleビルド環境を使用します。

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.dirExtプロジェクトのルートフォルダ
liferay.workspace.home.dirLiferay DXPバンドルのルートフォルダ
liferay.workspace.modules.dirモジュールプロジェクトのルートフォルダ
liferay.workspace.plugins.sdk.dirプラグインSDKのルートフォルダ
liferay.workspace.themes.dirテーマプロジェクトのルートフォルダ
liferay.workspace.wars.dirWARスタイルプロジェクトのルートフォルダ

Workspaceには、プラグインSDK Antターゲットに相当するGradleタスクがあります。

プラグインSDKからWorkspaceへのタスクマップ

プラグインSDK AntのターゲットWorkspace Gradleのタスクタスクの説明
build-cssbuildCSSCSSファイルを構築します
build-langbuildLang言語ビルダーを使用して言語キーを翻訳します
build-servicebuildServiceService Builderを実行します
cleancleanすべてのビルド出力を削除します
compileclassesクラスをコンパイルします
deploydeploy (または blade deploy)現在のプロジェクトをLiferay DXPのOSGiフレームワークにインストールします
jarjarプロジェクトをコンパイルし、JARファイルとしてパッケージ化します
warassembleプロジェクトの出力を組み立てます

その他のWorkspace Gradleのタスクは、追加機能を提供します。

Workspace Gradleのタスクタスクの説明
buildDB汎用SQLスクリプトからデータベースSQLスクリプトを構築します
buildSoyJavaScript関数でクロージャテンプレートをコンパイルします
componentsプロジェクトのコンポーネントをリストします
configJSModulesLiferay DXPのコンボローダーを介して、AMDファイルをロードするために必要な設定ファイルを生成します
dependenciesプロジェクトの宣言された依存関係をリストします
formatSourceLiferay Source Formatterを実行してプロジェクトファイルをフォーマット化します
initBundleLiferay DXPバンドルをダウンロードしてインストールします
modelプロジェクトの設定モデルをリストします
projectsプロジェクトのサブプロジェクトをリストします
propertiesプロジェクトをリストします
replaceSoyTranslationgoog.getMsg定義を置き換えます
transpileJSプロジェクトのJavaScriptファイルを変換します

これはLiferay Workspaceで利用可能な、Gradleコマンドのサブセットです。 Gradleコマンドの完全なリストについては、ワークスペースのプロジェクトからgradlew tasksを実行します。

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています