クライアント拡張
Liferayセルフホスト Liferay SaaS Liferay PaaS
Liferay DXP 7.4
Liferay の外観や操作性を変更したり、Liferay 外部の関数を呼び出したりして Liferay を拡張する場合は、クライアント拡張 (CX) を使用する必要があります。 クライアント拡張機能は、Liferay に直接コードをデプロイすることなく Liferay を拡張します。 自分でホストする場合でも、Liferay Cloud でホストする場合でも、クライアント拡張機能を任意の Liferay 環境にデプロイできます。 これらは、 Liferay オブジェクトなどの組み込み構成とともに、Liferay Cloud を使用して Liferay をカスタマイズする主な方法でもあります。
OSGi モジュール や テーマ などの他の Liferay 拡張機能は Liferay 自体の機能を変更または追加しますが、クライアント拡張機能は Liferay の API とのみインターフェースします。 この疎結合により、クライアント拡張機能はバージョン間でほとんど変更されない API のみに依存するため、アップグレード後に環境に適用する柔軟性が高まり、より簡単に実行できるようになります。 クライアント拡張機能は Liferay の外部で実行され、オブジェクトと統合されるため、接続に追加のコードは必要なく、任意のプログラミング言語やテクノロジーを使用してクライアント拡張機能を作成することもできます。
クライアント拡張機能を使用すると、
- Liferayのコードへの依存を避けながら、 カスタムJavaScriptまたはCSSを適用します。
- リモートでホストされているアプリケーションをLiferayページの カスタム要素 に埋め込む
- 同じ構成またはオブジェクトを複数の環境に適用するには、 クライアント拡張機能に変換します
- 選択したプログラミング言語またはテクノロジーを使用して、Liferay の外部で実行されるカスタムサービスまたは 関数 を呼び出します (例: REST エンドポイント)
クライアント拡張機能の種類
クライアント拡張機能を開発およびデプロイするには、 Liferay Workspace を使用します。 クライアント拡張機能は、 ヘッドレス APIを介して Liferay と通信します。
クライアント拡張機能の分類は次のとおりです。
すべての種類のクライアント拡張機能の完全なリファレンスについては、 クライアント拡張機能リファレンスを参照してください。
フロントエンドクライアント拡張
フロントエンド クライアント拡張機能は、特定のページに表示するリソースを提供します。 テーマ リソースまたはカスタム HTML 要素をクライアント拡張機能で提供できるようになりました。 ほとんどのフロントエンドクライアント拡張機能は、Liferay インスタンスに 静的リソース を提供します。
特定のタイプの詳細については、「 Liferay の外観と操作性のカスタマイズ 」を参照してください。
クライアント拡張の設定
構成クライアント拡張機能は、Liferay インスタンス内の機能を変更するための特定の構成を提供します。
これらは、 マイクロサービス クライアント拡張などの他のクライアント拡張と一緒に使用できます。 たとえば、OAuth ユーザー エージェント クライアント拡張機能を使用して、ユーザーがトリガーするアクション イベントで動作するクライアント拡張機能を認証できます。
特定のタイプの詳細については、 「コードとしての構成」 を参照してください。
マイクロサービスのクライアント拡張
マイクロサービス クライアント拡張機能は、Liferay 内でトリガーする API エンドポイント (オブジェクトまたはワークフロー アクションなど) を提供します。 これらのアクション イベントが API を呼び出すと、Liferay の外部で別の マイクロサービスとして任意の機能を実行できます。
特定のタイプの詳細については、 マイクロサービスの統合 を参照してください。
バッチクライアント拡張
バッチクライアント拡張機能は、 オブジェクト定義 や ワークフロー定義などのデータエンティティをLiferayインスタンスに提供します。 バッチ エンジン フレームワークを介してデータをエクスポートすることにより、バッチ クライアント拡張機能を作成します。
この特定のタイプの詳細については、 データのインポート/エクスポート を参照してください。
これからどこへ行くのか
クライアント拡張機能の作成方法をステップごとにわかりやすく学ぶには、以下の学習パスに従ってください。この学習パスでは、実装が最も簡単なクライアント拡張機能から始めて、そこから先に進みます。
それが終わったら、オブジェクトとクライアント拡張機能を使用して本格的なアプリケーションを作成する方法を確認することをお勧めします。