五、AEM中常用的API

已于 2023-02-20 16:47:02 修改
阅读量440 收藏
点赞数 2
分类专栏： AEM 文章标签： java
于 2023-02-20 16:40:04 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/stiven46/article/details/129127113
版权
文章介绍了AEM中常用的API，包括AEM、Sling、JCR和OSGI四个层次。AEMAPI用于处理页面、资产等，SlingAPI基于资源操作，JCR涉及数据内容，而OSGI关注服务和配置。示例代码展示了如何使用这些API来获取和操作页面信息、创建新页面以及访问组件属性。
摘要由CSDN通过智能技术生成

五、AEM中常用的API

AEM中集成了非常多的开源软件，同时也对这些开源软件做了一系列的封装，以便提供好用的API供开发者使用。其中以下面四种为主：

名称优先级说明
AEM最高AEM中的抽象概念，如页面、资产、工作流等
Sling高基于资源的抽象概念，如资源、数据、HTTP请求等
JCR中具体数据内容的抽象概念，如节点、属性、会话等
OSGI低主要针对服务的抽象，如配置、服务等

一般情况下，优先使用AEM的API，封装的功能较为强大和全面。下面就分别介绍这四种API的一些实例。以下面的代码为例

package com.adobe.aem.guides.wknd.core.models;

import com.adobe.cq.export.json.ExporterConstants;
import com.day.cq.commons.inherit.InheritanceValueMap;
import com.day.cq.commons.jcr.JcrConstants;
import com.day.cq.wcm.api.Page;
import com.day.cq.wcm.api.PageManager;
import com.day.cq.wcm.api.WCMException;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.PersistenceException;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.models.annotations.DefaultInjectionStrategy;
import org.apache.sling.models.annotations.Exporter;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;
import org.apache.sling.models.annotations.injectorspecific.ValueMapValue;

import javax.annotation.PostConstruct;
import javax.inject.Inject;

@Slf4j
@Model(
        adaptables = {SlingHttpServletRequest.class, Resource.class},
        adapters = {Translate.class},
        resourceType = {Translate.RESOURCE_TYPE},
        defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL
)
@Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME, extensions = ExporterConstants.SLING_MODEL_EXTENSION)
public class Translate {

    protected static final String RESOURCE_TYPE = "wknd/components/translate";

    @SlingObject
    private ResourceResolver resourceResolver;
    @SlingObject
    private Resource resource;
    @Self
    private SlingHttpServletRequest request;
    @ScriptVariable
    private ValueMap properties;
    @Inject
    private Page currentPage;
    @Inject
    private InheritanceValueMap pageProperties;

    @Getter
    @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL)
    private String appId;

    @Getter
    @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL)
    private String appKey;

    @PostConstruct
    public void init() throws WCMException, PersistenceException {
        // resourceResolver是资源转换类，可以通过此类获取对应的页面，也可以转换为其他API
        PageManager pageManager = resourceResolver.adaptTo(PageManager.class);
        // pageManager可以通过页面路径获取到对应的Page对象
        Page page = pageManager.getPage("/content/wknd/us/en/steven");
        // 也可以直接使用currentPage
        log.info("page title = {}", page.getTitle());
        // 所以从pageManager中通过路径获取到Page对象和currentPage对象，表示的是JCR中同一个页面节点
        log.info("current page title = {}", currentPage.getTitle());
        // 通过SlingHttpServletRequest也可以获取到当前页面的地址信息
        String path = request.getHeader("Referer");
        log.info("page request path : {}", path);
        // 获取到地址信息后，就可以拿到这个页面下所有的节点和数据内容，由于page和currentPage表示同一个页面节点，所以拿到的页面内容是一致的
        ValueMap pageVM = page.getProperties();
        ValueMap currentPageVM = currentPage.getProperties();
        log.info("title = {}", pageVM.get(JcrConstants.JCR_TITLE, String.class));
        log.info("title = {}", currentPageVM.get(JcrConstants.JCR_TITLE, String.class));
        // 也可以通过Sling API来创建页面和资源，通过模板来创建页面
        String templatePath = "/conf/wknd/settings/wcm/templates/steven";
        pageManager.create("/content/wknd/us/en", "steven-new", templatePath, "steven new page", true);
        resourceResolver.commit();
        // 获取组件属性及内容
        ValueMap valueMap = resource.getValueMap();
        log.info("appId from resource = {}", valueMap.get("appId", String.class));
        log.info("appId from properties = {}", properties.get("appId", String.class));
    }
}

AEM API

AEM API 提供了特定于产品化用例的抽象概念和功能。详情可参考AEM API Doc

