伺服器端自訂

Java API

SocialComponent介面

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介面可擴充SocialComponent介面，以更妥善地呈現其他資源的集合。

所有SocialCollectionComponent類別都必須實作介面com.adobe.cq.social.scf.SocialCollectionComponent

SocialComponentFactory介面

SocialComponentFactory(factory)會將SocialComponent註冊到框架中。 工廠提供一種方法，讓架構知道哪些SocialComponents可用於指定resourceType及其優先順序排名*識別多個SocialComponents時。

SocialComponentFactory負責建立所選SocialComponent的例項，以便能夠使用DI實務從工廠插入SocialComponent所需的所有相依性。

SocialComponentFactory是OSGi服務，可存取其他OSGi服務，這些服務可透過建構函式傳遞至SocialComponent。

所有SocialComponentFactory類都必須實作介面com.adobe.cq.social.scf.SocialComponentFactory

SocialComponentFactory.getPriority()方法的實作應傳回最高值，以便工廠用於getResourceType()傳回的指定resourceType。

SocialComponentFactoryManager介面

SocialComponentFactoryManager（管理員）管理在框架中註冊的所有SocialComponents，並負責選擇用於指定資源(resourceType)的SocialComponentFactory。 如果沒有為特定資源類型註冊工廠，則經理將返回具有給定資源的最接近超級類型的工廠。

SocialComponentFactoryManager是OSGi服務，可存取其他OSGi服務，這些服務可透過建構函式傳遞至SocialComponent。

調用com.adobe.cq.social.scf.SocialComponentFactoryManager可獲得對OSGi服務的句柄

HTTP API -POST要求

後操作類

HTTP APIPOST端點是透過實作SlingPostOperation介面（套件org.apache.sling.servlets.post）所定義的PostOperation類。

PostOperation端點實施會將sling.post.operation設定為操作將回應的值。 所有將a:operation參數設為該值的POST請求將委派給此實施類別。

PostOperation調用SocialOperation，該執行操作所需的操作。

PostOperation從SocialOperation接收結果，並將適當的回應傳回給用戶端。

SocialOperation類

每個SocialOperation端點都擴展了AbstractSocialOperation類並覆蓋方法performOperation().。此方法執行完成操作所需的所有操作，並返回SocialOperationResult或擲回OperationException，在這種情況下，返回帶有消息的HTTP錯誤狀態（如果可用），以代替正常JSON響應或成功HTTP狀態代碼。

延伸AbstractSocialOperation可重複使用SocialComponents以傳送JSON回應。

SocialOperationResult類

SocialOperationResult類由SocialComponent、HTTP狀態代碼和HTTP狀態消息組成，由SocialOperation返回。

SocialComponent代表受操作影響的資源。

對於「建立」操作，SocialOperationResult中包含的SocialComponent表示剛建立的資源，對於「更新」操作，它表示操作更改的資源。 沒有為刪除操作返回SocialComponent。

使用的成功HTTP狀態代碼為

• 201：建立操作
• 更新操作200
• 204：刪除操作

OperationException類

如果請求無效或發生其他錯誤（如內部錯誤、錯誤的參數值、不正確的權限等），則執行操作時可能會擲回OperationExcepton。 OperationException由HTTP狀態代碼和錯誤消息組成，這些消息作為對PostOperatoin的響應返回給客戶端。

操作服務類

社交元件框架建議不在SocialOperation類內實施負責執行操作的業務邏輯，而是委派給OSGi服務。 將OSGi服務用於業務邏輯允許由SocialOperation端點作用的SocialComponent與其他代碼整合併應用不同的業務邏輯。

所有OperationService類都擴展AbstractOperationService，允許與正在執行的操作掛鈎的其他擴展。 服務中的每個操作都由SocialOperation類表示。 可通過調用方法在操作執行期間調用OperationExtensions類

• performBeforeActions()
  允許預檢查/預處理和驗證
• performAfterActions()
  允許進一步修改資源或叫用自訂事件、工作流程等

操作擴展類

OperationExtension類別是可插入到操作中的自定義代碼片段，允許定制操作以滿足業務需要。元件的使用者可以動態且逐步地新增功能至元件。 擴充功能/連結模式可讓開發人員專注在擴充功能本身，而無須複製和覆寫整個作業和元件。

程式碼範例

范常式式碼可在Adobe Marketing Cloud GitHub存放庫中使用。 搜尋首碼為aem-communities或aem-scf的專案。

最佳作法

檢視編碼准則區段，了解AEM Communities開發人員的各種編碼准則和最佳實務。

另請參閱UGC🔗的儲存資源提供者(SRP)，以了解如何存取使用者產生的內容。