Liferay Workspaceでのコード作成
Liferay Workspaceは、Liferay開発プロジェクトを作成および管理するための開発者向けツールです。
プロジェクトの作成
Blade CLI を使用すると、事前に構築されたプロジェクトテンプレートが提供されるため、Liferay Workspace でプロジェクトを簡単に作成できます。 または、プロジェクトを手動で作成することもできます。
Blade CLIを使用したプロジェクトの作成
-
ワークスペース内から、次のコマンドを使用して、実行したい内容に最も近いプロジェクトテンプレートを見つけます。
blade create -l -
使用するテンプレートを特定したら、プロジェクトを生成します。 たとえば、MVC ポートレットを作成するには、次のコマンドを使用します。
blade create -t mvc-portlet -p com.acme.z3x1.portlet -c MyPortlet myproject-webこれにより、MVC ポートレット テンプレートを使用してプロジェクトが作成され (
-t mvc-portlet)、指定した Java パッケージにポートレット クラスが生成され (-p com.acme.z3x1.portlet)、ポートレット クラスの名前が指定され (-c MyPortlet)、プロジェクトの名前がmyproject-webになります。
手動でプロジェクトを作成する
プロジェクトの作成にBlade CLIは必要ありません。 必要に応じて、プロジェクトフォルダを手動で作成できます。
-
ワークスペース内から、プロジェクトを格納するフォルダを作成します。
cd [my project name] -
プロジェクトの
build.gradleスクリプトを作成します。 Liferay Workspaceを使用しているため、ほとんどの場合、必要な依存関係は1つだけです。dependencies { compileOnly group: "com.liferay.portal", name: "release.portal.api" } -
プロジェクトのフォルダ構造を作成します。
Liferay DXPで実行するコードを作成するには、それをデプロイするLiferayランタイムが必要です。 したがって、Liferay Workspaceをインストールした後の最初のタスクは、Liferayバンドルをワークスペースに追加することです。
Liferay CLIツールでLiferay Workspaceを使用する
Liferay CLI ツールは Liferay 2024.Q4/Portal GA129 以降廃止されており、将来削除される予定です。
Liferay CLI ツールは、Liferay Workspace と一緒に使用できます。 ツールをインストールしてプロジェクトを生成する方法については、Liferay CLI の記事を参照してください。
Liferay ワークスペースは独自のノード バージョンをダウンロードします (つまり、必ずしもシステムのバージョンではありません)。 異なるノード バージョンが必要な場合は、 build.gradle ファイルで宣言します。
node {
nodeVersion = "22.14.0"
npmVersion = "11.2.0"
...
}
ビルド キャッシュを消去するには、必ず gw clean を実行してください。
Liferayバンドルをワークスペースに追加する
ワークスペースは、コードのランタイムのダウンロードとセットアップを自動化します。 サーバーでコードを実行する準備ができたら、ほんの数ステップでダウンロードできます。
-
対象となるLiferayリリースを見つけます。
DXP: 参照 releases-cdn.liferay.com/dxpし、必要なバンドルを見つけて、その URL をクリップボードにコピーします。
CE: 参照 releases-cdn.liferay.com/portalし、必要なバンドルを見つけて、その URL をクリップボードにコピーします。
-
より新しいバージョンの gradle ワークスペース プラグイン (v10+) を使用する場合、
liferay.workspace.productがgradle.propertiesファイルに自動的に追加されます。 古いバージョンを使用している場合は、ワークスペースのルート フォルダーからgradle.propertiesを開き、バンドル URL プロパティを設定します。liferay.workspace.bundle.url=[paste the URL from your clipboard]
liferay.workspace.product が gradle.properties ファイル内にある場合、 liferay.workspace.bundle.url は必要ありません。
Liferay DXPを使用している場合は、次のプロパティも設定します。
liferay.workspace.bundle.token.download=true
liferay.workspace.bundle.token.email.address=[enter the email address registered on liferay.com]
liferay.workspace.bundle.token.password=[enter your liferay.com password]
ファイルを保存して閉じます。
-
バンドルをダウンロードする準備はできましたか。 次のコマンドを実行します。
./gradlew initBundleまたは、Bladeの場合は、次のコマンドを実行します。
blade server init
DXPの場合、セキュリティ上の理由から、バンドルのダウンロード後にプロパティファイルからパスワードを削除する必要があります。
Liferay Workspaceを介したコードのデプロイ
上記の手順で追加したLiferayバンドル、またはLiferayを実行しているDockerコンテナにコードをデプロイできます。
Liferayバンドルへのコードのデプロイ
Liferay Workspaceに追加されたバンドルにコードをデプロイするのは簡単です。 プロジェクトフォルダから、次のGradleタスクを実行します。
../gradlew deploy
これにより、WorkspaceルートフォルダのGradleラッパースクリプトが呼び出され、ワークスペースに追加されたLiferayバンドルにプロジェクトがデプロイされます。
Liferay Dockerコンテナへのコードのデプロイ
すでに Liferay Docker コンテナ を作成している場合、そのコンテナへのデプロイはローカルバンドルへのデプロイと同じくらい簡単です。 同じGradleタスクを実行します。
../gradlew deploy
Liferay WorkspaceでThemes Generatorを使用する
Liferay テーマツールキットは、Liferay 2024.Q4+ の時点で 非推奨 となっており、将来のリリースで削除される予定です。 代わりに、 クライアント拡張機能 を使用してテーマを作成するか、 サイト初期化子を使用します。
Liferay テーマ ジェネレーターは、サイトの外観と雰囲気を変更するテーマを作成するための node.js ベースのツールです。 これらのプロジェクトは、Liferay Workspaceで管理することもできます。 テーマプロジェクトは、Bladeを使用するか手動で作成できます。
Bladeを使用してTheme Generatorプロジェクトを作成するには、次のコマンドを使用します。
blade create -t js-theme [project-name]
これにより、Node.js と yo がダウンロードされ、次に yo liferay-theme が実行されて開始されます。
ワークスペースの外部で作成するのと同じ方法で、ワークスペースでテーマプロジェクトを作成することもできます。
-
Themes Generatorをインストールしたと仮定して、Liferay Workspaceに移動します。 他のプロジェクトと同様に、テーマプロジェクトはどこにでも配置できます。 次のコマンドを実行して、テーマプロジェクトを作成します。
yo liferay-theme -
新しいテーマフォルダに移動して実行します
../gradlew build上記のコマンドは、ワークスペースのルートから1つ下のフォルダにいることを前提としています。プロジェクトを(おそらく
themesフォルダで)ネストした場合は、それに応じてgradlewの呼び出しを調整します。 このコマンドは、Liferay の Node Gradle プラグインを使用してフロントエンド テーマを構築します。
Workspaceがプロジェクトを認識していることを確認するには、次のコマンドを使用してすべてのプロジェクトを表示します。
./gradlew projects