Documentation

アーティファクトを見つける

プロジェクトで外部アーティファクトを使用するには、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インストールアーティファクトをオーバーライドします。 フィックスパックの binariesフォルダには、サブフォルダのアーティファクトが含まれています。 プロジェクトでフィックスパックによって提供されるアーティファクトが必要な場合は、依存関係を宣言するときにフィックスパックからバージョンを宣言してください。

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

ファイル

グループID

アーティファクトID

原点

portal-kernel.jar

com.liferay.portal

com.liferay.portal.kernel

(JARの MANIFEST.MFを参照)

フィックスパックZIP、Liferayインストール、またはLiferay依存関係ZIP

portal-impl.jar

com.liferay.portal

com.liferay.portal.impl

(JARの MANIFEST.MFを参照)

フィックスパックZIPまたはLiferay .war

util-bridges.jar

com.liferay.portal

com.liferay.util.bridges

(JARの MANIFEST.MFを参照)

フィックスパックZIPまたはLiferay .war

util-java.jar

com.liferay.portal

com.liferay.util.java

(JARの MANIFEST.MFを参照)

フィックスパックZIPまたはLiferay .war

util-slf4j.jar

com.liferay.portal

com.liferay.util.slf4j

(JARの MANIFEST.MFを参照)

フィックスパックZIPまたはLiferay .war

util-taglibs.jar

com.liferay.portal

com.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モジュール(リリースごと)

メイヴン・セントラル

すべてのアーティファクトのタイプ:Liferayとサードパーティ、モジュールと非モジュール

重要

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

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

アプリマネージャー

アプリケーションマネージャは、Liferayインスタンスにデプロイされているものを表示します。

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

  2. [System]カテゴリで、 [アプリケーションマネージャ] を選択します。

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

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

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

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

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

  1. コントロールパネルの[System]カテゴリで、 [Gogo シェル] を選択します。 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アプリモジュールを検索するのに最適な場所です。

注釈

Liferayのコアアーティファクトのアーティファクト情報を見つけるには、前のセクション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. 概要] ページで、手順2でコピーしたパッケージ名を検索します。

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

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

注釈

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

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

メイヴン・セントラル

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

注釈

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

次のステップ

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