將標記內建至 AEM 應用程式中

上次更新: 2023-11-18

為了以程式設計方式使用自訂AEM應用程式內的標籤或擴展標籤,本檔案說明如何使用

會與

有關標籤的相關資訊:

  • 另請參閱 使用標籤 有關將內容標籤為內容作者的資訊。
  • 請參閱管理標籤,以取得管理員對於建立和管理標籤以及已對哪些內容套用標籤的觀點。

標籤API的總覽

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

  • JcrTagManagerFactory — 傳回JCR型的 TagManager. 此版本為「標籤API」的參考實作。
  • TagManager — 允許依路徑和名稱解析和建立標籤。
  • Tag — 定義標籤物件。

取得JCR型TagManager

擷取 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);

標籤記憶體回收器

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

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

http://<host>:<port>/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector

標籤搜尋和標籤清單

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

  • 搜尋 TagID 搜尋具有屬性的標籤 cq:movedTo 設為 TagID 並遵循 cq:movedTo TagIDs.
  • 搜尋標籤標題只會搜尋沒有的標籤 cq:movedTo 屬性。

不同語言的標籤

標籤 title 能以不同語言定義。 然後,區分語言的屬性會新增至標籤節點。 此屬性的格式為 jcr:title.<locale>例如, jcr:title.fr 以取得法文翻譯。 <locale> 必須為小寫ISO地區設定字串並使用底線(_)而非連字型大小/破折號(-),例如: de_ch.

例如,當 動物 標籤已新增至 產品 頁面,值 stockphotography:animals 會新增至屬性 cq:tags 節點的 /content/wknd/en/products/jcr:content. 將從標籤節點引用翻譯。

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

  • com.day.cq.tagging.Tag
    • getLocalizedTitle(Locale locale)
    • getLocalizedTitlePaths()
    • getLocalizedTitles()
    • getTitle(Locale locale)
    • getTitlePath(Locale locale)
  • com.day.cq.tagging.TagManager
    • canCreateTagByTitle(String tagTitlePath, Locale locale)
    • createTagByTitle(String tagTitlePath, Locale locale)
    • resolveByTitle(String tagTitlePath, Locale locale)

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

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

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

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

  1. CRXDE,編輯多值屬性 languages 節點的 /content/cq:tags.
  2. 新增 fi_fi,代表芬蘭語言環境,並儲存變更。

現在可以在頁面屬性的標籤對話方塊和 編輯標籤 對話方塊 標籤 主控台。

注意

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

本頁內容