Generating Projects with Blade CLI
Blade CLIは、Liferay WorkspaceでLiferayプロジェクトを作成、ビルド、およびデプロイするために存在します。 作成したプロジェクトは、IDEにインポートすることも、直接作業することもできます。 Liferay プロジェクトを作成および管理するさまざまな方法を紹介します。
Liferay Workspaceの作成
Liferay Workspaceは、プロジェクトとDevOps構成を保存するマシン上の一連のフォルダーです。 Liferay WorkspaceはGradleプロジェクトであるため、任意のIDEにインポートできます。 詳細については、 Liferay Workspace を参照してください。 Liferay Workspaceを作成するには、次の手順に従います。
-
CLIで、Liferay Workspaceを作成するフォルダーに移動します。
-
次のコマンドを実行します。
blade init [workspace name] -
Blade は、
dxp-2025.q1.1-ltsなどの最新の Liferay バージョンを要求します。 番号を入力して Enter キーを押すことで、開発対象の Liferay のバージョンを選択します。
Blade に必要なバージョンが表示されない場合は、バージョンがキャッシュされている可能性があります。 Blade はこのキャッシュを 7 日ごとに更新しますが、CLI で手動で更新することもできます。
blade --refresh-releases
プロジェクトの作成
プロジェクトはLiferay Workspaceに存在します。 覚えておくべき重要なオプションは次のとおりです。
-t: 使用するプロジェクト テンプレートを指定します。 これらのリストを取得するには、 blade create -lと入力します。
-p: クラスのパッケージ名を指定します。
-c: クラス名を指定します。
-v: Liferay のバージョンを指定します。たとえば、 7.1、 7.2、 7.3、または 7.4です。 注:このオプションは省略でき、Bladeのデフォルトはワークスペースで構成されたバージョンになります。
これらを組み合わせて、 guestbookという Liferay MVC ポートレットを作成する場合は、次のコマンドを使用します。
blade create -t mvc-portlet -p com.acme.z3x1.portlet -c GuestbookPortlet guestbook
これにより、MVC ポートレット テンプレート、 com.acme.z3x1.portletと呼ばれるデフォルト パッケージ、 GuestbookPortletと呼ばれるポートレット クラス、ワークスペースで指定された Liferay のバージョン ( guestbook) を使用してプロジェクトが作成されます。 これで、ワークスペースをIDEにインポートできます。 Liferay IntelliJプラグインまたはLiferay Developer StudioのEclipseプラグインは、拡張サポートを提供します。 Bladeを使用してプロジェクトに新しいワークスペースを作成する場合は、IDEでGradleプロジェクトを更新する必要があることに注意してください。
サンプルプロジェクトの作成
サンプルプロジェクトリポジトリ内の一部のプロジェクトは、Liferay npm バンドラーを使用しているため非推奨となっています。Liferay npm バンドラーは、Liferay 2024.Q4/Portal GA129 以降非推奨となっており、将来削除される予定です。 これらのプロジェクトは注意して使用してください。
Liferay は、 サンプル プロジェクトの GitHub リポジトリを管理しています。 これらは、プロジェクトの開始点として使用できるさまざまなLiferayテクノロジーの完全に実装されたサンプルです。 ただし、リポジトリにクローンを作成してアクセスするのではなく、Blade CLIを使用してローカルに作成できます。
-
必要なサンプルプロジェクトを見つけます。
blade samples -
たとえば、 モデル リスナーの実際の例が欲しいとします。 次のコマンドを入力します。
blade samples model-listener -
特定のバージョンのサンプルが必要な場合は、バージョンを指定できます。
blade samples -v 7.1 model-listener
レガシープラグインSDKプロジェクトの変換
バージョン 7.0 より前の Liferay プロジェクトがある場合、それらはプラグイン SDK にあります。 これらを6.2以降のLiferayのバージョンで使用するには、プラグインSDKからLiferay Workspaceに移行する必要があります。
-
プラグイン SDK 内のプロジェクトをデプロイする準備ができていることを確認します。 たとえば、Service Builder サービスはすでに生成されているはずです。
-
まだ作成していない場合は、 Liferay Workspace を作成してください。
-
Liferay Workspace内から、次のコマンドを実行します。
blade convert -s [path to old Plugins SDK] -aこれにより、プラグインSDKのすべてのプロジェクトがワークスペースプロジェクトに変換されます。
-
単一のプロジェクトのみを変換する場合は、代わりに次のコマンドを使用します。
blade convert -s [path to old Plugins SDK] [name of Plugins SDK project to convert]
-
Service Builderサービスを含むプロジェクトを変換すると、Blade CLIは個別のAPIおよびサービスOSGiモジュールを作成します。 ポートレットはWARのままで、
warsフォルダに移動します。 -
テーマは、Liferay 7.xテーマのようにNodeJSを活用するように変換されます。 Javaベースのテーマを変換するには、代わりにTheme Builder Gradleプラグインを使用する
-tオプションを追加します。