エクスペリエンスフラグメント experience-fragments

基本知識 the-basics

エクスペリエンスフラグメントは、ページ内で参照できるコンテンツおよびレイアウトを含む 1 つ以上のコンポーネントのグループです。

エクスペリエンスフラグメントのプライマリ、バリアント、またはその両方で、次のものが使用されます。

/libs/cq/experience-fragments/components/xfpage/xfpage.html がないので、次のものに戻ります。

プレーン HTML レンディション the-plain-html-rendition

URL で .plain. セレクターを使用すると、プレーン HTML レンディションにアクセスできます。

このレンディションはブラウザーで使用できます。 ただし、その主な目的は、他のアプリケーション（例えば、サードパーティ web アプリ、カスタムモバイル実装など）が、URL のみを使用して、エクスペリエンスフラグメントのコンテンツに直接アクセスできるようにすることです。

プレーン HTML レンディションは、次のようなパスにプロトコル、ホストおよびコンテキストパスを追加します。

次に例を示します。

.../brooklyn-coat/master.plain.html

プレーンレンディションセレクターでは、追加スクリプトとは異なり、トランスフォーマーを使用します。 Sling Rewriter がトランスフォーマーとして使用されます。 このトランスフォーマーは、次の場所で設定します。

HTML レンディション生成の設定 configuring-html-rendition-generation

HTML レンディションは、Sling Rewriter パイプラインを使用して生成されます。 パイプラインは、/libs/experience-fragments/config/rewriter/experiencefragments で定義されます。 HTML Transformer では、次のオプションをサポートしています。

オーバーレイを使用してリライターを設定することをお勧めします。 詳しくは、AEM as a Cloud Service でのオーバーレイを参照してください。

エクスペリエンスフラグメントのテンプレート templates-for-experience-fragments

エクスペリエンスフラグメントの新しいテンプレートを作成する際は、編集可能なテンプレートの標準的な手法に従うことができます。

エクスペリエンスフラグメントを作成​ウィザードで検出されるエクスペリエンスフラグメントテンプレートを作成するには、次のいずれかのルールセットに従う必要があります。

エクスペリエンスフラグメントのコンポーネント components-for-experience-fragments

エクスペリエンスフラグメントで使用するコンポーネントの開発は、標準的な方法に従って行います。

唯一の追加設定は、コンポーネントがテンプレートで許可されていることを確認することです。 この許可設定には、コンテンツポリシーを使用します。

エクスペリエンスフラグメントの Link Rewriter Provider - HTML the-experience-fragment-link-rewriter-provider-html

AEM では、エクスペリエンスフラグメントを作成できます。 エクスペリエンスフラグメントは、

このようなグループのユースケースの 1 つは、Adobe Target などのサードパーティのタッチポイントにコンテンツを埋め込む場合です。

デフォルトのリンク書き換え default-link-rewriting

「Adobe Target に書き出し」機能を使用すると、次の操作が可能です。

この機能は、AEM のオーサーインスタンスで有効にすることができます。 有効な Adobe Target 設定と、Link Externalizer の設定が必要です。

Link Externalizer は、Target オファーの HTML バージョンを作成する際に必要な正しい URL を決定するために使用します。オファーは、その後 Adobe Target に送信されます。 Adobe Target では、Target HTML オファー内のすべてのリンクに公開でアクセスできる必要があるので、このプロセスは必須です。 つまり、リンクが参照するすべてのリソースと、エクスペリエンスフラグメント自体は、使用する前に公開する必要があります。

デフォルトでは、Target HTML オファーを作成すると、AEM のカスタム Sling セレクターにリクエストが送信されます。 このセレクターの名前は .nocloudconfigs.html です。 これはエクスペリエンスフラグメントのプレーン HTML レンダリングを作成しますが、その名前が示すとおり、クラウド設定を含んでいません（クラウド設定は余分な情報です）。

HTML ページを生成すると、Sling Rewriter パイプラインが次の出力に変更されます。

そのまま使用できる標準実装を使用する場合、エクスペリエンスフラグメントから Target オファーを生成して Adobe Target に書き出すには、上記のプロセスで十分です。 ただし、このプロセスでは対応していないユースケースもいくつかあります。 考慮されていないケースには、次のようなものがあります。

これらのユースケースのために、AEM には Link Rewriter Provider インターフェイスが用意されています。

Link Rewriter Provider インターフェイス link-rewriter-provider-interface

（デフォルトのリンク書き換えでは対応していない）より複雑な場合のために、AEM では Link Rewriter Provider フェイスを提供しています。 このインターフェイスは、バンドルにサービスとして実装できる ConsumerType インターフェイスです。 このインターフェイスは、エクスペリエンスフラグメントからレンダリングされる HTML オファーの内部リンクに対して AEM で実行される変更をバイパスします。 このインターフェイスを使用すると、内部 HTML リンクの書き換えプロセスをビジネスニーズに合わせてカスタマイズできます。

このインターフェイスをサービスとして実装する使用例としては、例えば次のものがあります。

Link Rewriter Provider インターフェイス（ExperienceFragmentLinkRewriterProvider）は次のとおりです。

public interface ExperienceFragmentLinkRewriterProvider {

