Liferayでは、Liferay DXPのさまざまな統合ポイントを対象としたサンプルプロジェクトの実例を提供しています。これらの作業例は独自の独立したプロジェクトにコピー/貼り付けができるため、さまざまなLiferay拡張ポイントを活用できます。各サンプルはスタンドアロンプロジェクトであり、独自のビルドファイルが含まれています。Liferayのサンプルプロジェクトは 、GitHubのliferay-blade-samplesリポジトリにあります。そして、Liferayのサンプルプロジェクトのドキュメンテーションは、 Sample Projectsのリファレンスセクションにあります。
リポジトリをローカルで参照したり、サンプルプロジェクトを独自のプロジェクトにコピーしたい場合は、リポジトリをフォークして、liferay-blade-samples
リポジトリのクローンを作成します。
また、以下のコマンドを実行することでBlade CLIを使用してサンプルを作成することもできます。
blade samples [SAMPLE_NAME]
たとえば、以下のコマンドはds-portletサンプルを作成します。
blade samples ds-portlet
リポジトリが以下の3つの主要なフォルダに分かれていることが一目でわかります。
gradle
liferay-workspace
maven
提供されているサンプルプロジェクトは、さまざまな開発者に対応できるように開発ツールチェーンごとに編成されています。各フォルダには、サンプルのLiferayプロジェクトの同じセットが用意されています。唯一の違いは、ビルドファイルがツールチェーンに固有であることです。たとえば、gradle
フォルダには、任意のGradleコンポジットビルドに追加できる、標準のOSS Gradleプラグインを使用したプロジェクトが含まれています。同じことがliferay-workspace
とmaven
プロジェクトにも適用されています。
このgradle
フォルダは、さまざまなタイプのLiferayプロジェクトの追加機能を含むLiferay Gradleプラグイン(例: com.liferay.plugin
)も使用しています。Liferay Gradleプラグインは、Liferay DXP向けに開発しているGradleユーザーに推奨されています。
また、一部のサンプルにはロギングも設定されているため、サンプルがバックグラウンドで何を行っているのかを理解するのに役立ちます。たとえば、OSGiモジュールのロギングは、いくつかのサンプル(例: action-command-portlet、document-action、service-builder/jdbcなど)に対して実装されます。これにより、OSGiモジュールは外部設定なしで独自のロギング設定デフォルトを提供できます。詳細については、Adjusting Module Loggingのチュートリアルを参照してください。
利用可能なサンプルテンプレートプロジェクトのリストについて は、Liferay Blade SamplesリポジトリにあるLiferay extension pointsのサブセクションを確認してください。このリストは包括的なものではありません。不足している拡張ポイントサンプルのサブセットは、Liferay extension points without template projectsのサブセクションにあります。このリポジトリへ貢献する方法の詳細については、リポジトリのContribution Guidelinesのセクションを確認してください。