在 AEM 应用程序中生成标记 building-tagging-into-aem-applications
为了以编程方式使用自定义AEM应用程序中的标记或扩展标记,本文档介绍了如何使用
会与
有关标记的相关信息:
- 有关将内容标记为内容作者的信息,请参阅使用标记。
- 有关创建和管理标记以及已对哪些内容应用标记的信息,请参阅管理标记。
标记API概述 overview-of-the-tagging-api
AEM中标记框架的实施允许使用JCR API管理标记和标记内容。 TagManager
确保在cq:tags
字符串数组属性上作为值输入的标记不重复,它会删除指向非现有标记的TagID
,并更新已移动或合并标记的TagID
。 TagManager
使用JCR观察侦听器来还原任何不正确的更改。 主类位于com.day.cq.tagging包中:
JcrTagManagerFactory
— 返回TagManager
的基于JCR的实现。 它是标记API的参考实施。TagManager
— 允许按路径和名称解析和创建标记。Tag
— 定义标记对象。
获取基于JCR的标签管理器 getting-a-jcr-based-tagmanager
要检索TagManager
实例,您需要具有JCR Session
并调用getTagManager(Session)
:
@Reference
JcrTagManagerFactory jcrTagManagerFactory;
TagManager tagManager = jcrTagManagerFactory.getTagManager(session);
在典型的Sling上下文中,您还可以从ResourceResolver
适应TagManager
:
TagManager tagManager = resourceResolver.adaptTo(TagManager.class);
检索标记对象 retrieving-a-tag-object
通过解析现有标记或创建现有标记,可以通过TagManager
检索Tag
:
Tag tag = tagManager.resolve("my/tag"); // for existing tags
Tag tag = tagManager.createTag("my/tag"); // for new tags
对于基于JCR的实现(将Tags
映射到JCR Nodes
),如果您有资源(例如/content/cq:tags/default/my/tag
),则可以直接使用Sling的adaptTo
机制:
Tag tag = resource.adaptTo(Tag.class);
虽然标记只能从 资源(而非节点)转换为,但标记可同时从节点和资源转换为 到:
Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);
Node
调整到Tag
,因为Node
未实现Sling Adaptable.adaptTo(Class)
方法。获取和设置标记 getting-and-setting-tags
// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);
// Setting tags to a Resource:
tagManager.setTags(resource, tags);
搜索标记 searching-for-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
删除标记 deleting-tags
tagManager.deleteTag(tag);
复制标记 replicating-tags
可以将复制服务(Replicator
)与标记一起使用,因为标记的类型为nt:hierarchyNode
:
replicator.replicate(session, replicationActionType, tagPath);
标记垃圾收集器 the-tag-garbage-collector
标记垃圾收集器是一种后台服务,用于清理隐藏和未使用的标记。 隐藏和未使用的标记是/content/cq:tags
下的标记,这些标记具有cq:movedTo
属性,未在内容节点上使用。 他们的数量为零。 通过使用此延迟删除流程,不必在移动或合并操作过程中更新内容节点(即cq:tags
属性)。 在更新cq:tags
属性时(例如,通过页面属性对话框),cq:tags
属性中的引用将自动更新。
默认情况下,标记垃圾回收器每天运行一次。 这可以在以下位置配置:
http://<host>:<port>/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector
标记搜索和标记列表 tag-search-and-tag-listing
搜索标记和标记列表的工作方式如下:
- 搜索
TagID
将搜索属性cq:movedTo
设置为TagID
并遵循cq:movedTo
TagID
的标记。 - 搜索标记标题只会搜索没有
cq:movedTo
属性的标记。
不同语言的标记 tags-in-different-languages
可以使用不同的语言定义标记title
。 然后,将区分语言的属性添加到标记节点。 此属性的格式为jcr:title.<locale>
,例如,法语翻译为jcr:title.fr
。 <locale>
必须为小写的ISO区域设置字符串,并使用下划线(_
)而不是连字符/短划线(-
),例如: de_ch
。
例如,将 Animals 标记添加到 Products 页面时,值stockphotography:animals
将添加到节点/content/wknd/en/products/jcr:content
的属性cq:tags
。 将从标记节点中引用翻译。
服务器端API具有本地化的title
相关方法:
-
getLocalizedTitle(Locale locale)
getLocalizedTitlePaths()
getLocalizedTitles()
getTitle(Locale locale)
getTitlePath(Locale locale)
-
canCreateTagByTitle(String tagTitlePath, Locale locale)
createTagByTitle(String tagTitlePath, Locale locale)
resolveByTitle(String tagTitlePath, Locale locale)
在AEM中,可以从页面语言或用户语言获取语言。
对于标记,本地化取决于上下文,因为标记titles
能够以页面语言、用户语言或任何其他语言显示。
向“编辑标记”对话框添加新语言 adding-a-new-language-to-the-edit-tag-dialog
以下过程介绍了如何向 标记编辑 对话框添加新语言(例如,芬兰语):
- 在 CRXDE 中,编辑节点
/content/cq:tags
的多值属性languages
。 - 添加表示芬兰语言环境的
fi_fi
并保存更改。
现在,在 标记 控制台中编辑标记时,在页面属性的标记对话框和 编辑标记 对话框中可以使用芬兰语。
/libs/wcm/core/resources/languages
下的节点提供。