    String rewriteLink(String link, String tag, String attribute);

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

Link Rewriter Provider インターフェイスの使用方法 how-to-use-the-link-rewriter-provider-interface

このインターフェイスを使用するには、まず、Link Rewriter Provider インターフェイスを実装する新しいサービスコンポーネントを含んだバンドルを作成する必要があります。

このサービスは、様々なリンクにアクセスできるように、エクスペリエンスフラグメントの「Target に書き出し」機能でのリンク書き換えにプラグインするために使用します。

例えば、ComponentService の場合は次のようになります。

import com.adobe.cq.xf.ExperienceFragmentLinkRewriterProvider;
import com.adobe.cq.xf.ExperienceFragmentVariation;
import org.osgi.service.component.annotations.Service;
import org.osgi.service.component.annotations.Component;

@Component
@Service
public class GeneralLinkRewriter implements ExperienceFragmentLinkRewriterProvider {

    @Override
    public String rewriteLink(String link, String tag, String attribute) {
        return null;
    }

    @Override
    public boolean shouldRewrite(ExperienceFragmentVariation experienceFragment) {
        return false;
    }

    @Override
    public int getPriority() {
        return 0;
    }

}

このサービスが機能するには、次の 3 つのメソッドをサービス内に実装する必要があります。

shouldRewrite shouldrewrite

エクスペリエンスフラグメントの特定のバリエーションに対して「Target に書き出し」機能が呼び出された場合に、リンクを書き換える必要があるかどうかをシステムに指定する必要があります。 次のメソッドを実装できます。

shouldRewrite(ExperienceFragmentVariation experienceFragment);

次に例を示します。

@Override
public boolean shouldRewrite(ExperienceFragmentVariation experienceFragment) {
    return experienceFragment.getPath().equals("/content/experience-fragment/master");
}

このメソッドは、Target システムに書き出しによる書き換えの対象となっているエクスペリエンスフラグメントバリエーションをパラメーターとして受け取ります。

上記の例では、次のように書き換えます。

「Adobe Target に書き出し」システムに通す他のあらゆるエクスペリエンスフラグメントは無視され、本サービスに実装される変更の影響を受けません。

rewriteLink rewritelink

書き換えプロセスの影響を受けるエクスペリエンスフラグメントバリエーションの場合は、サービスでリンクの書き換えを処理するように作業を進めます。 内部 HTML でリンクが検出されるたびに、次のメソッドが呼び出されます。

rewriteLink(String link, String tag, String attribute)

このメソッドは入力として次のパラメーターを受け取ります。

例えば、Target システムに書き出しがこの要素を処理している場合は、CSSInclude を次のように定義できます。

<link rel="stylesheet" href="/etc.clientlibs/foundation/clientlibs/main.css" type="text/css">

rewriteLink() メソッドの呼び出しは、次のパラメーターを使用して行います。

rewriteLink(link="/etc.clientlibs/foundation/clientlibs/main.css", tag="link", attribute="href" )

サービスを作成する際は、指定された入力に基づいて判断し、それに応じてリンクを書き換えることができます。

この例では、URL の /etc.clientlibs 部分を削除し、適切な外部ドメインを追加するとしましょう。 話を簡単にするために、rewriteLinkExample2 に示すように、サービスのリソースリゾルバーにアクセスできるとします。

private ResourceResolver resolver;

private Externalizer externalizer;

@Override
public String rewriteLink(String link, String tag, String attribute) {

    // get the externalizer service
    externalizer = resolver.adaptTo(Externalizer.class);
    if(externalizer == null) {
        // if there was an error, then we do not modify the link
        return null;
    }

    // remove leading /etc.clientlibs from resource link before externalizing
    link = link.replaceAll("/etc.clientlibs", "");

    // considering that we configured our publish domain, we directly apply the publishLink() method
    link = externalizer.publishLink(resolver, link);

    return link;
}

優先度 - getPriority priorities-getpriority

様々な種類のエクスペリエンスフラグメントに対応するためや、すべてのエクスペリエンスフラグメントの外部化とマッピングを処理する汎用サービスを用意するために、いくつかのサービスが必要になることは珍しくありません。 このような場合、使用するサービスに関するの競合が発生する可能性があるので、AEM では、様々なサービスの​ 優先度 ​を定義できるようになっています。 優先度は、次のメソッドを使用して指定します。

このメソッドを使用すると、複数のサービスを使用しても、同じエクスペリエンスフラグメントについては shouldRewrite() メソッドが true を返すようにすることができます。 getPriority() メソッドから最高の優先度が返されるサービスが、対象となっているエクスペリエンスフラグメントバリエーションを処理するサービスになります。

例えば、エクスペリエンスフラグメントのすべてのバリエーションについて shouldRewrite() メソッドが true を返す場合にすべてのエクスペリエンスフラグメントの基本マッピングを処理する GenericLinkRewriterProvider を用意することができます。 一部の特定のエクスペリエンスフラグメントについては、特別な処理が必要になる場合があります。その場合は、一部のエクスペリエンスフラグメントバリエーションについてのみ shouldRewrite() メソッドが true を返すような SpecificLinkRewriterProvider を用意することができます。 それらのエクスペリエンスフラグメントバリエーションを処理するために SpecificLinkRewriterProvider が必ず選択されるようにするには、そのプロバイダーの getPriority() メソッドで返される優先度が GenericLinkRewriterProvider. の場合より高くなるようにする必要があります。