SRP和UGC Essentials

上次更新： 2023-05-26
  • 主題：
  • Communities
    檢視有關此主題的更多資訊
  • 建立對象：
  • User

簡介

如果不熟悉儲存資源提供者(SRP)及其和使用者產生內容(UGC)的關係，請造訪 社群內容儲存 和 儲存資源提供者概觀.

本檔案的這個部分提供有關SRP和UGC的一些基本資訊。

StorageResourceProvider API

SocialResourceProvider API (SRP API)是各種Sling資源提供者API的擴充功能。 其中包括對分頁和原子增量的支援（適用於計分和評分）。

SCF元件需要查詢，因為需要依日期、實用性、票數等排序。 所有SRP選項都有彈性的查詢機制，不依賴分組。

SRP儲存位置會納入元件路徑。 SRP API應一律用於存取UGC，因為根路徑取決於所選的SRP選項，例如ASRP、MSRP或JSRP。

SRP API不是抽象類別，而是介面。 自訂實作不應輕易進行，因為當升級至新版本時，會錯過內部實作未來改善的好處。

使用SRP API的方法是透過提供的公用程式，例如SocialResourceUtilities套件中的公用程式。

從AEM 6.0或更舊版本升級時，必須移轉所有SRP的UGC （有開放原始碼工具可用）。 另請參閱 升級至AEM Communities 6.3.

注意

過去，存取UGC的公用程式是在SocialUtils套件中找到，該套件已不存在。

如需更換公用程式，請參閱 SocialUtils重構.

存取UGC的公用程式方法

若要存取UGC，請使用SocialResourceUtilities套件中的方法，該方法會傳回適合從SRP存取UGC的路徑，並取代SocialUtils套件中的過時方法。

以下是在servlet中使用resourceToUGCStoragePath()方法的最小範例：

import com.adobe.cq.social.srp.utilities.api.SocialResourceUtilities;

@Reference
private SocialResourceUtilities socialResourceUtilities;

@Override
protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response) throws ServletException, IOException {
  String ugcPath = socialResourceUtilities.resourceToUGCStoragePath(request.getResource());
  // rest of servlet
}

如需其他SocialUtils取代專案，請參閱 SocialUtils重構.

如需程式碼指南，請造訪 使用SRP存取UGC.

注意

resourceToUGCStoragePath()傳回的路徑為 not 適合 ACL檢查.

存取ACL的公用程式方法

有些SRP實作（例如ASRP和MSRP）會將社群內容儲存在不提供ACL驗證的資料庫中。 陰影節點會提供本機存放庫中ACL可套用的位置。

使用SRP API時，所有SRP選項會在執行所有CRUD作業之前，對陰影位置執行相同的檢查。

若要檢查ACL，請使用傳回適合檢查套用至資源UGC之許可權的路徑的方法。

以下是在servlet中使用resourceToACLPath()方法的簡單範例：

import com.adobe.cq.social.srp.utilities.api.SocialResourceUtilities;

@Reference
private SocialResourceUtilities socialResourceUtilities;

@Override
protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response) throws ServletException, IOException {
  String aclPath = socialResourceUtilities.resourceToACLPath(request.getResource());
  // rest of servlet
}
注意

resourceToACLPath()傳回的路徑為 not 適合 存取UGC 本身。

以下儲存位置的說明在使用JSRP或MSRP開發時可能會有所幫助。 目前沒有存取ASRP中儲存之UGC的UI，因為JSRP (CRXDE Lite)和MSRP （MongoDB工具）。

元件位置

當成員在發佈環境中進入UGC時，他們與作為AEM網站一部分的元件互動。

此類元件的範例為 註釋元件 存在於以下專案中的 社群元件指南 網站。 本機存放庫中註解節點的路徑為：

  • 元件路徑= /content/community-components/en/comments/jcr:content/content/includable/comments

陰影節點位置

建立UGC也會建立 陰影節點 將必要的ACL套用到其中。 本機存放庫中對應陰影節點的路徑是元件路徑的前置陰影節點根路徑的結果：

  • 根路徑 = /content/usergenerated
  • 註解陰影節點= /content/usergenerated/content/community-components/en/comments/jcr:content/content/includable/comments

UGC位置

UGC不會在這兩個位置中建立，且只能使用進行存取。 公用程式方法 會叫用SRP API。

  • 根路徑 = /content/usergenerated/asi/srp-choice
  • jsrp的UGC節點= /content/usergenerated/asi/jcr/content/community-components/en/comments/jcr:content/content/includable/comments/srzd-let_it_be_

注意，針對JSRP，UGC節點將 僅限 出現在輸入它的AEM執行個體（製作或發佈）上。 如果在發佈執行個體上輸入，則無法在作者上的稽核控制檯中進行稽核。

上一頁
Next page

此頁面上的