伺服器端架構
此架構提供API來存取伺服器上的功能,並支援使用者端與伺服器之間的互動。
Java™ API
Java™ API提供可輕鬆繼承或子類別的抽象類別和介面。
主要類別在伺服器端自訂頁面上說明。
請造訪儲存資源提供者概觀,瞭解如何使用UGC。
HTTP API
HTTP API支援輕鬆自訂,並可為PhoneGap應用程式、原生應用程式以及其他整合和混合程式選擇使用者端平台。 此外,HTTP API允許社群網站在沒有使用者端的情況下以服務形式執行,使得框架元件可以整合到任何技術建置的任何網頁中。
HTTP API -GET要求
框架會為每個SocialComponent提供HTTP型API端點。 透過傳送GET要求至具有「.social.json」選擇器+擴充功能的資源來存取端點。 使用Sling時,要求會傳遞給DefaultSocialGetServlet
。
DefaultSocialGetServlet
-
將資源(resourceType)傳遞至
SocialComponentFactoryManager
,並接收能夠選取代表資源的SocialComponent
的SocialComponentFactory。 -
叫用Factory並接收能夠處理資源與要求的
SocialComponent
。 -
叫用
SocialComponent
,它會處理要求並傳回結果的JSON表示法。 -
傳回JSON回應給使用者端。
GET Request
預設的GETservlet會監聽.social.json請求,SocialComponent會以可自訂的JSON回應這些請求。
HTTP API -POST要求
除了GET(讀取)作業之外,框架還定義了端點模式,以啟用元件上的其他作業,包括建立、更新和刪除。 這些端點是HTTP API,可接受輸入並使用HTTP狀態代碼或JSON回應物件回應。
此框架端點模式可讓CUD作業可擴充、可重複使用且可測試。
POST Request
每個SocialComponent作業都有SlingPOST:operation。 每個操作的商業邏輯和維護程式碼都包裝在OperationService中,可透過HTTP API或從其他位置以OSGi服務的形式存取。 提供鉤點可支援之前/之後動作的可插接操作延伸模組。
儲存資源提供者(SRP)
若要瞭解如何處理社群內容存放區中儲存的UGC,請參閱:
- 儲存資源提供者概觀 — 簡介和存放庫使用概觀。
- SRP與UGC Essentials - SRP API公用程式方法與範例。
- 使用SRP存取UGC — 編碼准則。