體驗片段 experience-fragments
基本資訊 the-basics
體驗片段是一或多個元件的群組,包括可在頁面中參考的內容和配置。
體驗片段主版、變體或兩者使用:
sling:resourceType
:/libs/cq/experience-fragments/components/xfpage
因為沒有/libs/cq/experience-fragments/components/xfpage/xfpage.html
,所以它還原為
sling:resourceSuperType
:wcm/foundation/components/page
純HTML轉譯 the-plain-html-rendition
使用URL中的.plain.
選擇器,您可以存取純HTML轉譯。
瀏覽器提供此轉譯。 不過,其主要用途是允許其他應用程式(例如協力廠商網頁應用程式、自訂行動實施)僅使用URL直接存取體驗片段的內容。
純HTML轉譯會將通訊協定、主機和內容路徑新增至以下路徑:
-
型別:
src
、href
或action
-
或結尾為:
-src
或-href
例如:
.../brooklyn-coat/master.plain.html
純轉譯選擇器使用轉換器,而不是其他指令碼。 Sling重寫程式已用作轉換器。 此轉換器在下列位置設定:
/libs/experience-fragments/config/rewriter/experiencefragments
設定HTML轉譯產生 configuring-html-rendition-generation
HTML轉譯是使用Sling重寫程式管道產生的。 管道定義於/libs/experience-fragments/config/rewriter/experiencefragments
。 HTML轉換器支援下列選項:
-
allowedCssClasses
- 符合應留在最終轉譯中的CSS類別的RegEx運算式。
- 如果客戶想要移除某些特定的CSS類別,此選項會很有用
-
allowedTags
- 最終轉譯中允許的HTML標籤清單。
- 預設允許下列標籤(不需要設定): html、head、title、body、img、p、span、ul、li、a、b、i、em、strong、h1、h2、h3、h4、h5、h6、br、noscript、div、link和script
Adobe建議使用覆蓋來設定重寫程式。 檢視AEM as a Cloud Service🔗中的覆蓋。
體驗片段的範本 templates-for-experience-fragments
為體驗片段開發新範本時,您可以遵循可編輯範本的標準做法。
若要建立 建立體驗片段 精靈偵測到的體驗片段範本,您必須遵循下列其中一個規則集:
-
兩者:
-
範本的資源型別(初始節點)必須繼承自:
cq/experience-fragments/components/xfpage
-
範本的名稱必須以下列專案開頭:
experience-fragments
此模式可讓使用者在/content/experience-fragments中建立體驗片段,因為此資料夾的cq:allowedTemplates
屬性包含名稱以experience-fragment
開頭的所有範本。 客戶可以更新此屬性以包含他們自己的命名配置或範本位置。
-
-
可以在體驗片段主控台中設定允許的範本。
體驗片段的元件 components-for-experience-fragments
開發要與/在體驗片段中使用的元件會遵循標準實務。
唯一額外的設定是確保範本上允許元件。 這項津貼是透過內容原則來達成。
體驗片段連結重寫器提供者 — HTML the-experience-fragment-link-rewriter-provider-html
在AEM中,您可以建立體驗片段。 體驗片段:
- 由一組元件和配置圖組成,
- 可以獨立於AEM頁面存在。
這類群組的使用案例之一,是將內容內嵌於協力廠商接觸點,例如Adobe Target。
預設連結重寫 default-link-rewriting
使用「匯出至目標」功能,您可以:
- 建立體驗片段,
- 新增元件,
- 然後以HTML格式或JSON格式將其匯出為Adobe Target選件。
此功能可在AEM的作者執行個體上啟用。 它需要有效的Adobe Target設定,以及Link Externalizer設定。
Link Externalizer可用來判斷建立Target選件的HTML版本時需要正確的URL,然後傳送至Adobe Target。 此程式是必要的,因為Adobe Target要求可以公開存取TargetHTML選件內的所有連結。 這表示連結參考的任何資源以及體驗片段本身都必須先發佈,才能使用。
根據預設,當您建構TargetHTML選件時,會傳送要求給AEM中的自訂Sling選取器。 此選取器稱為.nocloudconfigs.html
。 顧名思義,這會建立體驗片段的純HTML轉譯,但不包含雲端設定(這會是多餘的資訊)。
產生HTML頁面後,Sling重寫程式管道會修改為輸出:
-
html
、head
和body
元素已取代為div
元素。 已移除meta
、noscript
和title
元素(它們是原始head
元素的子元素,在被div
元素取代時不會考慮)。完成此程式是為了確保Target活動中可包含HTMLTarget選件。
-
AEM會修改HTML中出現的任何內部連結,使其指向已發佈的資源。
若要決定要修改的連結,AEM會對HTML元素的屬性遵循此模式:
src
屬性href
屬性*-src
屬性(例如data-src
和custom-src
)*-href
屬性(例如data-href
、custom-href
和img-href
)
note note NOTE HTML中的內部連結為相對連結,但自訂元件在HTML中提供完整URL時可能會發生這種情況。 依預設,AEM會忽略這些完整的URL且不會進行任何修改。 這些屬性中的連結會透過AEM Link Externalizer
publishLink()
執行,以重新建立URL,就像是在已發佈的執行個體上一樣,因此是公開可用的。
使用現成可用的實作時,上述流程應足以從體驗片段產生Target選件,然後將其匯出至Adobe Target。 不過,此程式並未說明部分使用案例。 其中有些案例未說明如下:
- Sling對應僅在發佈執行個體上可用
- Dispatcher重新導向
對於這些使用案例,AEM會提供連結重寫器提供者介面。
連結重寫程式提供者介面 link-rewriter-provider-interface
對於較複雜的情況,預設未涵蓋,AEM會提供連結重寫程式提供者介面。 此介面是您可在套件組合中實作的ConsumerType
介面,可作為服務使用。 它會繞過AEM對HTML選件的內部連結執行的修改,如從體驗片段轉譯。 此介面可讓您自訂重寫內部HTML連結的程式,以符合您的業務需求。
實作此介面作為服務的使用案例範例包括:
- Sling對應已在發佈執行個體上啟用,但在製作執行個體上未啟用
- Dispatcher或類似技術可用來在內部重新導向URL
- 資源的
sling:alias mechanisms
已準備就緒
連結重寫程式提供者介面( ExperienceFragmentLinkRewriterProvider
)如下:
public interface ExperienceFragmentLinkRewriterProvider {
String rewriteLink(String link, String tag, String attribute);
boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);
int getPriority();
}
如何使用連結重寫程式提供者介面 how-to-use-the-link-rewriter-provider-interface
若要使用介面,您必須先建立包含實作連結重寫程式提供者介面之新服務元件的組合。
此服務用於插入Experience Fragment Export to 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;
}
}
為了讓服務運作,現在有三個方法必須在服務內實作:
-
[shouldRewrite](#shouldrewrite)
-
[rewriteLink](#rewritelink)
rewriteLinkExample2
-
[getPriority](#priorities-getpriority)
shouldRewrite shouldrewrite
向系統指出是否必須在呼叫對特定體驗片段變數匯出至Target時重寫連結。 您可以實作下列方法:
shouldRewrite(ExperienceFragmentVariation experienceFragment);
例如:
@Override
public boolean shouldRewrite(ExperienceFragmentVariation experienceFragment) {
return experienceFragment.getPath().equals("/content/experience-fragment/master");
}
此方法會以引數形式接收匯出至目標系統正在重寫的體驗片段變數。
在上述範例中,您想要重寫:
-
在
src
中存在的連結 -
僅
href
屬性 -
針對特定體驗片段:
/content/experience-fragment/master
任何透過匯出至Target系統的其他體驗片段會被忽略,且不受此服務中實作的變更影響。
rewriteLink rewritelink
針對受重寫程式影響的體驗片段變數,它會繼續讓服務處理連結重寫。 每當內部HTML中出現連結時,就會叫用下列方法:
rewriteLink(String link, String tag, String attribute)
作為輸入,方法會接收引數:
-
link
正在處理的連結的String
表示法。 此表示通常是指向作者執行個體上資源的相對URL。 -
tag
正在處理的HTML元素的名稱。 -
attribute
確切的屬性名稱。
例如,如果Export to 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;
}
null
,則Export to Target系統會將連結維持原狀,即資源的相對連結。優先順序 — getPriority priorities-getpriority
需要多個服務來迎合不同體驗片段型別的情況也很常見,甚至需要有一個通用服務來處理所有體驗片段的外部化和對應。 在這些情況下,可能會發生使用哪個服務的衝突,因此AEM提供為不同服務定義 優先順序 的可能性。 使用下列方法指定優先順序:
getPriority()
此方法允許使用數個服務,其中shouldRewrite()
方法會為相同的體驗片段傳回true。 從其getPriority()
方法傳回最高數字的服務是處理體驗片段變數的服務。
例如,您可以有GenericLinkRewriterProvider
處理所有體驗片段的基本對應,以及當shouldRewrite()
方法傳回所有體驗片段變數的true
時。 針對數個特定體驗片段,您可能需要特殊處理,因此在此情況下,您可以提供SpecificLinkRewriterProvider
,而shouldRewrite()
方法只會針對某些體驗片段變數傳回true。 為了確保選擇SpecificLinkRewriterProvider
來處理這些體驗片段變數,它必須在其getPriority()
方法中傳回大於GenericLinkRewriterProvider.
的數字