Configuring Dependencies
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

アーティファクトの検索

プロジェクトで外部アーティファクトを使用するには、build.gradle Gradleスクリプトでそれらの依存関係を構成する必要があります。

アーティファクトを依存関係として指定する前に、まずその属性を見つける必要があります。 アーティファクトには次の属性があります。

  • グループID: 作成組織
  • アーティファクトID: 名前/識別子
  • バージョン: リリース番号

ここでは、アーティファクト属性を見つけて依存関係を指定する方法を学習します。

コアアーティファクト属性の検索

各Liferayアーティファクトは、アーティファクトのOSGiバンドルメタデータ属性を含むMETA-INF/MANIFEST.MFファイルが含まれるJARファイルです。 たとえば、次の2つのOSGiヘッダーは、アーティファクトIDとバージョンを指定します。

Bundle-SymbolicName:  [artifact ID]
Bundle-Version: [version]
重要

Liferay DXPフィックスパックのアーティファクトは、Liferay DXPインストールアーティファクトをオーバーライドします。 フィックスパック内の バイナリ フォルダーには、サブフォルダー内の成果物が含まれています。 プロジェクトでフィックスパックによって提供されるアーティファクトが必要な場合は、依存関係を宣言するときにフィックスパックからバージョンを宣言してください。

Liferayのコアアーティファクトを見つける場所は次のとおりです。

ファイルグループIDアーティファクトIDバージョン作成元
portal-kernel.jarcom.liferay.portalcom.liferay.portal.kernel(JARの MANIFEST.MFを参照)フィックスパックZIP、Liferayインストール、またはLiferay依存関係ZIP
portal-impl.jarcom.liferay.portalcom.liferay.portal.impl(JARの MANIFEST.MFを参照)フィックスパックZIPまたはLiferay .war
util-bridges.jarcom.liferay.portalcom.liferay.util.bridges(JARの MANIFEST.MFを参照)フィックスパックZIPまたはLiferay .war
util-java.jarcom.liferay.portalcom.liferay.util.java(JARの MANIFEST.MFを参照)フィックスパックZIPまたはLiferay .war
util-slf4j.jarcom.liferay.portalcom.liferay.util.slf4j(JARの MANIFEST.MFを参照)フィックスパックZIPまたはLiferay .war
util-taglibs.jarcom.liferay.portalcom.liferay.util.taglib(JARの MANIFEST.MFを参照)フィックスパックZIPまたはLiferay .war
com.liferay.* JARファイルcom.liferay(JARの MANIFEST.MFを参照)(JARの MANIFEST.MFを参照)フィックスパックZIP、Liferayインストール、Liferay依存関係ZIP、またはOSGi ZIP

次に、Liferayアプリと独立したモジュールアーティファクトの属性を見つける方法を学びます。

Liferayアプリと独立したアーティファクトの検索

コア外のモジュールの場合でも、必要なモジュールへの依存関係を指定する必要があります。 必要な依存関係を見つけるには、次の3つの方法があります。

リソースアーティファクトタイプ
アプリケーションマネージャデプロイされたモジュール
参照ドキュメントLiferayモジュール(リリースごと)
Maven Centralすべてのアーティファクトのタイプ:Liferayとサードパーティ、モジュールと非モジュール
重要

com.liferay は、Liferay のすべてのアプリと独立したモジュールのグループ ID です。

アプリケーションマネージャは、デプロイされたモジュールに関する最良の情報を提供します。

アプリケーションマネージャ

App Manager には、Liferay インスタンスに何がデプロイされているかが表示されます。

  1. Liferay で、 グローバル メニュー (Global Menu icon) をクリックし、 コントロール パネル タブを選択します。

  2. [System]カテゴリで、[App Manager]を選択します。

  3. 表示名、シンボル名、または関連するキーワードでモジュールを検索します。 アプリの一覧からモジュールを閲覧することもできます。 閲覧するか検索するかにかかわらず、アプリマネージャーは各モジュールのアーティファクトIDとバージョン番号を表示します。

