服务器端自定义

Java API

SocialComponent界面

SocialComponents是POJO，表示AEM Communities功能的资源。 理想情况下，每个SocialComponent都表示一个具有公开GETter的特定resourceType，该GETter向客户端提供数据，以便准确表示资源。 所有业务逻辑和视图逻辑都封装在SocialComponent中，包括网站访客的会话信息（如有必要）。

该界面定义了表示资源所需的一组基本GETter。 重要的是，界面规定了<string object=""> getAsMap()和String toJSONString()方法，这是渲染Handlebars模板和为资源公开GETJSON端点所必需的。

所有SocialComponent类必须实现该接口 com.adobe.cq.social.scf.SocialComponent

SocialCollectionComponent界面

SocialCollectionComponent界面扩展了SocialComponent界面，以更好地表示其他资源集合的资源。

所有SocialCollectionComponent类必须实现接口com.adobe.cq.social.scf.SocialCollectionComponent

SocialComponentFactory界面

SocialComponentFactory（工厂）在框架中注册SocialComponent。 工厂提供了一种方法，让框架知道哪些SocialComponents可用于给定resourceType及其优先级排名&st;识别多个SocialComponent时。

SocialComponentFactory负责创建所选SocialComponent的实例，以便能够使用DI惯例从工厂中注入SocialComponent所需的所有依赖项。

SocialComponentFactory是OSGi服务，可以访问其他OSGi服务，这些服务可以通过构造函数传递到SocialComponent。

所有SocialComponentFactory类必须实施该接口 com.adobe.cq.social.scf.SocialComponentFactory

SocialComponentFactory.getPriority()方法的实现应返回最高值，以便工厂用于getResourceType()返回的给定resourceType。

SocialComponentFactoryManager界面

SocialComponentFactoryManager（经理）管理在框架中注册的所有SocialComponents，并负责选择SocialComponentFactory以用于给定资源(resourceType)。 如果没有为特定resourceType注册工厂，则管理器将返回具有给定资源最接近超级类型的工厂。

SocialComponentFactoryManager是OSGi服务，可以访问其他OSGi服务，这些服务可以通过构造函数传递到SocialComponent。

通过调用获取对OSGi服务的句柄 com.adobe.cq.social.scf.SocialComponentFactoryManager

HTTP API -POST请求

操作后类

HTTP APIPOST端点是通过实施 SlingPostOperation界面（包） org.apache.sling.servlets.post)。

的 PostOperationendpont实施集 sling.post.operation到操作将响应的值。 将an:operation参数设置为该值的所有POST请求都将委派给此实现类。

的 PostOperation调用 SocialOperation执行操作所需的操作。

的 PostOperation从 SocialOperation和会向客户端返回相应的响应。

SocialOperation类

每个 SocialOperation端点扩展AbstractSocialOperation类并覆盖方法 performOperation().此方法将执行完成操作所需的所有操作并返回 SocialOperationResult否则 OperationException，在这种情况下，会返回带有消息的HTTP错误状态（如果可用），而不是正常的JSON响应或成功的HTTP状态代码。

扩展 AbstractSocialOperation使得 SocialComponents以发送JSON响应。

SocialOperationResult类

的 SocialOperationResult类作为 SocialOperation由 SocialComponent、 HTTP状态代码和HTTP状态消息。

的 SocialComponent表示受操作影响的资源。

对于创建操作， SocialComponent包含在 SocialOperationResult表示刚刚创建的资源，并表示更新操作更改的资源。 否 SocialComponent为删除操作返回。

使用的成功HTTP状态代码为

• 201，用于创建操作
• 200 for Update operations
• 204 for Delete操作

操作例外类

安 OperationExcepton如果请求无效或发生其他错误（如内部错误、参数值错误、权限不当等），则在执行操作时可能会引发。 安 OperationException由HTTP状态代码和错误消息组成，该消息将作为对 PostOperatoin.

操作服务类

社交组件框架建议，不要在 SocialOperation类，而是委派给OSGi服务。 对业务逻辑使用OSGi服务允许 SocialComponent，由 SocialOperation端点，与其他代码集成，并应用不同的业务逻辑。

全部 OperationService类扩展 AbstractOperationService，允许可挂接到正在执行的操作的其他扩展。 服务中的每个操作由 SocialOperation类。 的 OperationExtensions在操作执行期间，可通过调用方法来调用类

• performBeforeActions()
  允许进行预检查/预处理和验证
• performAfterActions()
  允许进一步修改资源或调用自定义事件、工作流等

OperationExtension类

OperationExtension类是自定义的代码段，可以插入到操作中，以允许自定义操作以满足业务需求。 组件的使用者可以动态地和递增地向组件添加功能。 扩展/挂接模式允许开发人员仅专注于扩展本身，而无需复制和覆盖整个操作和组件。

示例代码

示例代码在 Adobe Marketing Cloud GitHub 存储库。 搜索带有以下项的项目 aem-communities 或 aem-scf.

最佳实践

查看 编码准则 部分，以了解面向AEM Communities开发人员的各种编码准则和最佳实践。

另请参阅 UGC的存储资源提供程序(SRP) 以了解如何访问用户生成的内容。

Business.Adobe.com 资源

Multichannel Communication Web Content Management Dynamic Media Dynamic Forms Content Management Digital Rights Management