Liferay Workspace 構成リファレンス
Liferay Workspaceには、設定できるオプションが多数あります。 便利なコマンドとプロパティのリファレンスはこちらです。
Liferay DXPをローカルで実行
my-project $ blade gw initBundle
my-project $ blade gw deploy
my-project $ blade server run
Liferay DXPをDockerで実行
my-project $ blade gw createDockerContainer
my-project $ blade gw startDockerContainer
Liferay DXPディストリビューションの作成
タールを作成する
my-project $ blade gw distBundleTar
ZIPファイルを作成する
my-project $ blade gw distBundleZip
複数のバンドルを作成する
my-project $ blade gw distBundleTarAll
my-project $ blade gw distBundleZipAll
Dockerイメージを作成する
my-project $ blade gw buildDockerImage
Liferay DXPモジュールを作成する
新しいサービスを作成する
my-project $ blade create -t service-builder my-service
JavaScriptテーマの作成
my-project $ blade create -t js-theme my-theme
Javaウィジェットの作成
my-project $ blade create -t mvc-portlet "my-java-widget"
JSウィジェットを作成する
my-project $ blade create -t js-widget "my-js-widget"
Gradleプロパティ
これらの gradle.properties を使用して、デフォルト設定をカスタマイズします。
liferay.workspace.product を設定します:liferay.workspace.productを設定して、app.server.tomcat.version、
liferay.workspace.bundle.url、liferay.workspace.docker.image.liferay、liferay.workspace.target.platform.versionをあなたのLiferay製品のバージョンに合うように設定します。 これらの設定をそれぞれ上書きするには、個別に設定してください。 値は null、または https://releases.liferay.com/releases.json にある releaseKey 値のいずれかになります。
このファイルは30日ごとに更新されます。 ワークスペースに新しいリリースを強制的にチェックさせるには、システムプロパティ -Dliferay.workspace.refresh.liferay.releases を使用します。
app.server.tomcat.version: liferay.workspace.product のデフォルト設定を上書きします。 app.server.tomcat.version を Liferay バンドル内のものと一致するように設定します。 TestIntegrationPlugin と LiferayExtPlugin は、バンドルされている Tomcat のバージョンと一致させるためにこのバージョンに依存しています。 設定済みのバンドル URL が異なる Tomcat バージョンのバンドルを指している場合は、以下のプロパティをその Tomcat バージョンに合わせて設定してください。
liferay.workspace.bundle.url: liferay.workspace.product のデフォルト設定を上書きします。 ダウンロードするバンドルZIPファイルへのURLを設定してください。
liferay.workspace.docker.image.liferay: liferay.workspace.product のデフォルト設定を上書きします。 コンテナを作成するためのLiferay PortalのDockerイメージを設定します。
liferay.workspace.target.platform.version:
liferay.workspace.productのデフォルト設定を上書きします。 開発およびテストに使用するLiferay PortalまたはDXPのバージョンを設定します。 これにより、依存関係管理やOSGiタスク解決などのターゲットプラットフォーム機能が有効になります。 このワークスペースで使用されているLiferay PortalまたはDXPバンドルのバージョンと一致するバージョンを使用してください。
利用可能なすべてのターゲットプラットフォームバージョンのリストについては、Liferay Portal については https://bit.ly/2IkAwwW、Liferay DXP については https://bit.ly/2GIyfZF を参照してください。
liferay.workspace.bundle.cache.dir: ダウンロードしたバンドル Zip ファイルが保存されるディレクトリを設定します。 デフォルト値は ~/.liferay/bundles です。
liferay.workspace.default.repository.enabled: ルート プロジェクトのデフォルト リポジトリとして Liferay CDN を構成するには、これを true に設定します。 デフォルト値は trueです。
liferay.workspace.environment: 現在の開発に適した設定で環境を設定します。 configs フォルダーは、同じワークスペース内に異なる環境を格納するために使用されます。 環境設定を整理し、それらの設定に基づいて環境インストールを生成できます。 環境は、共通、開発、Docker、ローカル、本番、UATの5種類があります。 デフォルト値は local です。
liferay.workspace.bundle.dist.include.metadata: 現在の環境設定とタイムスタンプのメタデータを追加するには、これを true に設定します。 デフォルト値は falseです。
liferay.workspace.dir.excludes.globs: ビルドライフサイクルから除外するグロブパターンのリストを設定します。 すべてのグロブパターンは、ワークスペースのルートディレクトリからの相対パスで開始されます。
例:
liferay.workspace.dir.excludes.globs=\
**/some-wip-project,\
dependencies/**,\
modules/**/*-test
liferay.workspace.docker.local.registry.address: ローカルの Docker レジストリのホストとポートを設定します。 これにより、ユーザーはDockerHub以外のDockerレジストリ(例:myregistryaddress.org:5000)とやり取りできるようになります。
liferay.workspace.docker.pull.policy: ユーザーのローカル Docker キャッシュを最初にプルするには、これを false に設定します。 デフォルト値は trueです。
liferay.workspace.docker.username: DockerHub との競合を避けるため、このプロパティを DockerHub に登録されているユーザー名に設定します。
liferay.workspace.docker.user.access.token: Docker アクセス トークンの生成方法については、https://docs.docker.com/docker-hub/access-tokens を参照してください。
liferay.workspace.ext.dir: すべての Ext OSGi モジュールと Ext プラグインを含むフォルダーを設定します。 デフォルト値は ext です。
liferay.workspace.home.dir: liferay.workspace.bundle.url プロパティからダウンロードした Liferay バンドルを含むフォルダーを設定します。 デフォルト値は バンドル です。
liferay.workspace.java.ee.use.jakarta: Jakarta 互換のツールと依存関係を有効にするには、これを true に設定します。 Workspaceは製品バージョンに基づいてJakartaの依存関係を使用するかどうかを決定しますが、このプロパティを設定すると、製品バージョンに関係なく特定のJakartaの依存関係の使用が強制されます。
現在、これは影響しています
- JSPの事前コンパイル
デフォルト値は falseです。
liferay.workspace.modules.default.repository.enabled: モジュール/OSGi プロジェクトのデフォルトリポジトリとして Liferay CDN を構成するには、これを true に設定します。 デフォルト値は trueです。
liferay.workspace.modules.dir: すべてのモジュール プロジェクトを含むフォルダーを設定します。 すべてのサブディレクトリを検索するには、 * に設定してください。 デフォルト値は モジュール です。
liferay.workspace.modules.jsp.precompile.enabled: OSGi モジュール内の JSP ファイルをコンパイルして配布可能な Zip/Tar に追加するには、これを true に設定します。 デフォルト値は falseです。
liferay.workspace.node.lts.codename: このプロパティを Node.js LTS リリースのコードネームに設定すると、その LTS リリースの最新の Node バージョンと NPM バージョンが自動的に使用されます。 有効なコードネームのリストについては、https://github.com/nodejs/Release/blob/main/CODENAMES.md を参照してください。
このファイルは30日ごとに更新されます。 ワークスペースに新しいリリースを強制的にチェックさせるには、システムプロパティ -Dliferay.workspace.refresh.node.releases を使用します。
liferay.workspace.node.package.manager: このプロパティを npm に設定すると、NPM を使用して Node.js スタイルのプロジェクトが構築されます。 デフォルト値は yarn です。
liferay.workspace.plugins.sdk.dir: プラグイン SDK 環境を含むフォルダーを設定します。 デフォルト値は plugins-sdk です。
liferay.workspace.themes.dir: Node.js スタイルのテーマ プロジェクトを含むフォルダーを設定します。 デフォルト値は テーマ です。
liferay.workspace.themes.java.build: Liferay Portal Tools Theme Builder を使用してテーマ プロジェクトをビルドするには、これを true に設定します。 デフォルト値は falseです。
liferay.workspace.wars.dir: すべてのレガシー WAR プロジェクトを含むフォルダーを設定します。 すべてのサブディレクトリを検索するには、 * に設定してください。 デフォルト値は モジュール です。
microsoft.translator.subscription.key: Microsoft Translation 統合のサブスクリプション キーを設定します。 このサービスは、 buildLang の自動翻訳を提供します。
target.platform.index.sources: Target Platform プラグインを有効にしている場合 (つまり、上記のプロパティを設定している場合) で、 TargetPlatformIDE プラグインをルート ワークスペース プロジェクトに適用する場合は、これを true に設定します。 これにより、BOMアーティファクトJARファイルとそのJavaソースコードすべてがIDEによってインデックス化されます。 このプロパティをtrueに設定すると、IDEのプロジェクト同期が遅くなる可能性があります。
build.gradle によるビルドのカスタマイズ
1つのプロジェクトで特定の依存関係を上書きする
configuration.resolutionStrategy.force 'groupId:artifactId:version' を設定すると、特定の依存関係のバージョンが上書きされます。 https://docs.gradle.org/current/userguide/dependency_downgrade_and_exclude.html#forced_dependencies_vs_strict_dependencies を参照してください。
configurations {
compileClasspath {
resolutionStrategy.force 'groupId:artifactId:version`
}
}
複数のプロジェクトで依存関係を上書きする
プロジェクトの依存関係のバージョンを上書きするには、以下の設定を使用してください。
subprojects {
configurations.all {
resolutionStrategy.force 'groupId:artifactId:version`
}
}
プラットフォームbndrun
このファイルは、各モジュールをLiferayのターゲットバージョンに対して解決します。 以下のコマンドを使用して操作を実行します。 ./gradlew resolve
成功: 成功の結果は、解決エラーなしで実行するために必要なすべてのアーティファクトのリストです。
失敗: 失敗は要件が満たされていないことを示します。 不足している要件を修正し、タスクを再実行してください。