アプリケーションマネージャは、デプロイされた各モジュールのアーティファクトIDとバージョン番号を表示します。

アプリケーションマネージャは、独立モジュールを独立モジュールカテゴリに集約します。

アプリケーションマネージャは、独立したモジュールを集約します。

独立したモジュールのグループ ID がわからない場合は、 Felix Gogo Shell を使用して見つけます。

  1. コントロールパネルの[System]カテゴリで、[Gogo Shell]を選択します。 Gogo シェルコマンドプロンプトにコマンドを入力します。

  2. 表示名(Apache Aries CDIなど)またはキーワードでモジュールを検索します。 結果で、モジュールの番号をメモします。 次のステップで使用できます。 以下の例は、Liferay Announcements APIモジュール番号47を示しています。

    この Gogo コマンドの結果では、モジュールの番号が `47 であることが示されています。

  3. モジュール番号を指定してheadersコマンドを使用して、マニフェストヘッダーを表示します。 Bundle-VendorまたはImplementation-Vendorの値に注目してください。 後のステップでアーティファクトグループと照合します。

    `headers コマンドを実行した結果には、モジュールのベンダー名とバンドル バージョンが表示されます。

  4. Maven Central または MVNRepositoryで、アーティファクト ID でモジュールを検索します。

  5. 手順3のBundle-VendorまたはImplementation-Vendorの名前を、アーティファクトを提供するグループと照合して、グループIDを決定します。

Liferay参照ドキュメントには、Liferayアプリのアーティファクト属性も記載されています。

参照ドキュメント

LiferayのアプリJavadocには、各アプリモジュールのアーティファクトID、バージョン番号、表示名が一覧表示されます。 これは、LiferayインスタンスにまだデプロイされていないLiferayアプリモジュールを検索するのに最適な場所です。

Core Liferayアーティファクトのアーティファクト情報を見つけるには、前のセクション Core Liferayアーティファクト属性の検索を参照してください。

JavadocでLiferayアプリモジュールの属性を見つけるには、次の手順に従います。

  1. アプリモジュールクラスのJavadocに移動します。 クラスのJavadocへのリンクがない場合は、LiferayエディションのアプリJavadocを閲覧してリンクを検索します。

    Liferay DXP: https://docs.liferay.com/dxp/apps

    Liferay Portal: https://docs.liferay.com/ce/apps

  2. クラスのパッケージ名をコピーします。

  3. 概要 ページに移動します。

  4. [Overview]ページで、手順2でコピーしたパッケージ名を検索します。

パッケージ名の上の見出しには、モジュールのアーティファクトID、バージョン番号、表示名が表示されます。 すべてのアプリモジュールのグループIDはcom.liferayであることを思い出してください。

LiferayのアプリJavadocには、表示名に続いて、グループID、アーティファクトID、およびバージョン番号がGradleアーティファクト構文で表示されています。

現在、モジュールのバージョン番号はどのタグライブラリの参照ドキュメントにも含まれていません。

次に、MVNRepositoryおよびMaven Centralでアーティファクトを検索する方法を学習します。

Maven Central

ほとんどの成果物は、タイプや出所に関係なく、 MVNRepositoryMaven Centralにあります。 これらのサイトは、クラスパッケージに基づいてアーティファクトを見つけるのに役立ちます。 アーティファクトのパッケージ名の先頭にアーティファクトのIDを含めるのが一般的です。 たとえば、クラスorg.osgi.service.component.annotations.Componentに依存している場合は、Mavenサイトの1つでパッケージ名org.osgi.service.component.annotationsを検索します。

上記の手順に従って、必要なLiferayアーティファクトのバージョンを確認してください。

次のステップ

アーティファクトの属性がわかったので、アーティファクトへの依存関係を構成できます。 詳細については、 依存関係の指定 を参照してください。