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 [プロジェクト名] -
プロジェクト用に
build.gradleスクリプトを作成します。 Liferay Workspaceを使用している場合、ほとんどの場合、必要な依存関係は1つだけです。dependencies { compileOnly group: "com.liferay.portal", name: "release.dxp.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 CLI の記事を参照してください。
Liferayワークスペースは独自のNodeバージョンをダウンロードします(つまり、必ずしもシステムのバージョンとは限りません)。 別の Node バージョンが必要な場合は、 build.gradle ファイルでそれを宣言します。
node {
nodeVersion = "22.14.0"
npmVersion = "11.2.0"
...
}
ビルドキャッシュをクリアするために、必ず gw clean を実行してください。
Liferayバンドルをワークスペースに追加する
Workspaceは、コードの実行環境のダウンロードとセットアップを自動化します。 サーバー上でコードを実行する準備ができたら、サーバーをダウンロードするのに必要な手順はほんの数ステップです。
-
対象とするLiferayのリリースバージョンを見つけてください。
DXP: releases-cdn.liferay.com/dxpを参照し、必要なバンドルを見つけて、その URL をクリップボードにコピーします。
CE: releases-cdn.liferay.com/portal を閲覧し、必要なバンドルを見つけて、そのURLをクリップボードにコピーしてください。
-
gradle workspace プラグイン (v10+) のより新しいバージョンを使用すると、
liferay.workspace.productがgradle.propertiesファイルに自動的に追加されます。 古いバージョンを使用している場合は、ワークスペースのルートフォルダからgradle.propertiesを開き、bundle URL プロパティを設定してください。liferay.workspace.bundle.url=[クリップボードからURLを貼り付けてください]
liferay.workspace.product が gradle.properties ファイルにある場合、 liferay.workspace.bundle.url は不要です。
Liferay DXPを使用する場合は、以下のプロパティも設定してください。
liferay.workspace.bundle.token.download=true
liferay.workspace.bundle.token.email.address=[liferay.com に登録されているメールアドレスを入力してください]
liferay.workspace.bundle.token.password=[liferay.com のパスワードを入力してください]
ファイルを保存して閉じます。
-
バンドルをダウンロードする準備はできましたか? このコマンドを実行してください。
./gradlew initBundleまたは、ブレードがお好みなら、
Bladeサーバーの初期化
DXPを使用している場合は、セキュリティ上の理由から、バンドルのダウンロードが完了した後、プロパティファイルからパスワードを削除してください。
Liferay Workspace を介したコードのデプロイ
コードは、上記のステップで追加したLiferayバンドル、またはLiferayを実行しているDockerコンテナにデプロイできます。
Liferayバンドルへのコードのデプロイ
Liferay Workspaceに追加されたバンドルにコードをデプロイするのは簡単です。 プロジェクトフォルダから、以下のGradleタスクを実行してください。
../gradlew deploy
これは、ワークスペースのルートフォルダにあるGradleラッパースクリプトを呼び出し、ワークスペースに追加されたLiferayバンドルにプロジェクトをデプロイします。
Liferay Dockerコンテナへのコードのデプロイ
既に Liferay Dockerコンテナを作成済みであれば、ローカルバンドルにデプロイするのと同じくらい簡単にデプロイできます。 同じGradleタスクを実行します。
../gradlew deploy
Liferay Workspaceでテーマジェネレーターを使用する
Liferay Themes Toolkit は、Liferay 2024.Q4+ 以降 非推奨 となり、将来のリリースで削除される予定です。 代わりに、 クライアント拡張機能 を使用してテーマを作成するか、 サイト初期化子 を使用してください。
Liferayテーマジェネレーターは、サイトの外観や操作感を変更するためのテーマを作成する、Node.jsベースのツールです。 これらのプロジェクトは、Liferay Workspaceでも管理できます。 Bladeを使ってテーマプロジェクトを作成することも、手動で作成することもできます。
Bladeでテーマジェネレータープロジェクトを作成するには、次のコマンドを使用します。
blade create -t js-theme [プロジェクト名]
これにより、Node.js と yo がダウンロードされ、 yo liferay-theme が実行されて開始できます。
Workspace内でテーマプロジェクトを作成する場合も、Workspace外で作成する場合と同じ方法で作成できます。
-
テーマジェネレーターをインストール済みであることを前提として、Liferayワークスペースに移動してください。 他のプロジェクトと同様に、テーマプロジェクトもどこにでも配置できます。 テーマプロジェクトを作成するには、次のコマンドを実行します。
ヨーライフレイテーマ -
新しいテーマフォルダに移動して実行します
../gradlew build上記のコマンドは、ワークスペースのルートから 1 つ下のフォルダにいることを前提としています。プロジェクトをネストしている場合 (たとえば
themesフォルダ内) は、呼び出しをgradlewに合わせて調整してください。 このコマンドは、LiferayのNode Gradleプラグインを使用してフロントエンドテーマを構築します。
Workspaceがプロジェクトを認識していることを確認するには、次のコマンドを使用してすべてのプロジェクトを表示します。
./gradlew projects