例如：AEM提供了PageManager和Page类来操作AEM页面节点，在之前的例子中steven.html作为一个页面我们可以通过以下方式获取到页面的资源和信息，在中init方法进行修改，查看日志结果，获取到的页面为steven

// resourceResolver是资源转换类，可以通过此类获取对应的页面，也可以转换为其他API
PageManager pageManager = resourceResolver.adaptTo(PageManager.class);
// pageManager可以通过页面路径获取到对应的Page对象
Page page = pageManager.getPage("/content/wknd/us/en/steven");
// 也可以直接使用currentPage
log.info("page title = {}", page.getTitle());
// 所以从pageManager中通过路径获取到Page对象和currentPage对象，表示的是JCR中同一个页面节点
log.info("current page title = {}", currentPage.getTitle());

查看日志

20.02.2023 15:24:20.178 *INFO* [[0:0:0:0:0:0:0:1] [1676877860073] GET /content/wknd/us/en/steven.html HTTP/1.1] com.adobe.aem.guides.wknd.core.models.Translate page title = steven
20.02.2023 15:24:20.178 *INFO* [[0:0:0:0:0:0:0:1] [1676877860073] GET /content/wknd/us/en/steven.html HTTP/1.1] com.adobe.aem.guides.wknd.core.models.Translate current page title = steven

Sling API

由于Sling和JCR标准本身是没有页面和站点之类的概念的，这些概念都是AEM自带的。所以需要访问页面就要用到SlingHttpServletRequest类，与我们在Java中用到的Http请求类是一样的。也可以通过SlingHttpServletRequest来获取当前页面的路径

// 通过SlingHttpServletRequest也可以获取到当前页面的地址信息
String path = request.getHeader("Referer");
log.info("page request path : {}", path);

查看日志可以看到路径信息

20.02.2023 15:47:53.191 *INFO* [[0:0:0:0:0:0:0:1] [1676879273069] GET /content/wknd/us/en/steven.html HTTP/1.1] com.adobe.aem.guides.wknd.core.models.Translate page request path : http://localhost:4502/editor.html/content/wknd/us/en/steven.html

拿到页面信息后，我们就可以继续获取到页面下的所有节点、组件的信息和数据，打开http://localhost:4502/crx/de/index.jsp我们可以看到steven页面下的所有信息
在这里插入图片描述

每个节点的数据都会保存在节点名称下jcr:content节点中，通过page获取jcr:title即页面的标题

// 获取到地址信息后，就可以拿到这个页面下所有的节点和数据内容，由于page和currentPage表示同一个页面节点，所以拿到的页面内容是一致的
ValueMap pageVM = page.getProperties();
ValueMap currentPageVM = currentPage.getProperties();
log.info("title = {}", pageVM.get(JcrConstants.JCR_TITLE, String.class));
log.info("title = {}", currentPageVM.get(JcrConstants.JCR_TITLE, String.class));

查看日志

20.02.2023 15:58:47.853 *INFO* [[0:0:0:0:0:0:0:1] [1676879927738] GET /content/wknd/us/en/steven.html HTTP/1.1] com.adobe.aem.guides.wknd.core.models.Translate title = steven
20.02.2023 15:58:47.853 *INFO* [[0:0:0:0:0:0:0:1] [1676879927738] GET /content/wknd/us/en/steven.html HTTP/1.1] com.adobe.aem.guides.wknd.core.models.Translate title = steven

也可以通过Sling API来创建页面和资源，通过模板来创建页面

String templatePath = "/conf/wknd/settings/wcm/templates/steven";
pageManager.create("/content/wknd/us/en", "steven-new", templatePath, "steven new page", true);
resourceResolver.commit();

查看站点，和steven页面同级会生成一个新的页面steven-new
在这里插入图片描述

同理还可以使用resourceResolver类创建资源节点

JCR API

JCR（Java Content Repository）是基于树形结构的非关系型数据存储库，本身含有大量的API，支持各种各样的CRUD。但是在AEM中还是更推荐AEM自身封装的高级API。常用的创建节点的API可以使用JcrUtil，常见的JCR常量也可以从JcrConstants.class中找到。

看到了JCR中的节点，如果我们要想获取组件的内容和数据，有两种方法，一种是遍历页面的所有子节点，找到sling:resourceType为对应组件路径的节点，另一种是使用AEM API快速获取。

@ScriptVariable
private ValueMap properties;

// 获取组件属性及内容
ValueMap valueMap = resource.getValueMap();
log.info(valueMap.get("appId", String.class));
log.info(properties.get("appId", String.class));

查看日志

