服务器端自定义 server-side-customization

Java™ API java-apis

社交组件界面 socialcomponent-interface

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

该接口定义了表示资源所必需的一组GETter。 重要的是，界面规定了Map<String， Object> getAsMap()和String toJSONString()方法，这些方法对于渲染Handlebars模板和公开资源的GETJSON端点很有必要。

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

SocialCollectionComponent接口 socialcollectioncomponent-interface

SocialCollectionComponent接口扩展了SocialComponent接口，以更好地表示作为其他资源集合的资源。

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

SocialComponentFactory接口 socialcomponentfactory-interface

SocialComponentFactory（工厂）向框架注册SocialComponent。 工厂提供了一种方法，让框架知道对于给定的resourceType有哪些SocialComponents可用，以及在标识了多个SocialComponents时它们的优先级排名。

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

SocialComponentFactory是一种OSGi服务，有权访问可通过构造函数传递给SocialComponent的其他OSGi服务。

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

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

SocialComponentFactoryManager接口 socialcomponentfactorymanager-interface

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

SocialComponentFactoryManager是一种OSGi服务，具有其他OSGi服务的访问权限，这些服务可以通过构造函数传递给SocialComponent。

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

HTTP API -POST请求 http-api-post-requests

Postoperation类 postoperation-class

HTTP APIPOST端点是通过实现SlingPostOperation接口（包org.apache.sling.servlets.post）定义的PostOperation类。

PostOperation终结点实现将sling.post.operation设置为操作所回应的值。 所有将：operation参数设置为该值的POST请求都委托给此实现类。

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

PostOperation从SocialOperation接收结果并向客户端返回适当的响应。

SocialOperation类 socialoperation-class

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

扩展AbstractSocialOperation可以重用SocialComponents发送JSON响应。

SocialOperationResult类 socialoperationresult-class

SocialOperationResult类作为SocialOperation的结果返回，由SocialComponent、HTTP状态代码和HTTP状态消息组成。

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

对于Create操作，SocialOperationResult中包含的SocialComponent表示创建的资源，对于Update操作，它表示操作更改的资源。 删除操作未返回SocialComponent。

使用的成功HTTP状态代码包括：

Operationexception类 operationexception-class

如果请求无效或发生其他错误，则执行操作时会引发OperationExcepton。 例如，内部错误、参数值错误或权限错误。 OperationException由HTTP状态代码和错误消息组成，它们作为对PostOperatoin的响应返回到客户端。

操作服务类 operationservice-class

社交组件框架建议不要在SocialOperation类中实现负责执行操作的业务逻辑，而是将其委派给OSGi服务。 将OSGi服务用于业务逻辑允许由SocialOperation端点操作的SocialComponent与其他代码集成并应用不同的业务逻辑。

所有OperationService类都扩展AbstractOperationService，允许附加扩展，这些扩展可以挂接到正在执行的操作。 服务中的每个操作都由SocialOperation类表示。 通过调用方法，可在操作执行期间调用OperationExtensions类

Operationextension类 operationextension-class

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

示例代码 sample-code

示例代码在Adobe Experience Cloud GitHub存储库中可用。 搜索前缀为aem-communities或aem-scf的项目。

最佳实践 best-practices

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

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