Liferay Workspace 設定リファレンス
Liferay Workspace には設定できるオプションが多数あります。 便利なコマンドとプロパティのリファレンスを紹介します。
Liferay DXPをローカルで実行する
my-project $ blade gw initBundle
my-project $ blade gw deploy
my-project $ blade server run
DockerでLiferay DXPを実行する
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 を設定して、Liferay 製品バージョンと一致する app.server.tomcat.version、
liferay.workspace.bundle.url、 liferay.workspace.docker.image.liferay、および liferay.workspace.target.platform.version を設定します。 これらの各設定を上書きするには、個別に設定します。 値は null、または https://releases.liferay.com/releases.json にある releaseKey 値のいずれかになります。
このファイルは 30 日ごとに更新されます。 ワークスペースに新しいリリースを強制的にチェックさせるには、システム プロパティ -Dliferay.workspace.refresh.liferay.releasesを使用します。
app.server.tomcat.version: liferay.workspace.productのデフォルト設定を上書きします。 Liferay バンドル内の内容と一致するように、 app.server.tomcat.version を設定します。 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 フォルダは、同じワークスペース内の異なる環境を保持するために使用されます。 環境設定を整理し、その設定を使用して環境インストールを生成できます。 環境は、common、dev、docker、local、prod、uat の 5 つです。 デフォルト値は ローカルです。
liferay.workspace.bundle.dist.include.metadata: 現在の環境設定とタイムスタンプのメタデータを追加するには、これをtrueに設定します。 デフォルト値は falseです。
liferay.workspace.dir.excludes.globs: ビルドライフサイクルから除外するglobパターンのリストを設定します。 すべての glob パターンは、ワークスペースのルート ディレクトリを基準として開始されます。
例:
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: Liferay CDN をモジュール/OSGi プロジェクトのデフォルトリポジトリとして設定するには、これを 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 を使用して Node.js スタイルのプロジェクトを構築するには、このプロパティを npm に設定します。 デフォルト値は 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
成功: 成功した結果は、解決エラーなしで実行するために必要なすべての成果物のリストです。
失敗: 失敗は要件が満たされていないことを示します。 不足している要件を修正し、タスクを再実行します。