20.02.2023 16:24:21.466 *INFO* [[0:0:0:0:0:0:0:1] [1676881461351] GET /content/wknd/us/en/steven.html HTTP/1.1] com.adobe.aem.guides.wknd.core.models.Translate appId from resource = 2e4d3244dcd719a1
20.02.2023 16:24:21.466 *INFO* [[0:0:0:0:0:0:0:1] [1676881461351] GET /content/wknd/us/en/steven.html HTTP/1.1] com.adobe.aem.guides.wknd.core.models.Translate appId from properties = 2e4d3244dcd719a1

从Resource对象中获取的属性对象ValueMap中可以通过变量名获取到appId，也可以通过注解@ScriptVariable声明ValueMap来获取appId

OSGI API

我们可以打开Adobe Experience Manager Web Console - Configuration来查看本地有哪些服务、Bundles、日志、状态等等信息。点击OSGi标签可以看到，OSGi管理Bundles、组件、配置信息、时间、日志、服务、依赖包，也是非常常用的一个配置信息界面。
请添加图片描述

在后续的章节中会讲到使用@Component注解编写一个OSGi的service和管理OSGi配置信息。AEM中常用的API就讲解完了，下一章会继续讲解如何实现自定义日志。

java中简单的翻页功能的实现（PageManager）
Blog of Alex Wan
07-17 4997
package util;import java.util.List;public class PageManager{    private List allRecords = null;//collection储存同一类型的对象的集合    private int currentPage = 0;//当前页码    private int totalPage = 0;//总页数    pr
java实现翻页_java中简单的翻页功能的实现（PageManager）
weixin_39718006的博客
02-16 1678
package util;import java.util.List;public class PageManager{private List allRecords = null;//collection储存同一类型的对象的集合private int currentPage = 0;//当前页码private int totalPage = 0;//总页数private int recordPe...
Aem
02-18
WKND Sites项目 这是Adobe Docs多部分系列的代码伴侣： 模组 该项目的主要部分是： 核心：包含所有核心功能（例如OSGi服务，侦听器或调度程序）以及与组件相关的Java代码（例如Servlet或请求过滤器）的Java捆绑包。 ui.apps：包含项目的/ apps（和/ etc）部分，即JS＆CSS clientlib，组件，模板，特定于运行方式的配置以及Hobbes测试 ui.content：使用ui.apps中的组件包含样本内容 ui.tests：Java捆绑包，包含在服务器端执行的JUnit测试。 该捆绑包不会部署到生产中。 ui.launcher：包含粘合代码，该粘合代码将ui.tests捆绑包（和相关捆绑包）部署到服务器并触发远程JUnit执行 如何建造 要构建在项目根目录中运行的所有模块，请使用Maven 3使用以下命令： mvn clean inst
在AEM中使用Sling Models
KevinLiu
04-07 969
使用Sling Models 示例 现在让我们看一个Sling Models的例子 创建一个新的AEM项目（参考前面博文），然后在您的AEM实例中进行部署。 转到CRXDE，然后在/apps中的项目下使用以下配置创建一个新组件 现在，使用以下配置在组件节点下创建dialog节点 将代码进行同步到本地 现在，使用以下配置在组件节点下创建dialog节点 <?xml version=...
在AEM中使用Sling Servlet
KevinLiu
04-07 1438
目录Servlet注册Servlet的类型Sling Servlet示例 Servlet是用于扩展服务器功能的类，该服务器承载通过请求-响应编程模型访问的应用程序。对于此类应用程序，Servlet技术定义了HTTP特定的Servlet类。 所有Servlet必须实现Servlet接口，该接口定义了生命周期方法。实现通用服务时，我们可以使用或扩展Java Servlet API随附的GenericS...
20、Workflow In AEM （一）
stiven46的博客
03-25 249
Workflow In AEM
aem-groovy-console:AEM Groovy控制台提供了一个界面，用于在AEM容器中运行Groovy脚本。 可以创建脚本来处理JCR中的内容，调用OSGi服务或使用CQ，Sling或JCR API执行任意代码
05-28
可以使用AEM，Sling或JCR API创建脚本来操纵JCR中的内容，调用OSGi服务或执行任意代码。 在AEM中安装软件包后（以下说明），请参阅以获取有关可用绑定和方法的文档。 软件包中包含示例脚本，以供参考。 要求 在上...
AEM基础知识学习文档资料包
04-08
此外，理解JCR查询语言（SOLR或Oak Query）和使用AEM的API（如CRXDE Lite）调试也是非常重要的技能。 通过这个"AEM基础知识学习文档资料包"，你可以系统地学习到AEM的基础概念、架构、开发流程以及最佳实践。逐步...
AEM-Email-Example:使用 ACS Commons Email API 的 AEM 电子邮件组件
06-20
使用 ACS Commons Email API 的 AEM 电子邮件组件 开发者：Scott Westover 博客： ://scottwestover.blogspot.com/ 您可以在此处找到有关如何构建组件的教程： 此组件是使用 AEM 6 构建的。为了使用此组件，您必须...
aem-headless-client-sdk
04-08
该存储库应尽快公开，尤其是如果它使用GitHub Actions：我们的github操作分钟数有限，私有存储库中的操作相对于我们的2000分钟上限。 安装 $ npm install @adobe/aem-headless-client 用法 创建AEMHeadless客户端 ...
aem-asset-selector
04-01
这个组件可能是一个定制化的解决方案，帮助用户在AEM环境中更有效地浏览、搜索和选择数字资产。AEM是一个强大的内容管理平台，广泛应用于企业构建数字体验。 描述中同样提到 "aem-asset-selector"，暗示这是一个...
sling：用于创建和发送API请求的Go HTTP客户端库
02-21
吊索 Sling是用于创建和发送API请求的Go HTTP客户端库。 吊索存储HTTP请求属性，以简化发送请求和解码响应的过程。 检查或以了解如何将Sling组合到您的API客户端中。 特征 方法设置者：获取/发布/放置/补丁/删除/标题 添加或设置请求头 基础/路径：为不同的端点扩展一个吊索 将结构编码为URL查询参数 将表单或JSON编码到请求正文中 接收JSON成功或失败响应 安装 go get github.com/dghubble/sling 文献资料 阅读 用法 使用Sling设置路径，方法，标题，查询或主体属性，并创建一个http.Request 。 type Params struct { Count int `url:"count,omitempty"` } params := & Params { Count : 5 } req , err := slin
ServerHttpRequest 和 HttpServletRequest区别以及获取IP
热门推荐
qililong88的博客
08-04 1万+
获取ip
Sling CMS 学习：bundles（五）
zhaoqi333的博客
08-21 857
一，创建Sling Bundle Project pom.xml &lt;?xml version="1.0" encoding="ISO-8859-1"?&gt; &lt;!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. Se...
继续在ssh中实现分页排序
zhupengqq的博客
05-30 449
https://blog.csdn.net/zhupengqq/article/details/90691291 忘了说了，最重要的是在这个jsp页面上 CommonDAO dao = (CommonDAO)Info.getDao(request,"CommonDAO"); String hql = "from TStu where 1=1 "; //...
AEM-第一课-环境的搭建和项目的创建
KevinLiu
02-19 4302
AEM-第一课 1.什么是AEM 1.1 AEM 官方定义 1.2 AEM 自我理解 1.2.1 AEM简要介绍 1.2.2 AEM具有以下显著特点： 1.3 AEM 能做什么 2. 本地开发环境的搭建 2.1 所需软件： 2.2 集成开发环境（IDE） 2.3 安装本地AEM实例 2.4 安装Apache Maven 2.5 设置集成开发环境 2.6 故障排除 2.6.1 ...
apipage java,了解AEM中的Java API最佳实践
weixin_29466397的博客
04-01 413
了解Java API最佳实践Adobe Experience Manager(AEM)构建于一个丰富的开放源码软件堆栈上，它公开了许多在开发过程中使用的Java API。 本文探讨了主要API，以及它们的使用时间和用途。AEM基于4个主要Java API集构建。Adobe Experience Manager (AEM)产品抽象，如页面、资产、工作流等Apache SlingWeb Framewo...
【记录四】AEM自定义组件
KevinLiu
10-18 2183
涉及相关 目的 了解如何构建完全自定义的组件。 学习使用Sling模型封装业务逻辑。 了解如何在HTL脚本中使用Sling模型。 效果 开始创造 这个新组件的实现包括一个对话框，该对话框收集副标题内容，并且自定义Sling模型动态检索副标题的 名称 图片 职业 创建Byline组件 首先，创建Byline组件节点结构并定义一个对话框。这表示AEM中的组件，并通过其在JCR中的位置隐式定义了组件...
ExtAspNet秘密花园（四） — 每个页面需要一个PageManager
水果篮子
03-02 6773
每一个使用ExtAspNet控件的页面都必须包含一个PageManager控件，我们可以把PageManager控件看做页面级别的参数配置（相对于Web.config站点级别的参数配置）。   页面级别的参数配置   Theme: 控件主题，目前支持三种主题风格（blue/gray/access，默认值：blue）Language: 控件语言（en/zh_CN/zh_TW/..
Aem开发htl从sling model中获值
最新发布
10-17
在Adobe Experience Manager (AEM) 开发中，HTL（HTML Template Language）是Sightly语法的一种，它结合了HTML和JavaScript，并且非常适合于与Sling Model框架一起工作。Sling Model是一种数据绑定技术，用于从模型...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值