將標籤建置到AEM應用程式中

上次更新: 2023-05-27
  • 主題:
  • Tagging
    檢視有關此主題的更多資訊
  • 建立對象:
  • Developer

若要以程式設計方式使用自訂AEM應用程式內的標籤或擴充標籤,本頁面說明如何使用

那個會與

如需關於標籤的相關資訊,請參閱:

  • 管理標籤 有關建立和管理標籤以及已對哪些內容標籤套用的資訊。
  • 使用標籤 以取得關於標籤內容的資訊。

標籤API概觀

實作 標籤框架 AEM允許使用JCR API管理標籤和標籤內容。 TagManager會確保在 cq:tags 字串陣列屬性不會重複,它會移除指向非現有標籤的TagID,並更新已移動或合併標籤的標籤ID。 TagManager會使用JCR觀察接聽程式來回覆任何不正確的變更。 主要類別位於 com.day.cq.tagg 封裝:

  • JcrTagManagerFactory — 傳回JCR型實作 TagManager. 這是標籤API的參考實作。
  • TagManager — 允許依照路徑和名稱解析和建立標籤。
  • Tag — 定義標籤物件。

取得以JCR為基礎的標籤管理員

若要擷取TagManager執行個體,您必須有JCR Session 和以呼叫 getTagManager(Session)

@Reference
JcrTagManagerFactory jcrTagManagerFactory;

TagManager tagManager = jcrTagManagerFactory.getTagManager(session);

在一般Sling情境下,您也可以適應 TagManagerResourceResolver

TagManager tagManager = resourceResolver.adaptTo(TagManager.class);

擷取標籤物件

A Tag 可透過 TagManager,解析現有標籤或建立現有標籤:

Tag tag = tagManager.resolve("my/tag"); // for existing tags

Tag tag = tagManager.createTag("my/tag"); // for new tags

對於以JCR為基礎的實作,其會 Tags 至JCR Nodes,您可以直接使用Sling adaptTo 機制(如果您有資源,例如 /content/cq:tags/default/my/tag):

Tag tag = resource.adaptTo(Tag.class);

雖然標籤只能從資源(非節點)轉換而來,但標籤可以轉換為*節點和資源:

Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);
注意

直接改寫自 NodeTag 不可能,因為 Node 不實作Sling Adaptable.adaptTo(Class) 方法。

取得和設定標籤

// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);

// Setting tags to a Resource:
tagManager.setTags(resource, tags);

搜尋標籤

// Searching for the Resource objects that are tagged with the tag object:
Iterator<Resource> it = tag.find();

// Retrieving the usage count of the tag object:
long count = tag.getCount();

// Searching for the Resource objects that are tagged with the tagID String:
 RangeIterator<Resource> it = tagManager.find(tagID);
注意

有效 RangeIterator 要使用的是:

com.day.cq.commons.RangeIterator

刪除標籤

tagManager.deleteTag(tag);

複製標籤

可以使用復寫服務( Replicator)與標籤,因為標籤的型別為 nt:hierarchyNode

replicator.replicate(session, replicationActionType, tagPath);

在使用者端上標籤

表單Widget CQ.tagging.TagInputField 用於輸入標籤。 它有一個快顯功能表,可從現有標籤中選取,包括自動完成和許多其他功能。 其xtype為 tags.

標籤記憶體回收器

標籤垃圾回收程式是一項背景服務,可清除隱藏和未使用的標籤。 隱藏和未使用的標籤是底下的標籤 /content/cq:tags 具有 cq:movedTo 屬性和,而不是在內容節點上使用 — 它們的計數為零。 透過使用這種延遲刪除程式,內容節點(即 cq:tags 屬性),不必隨著移動或合併作業進行更新。 中的參照 cq:tags 屬性會在以下情況時自動更新: cq:tags 屬性會更新,例如,透過頁面屬性對話方塊。

標籤記憶體回收行程預設為每天執行一次。 您可以在下列位置進行設定:

http://localhost:4502/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector

標籤搜尋和標籤清單

搜尋標籤和標籤清單的運作方式如下:

  • 搜尋TagID會搜尋具有屬性的標籤 cq:movedTo 設定為TagID並遵循 cq:movedTo 標籤ID。

  • 搜尋標籤Title只會搜尋沒有 cq:movedTo 屬性。

不同語言的標籤

如管理標籤的檔案一節中所述 管理不同語言的標籤,標籤 title能以不同語言定義。 然後,語言敏感屬性會新增至標籤節點。 此屬性的格式為 jcr:title.<locale>例如, jcr:title.fr 法文翻譯版。 此 <locale> 必須為小寫ISO地區設定字串,並使用「_」而非「 — 」,例如: de_ch.

動物 標籤已新增至 產品 頁面,值 stockphotography:animals 已新增至屬性 cq:tags /content/geometrixx/en/products/jcr:content節點的 已從標籤節點參考翻譯。

伺服器端API已本地化 title相關方法:

  • com.day.cq.tagging.Tag

    • getLocalizedTitle(地區設定)
    • getLocalizedTitlePaths()
    • getLocalizedTitles()
    • getTitle(地區設定)
    • getTitlePath(地區設定)
  • com.day.cq.tagging.TagManager

    • canCreateTagByTitle(String tagTitlePath, Locale)
    • createTagByTitle(String tagTitlePath, Locale)
    • resolveByTitle(String tagTitlePath, Locale)

在AEM中,可以從頁面語言或使用者語言取得語言:

  • 若要擷取JSP中的頁面語言:

    • currentPage.getLanguage(false)
  • 若要擷取JSP中的使用者語言:

    • slingRequest.getLocale()

currentPageslingRequest 可在JSP中使用,透過 <cq:definedobjects> 標籤之間。

對於標籤,本地化取決於作為標籤的內容設定 titles能以頁面語言、使用者語言或任何其他語言顯示。

新增語言至編輯標籤對話方塊

下列程式說明如何將語言(芬蘭文)新增至 標籤編輯 對話方塊:

  1. CRXDE,編輯多值屬性 languages 節點的 /content/cq:tags.

  2. 新增 fi_fi — 代表芬蘭語言環境 — 並儲存變更。

新語言(芬蘭文)現在可在頁面屬性的標籤對話方塊和 編輯標籤 對話方塊 標籤 主控台。

注意

新語言必須是AEM認可的語言之一。 也就是說,它必須可作為以下的節點使用 /libs/wcm/core/resources/languages.

注意

安裝Service Pack會將/content/cq:tags節點的languages屬性重設為預設值。 因此,在安裝之前,必須從屬性新增它。

此頁面上的