使用 Sling 介面卡 using-sling-adapters

Sling 提供 介面卡模式 方便翻譯實作 可調整 介面。 此介面提供了一般 adaptTo() 將物件轉譯成作為引數傳遞的類別型別的方法。

例如,若要將Resource物件轉譯為對應的Node物件,您只需執行下列動作即可:

Node node = resource.adaptTo(Node.class);

使用案例 use-cases

有以下使用案例:

  • 取得實作特定的物件。

    例如,泛型的JCR型實作 Resource 介面提供對基礎JCR的存取權 Node.

  • 需要傳遞內部前後關聯物件的物件的快速鍵建立。

    例如,以JCR為基礎 ResourceResolver 保留對請求的 JCR Session,根據此請求工作階段運作的許多物件也需要這些資訊,例如 PageManagerUserManager.

  • 服務的捷徑。

    罕見情況 — sling.getService() 也很簡單。

空值傳回值 null-return-value

adaptTo() 可傳回null。

null傳回有多種原因,包括:

  • 實作不支援目標型別
  • 處理此情況的介面卡工廠未啟用(例如,因為遺失服務參考)
  • 內部條件失敗
  • 服務無法使用

請務必謹慎處理Null案例。 對於jsp呈現,如果jsp失敗導致內容空白,這是可以接受的。

快取 caching

為改善效能,實施可自由快取從傳回的物件 obj.adaptTo() 呼叫。 如果 obj 相同,則傳回的物件相同。

系統會針對所有使用者執行此快取 AdapterFactory 根據個案。

但是,沒有一般規則 — 物件可能是新例項或現有例項。 因此,這表示您無法信賴任一行為。 因此,這很重要,尤其是在內部 AdapterFactory,表示此情境中可重複使用物件。

運作方式 how-it-works

有多種方式可以 Adaptable.adaptTo() 可以實作:

  • 物件本身;實作方法本身並對應至特定物件。

  • AdapterFactory,可對應任意物件。

    物件仍必須實作 Adaptable 介面且必須擴充 SlingAdaptable (會傳遞 adaptTo 呼叫中央介面卡管理員)。

    此方法允許連結至 adaptTo 現有類別的機制,例如 Resource.

  • 兩者的組合。

對於第一種情況,Java™檔案可以說明 adaptTo-targets 是可能的。 不過,對於特定子類別(例如JCR型資源),此陳述式通常無法執行。 在後一種情況下,實施 AdapterFactory 通常是套件私用類別的一部分,因此不會顯示在使用者端API中,也不會列在Java™檔案中。 理論上來說,您可以存取 AdapterFactory 來自的實作 osgi 服務執行階段並檢視其「可調整性」(來源和目標)設定,但不會相互對應。 最後,這取決於內部邏輯,而這必須記錄在案。 因此,請參閱此參考檔案。

參考 reference

Sling sling

資源 可調整為:

節點
如果是JCR節點型資源或JCR屬性,則參照節點
屬性
如果是JCR屬性型資源
項目
如果是JCR型資源(節點或屬性)
地圖
如果是JCR節點型資源(或其他支援值的資源對應),則傳回屬性的對應
ValueMap
如果屬性是以JCR節點為基礎的資源(或其他支援值的資源對應),則傳回方便使用的屬性對應。 也可使用(更簡單)達成
ResourceUtil.getValueMap(Resource) (處理null大小寫等)
InheritanceValueMap
延伸 值圖 這允許在尋找屬性時考慮資源的階層
ModifiableValueMap
的延伸 值圖,可讓您修改該節點上的屬性
輸入資料流
傳回檔案資源的二進位內容(如果它是以JCR節點為基礎的資源,且節點型別為 nt:filent:resource;如果是套件資源;檔案內容(如果是檔案系統資源)。 或者,會傳回二進位JCR屬性資源的資料。
URL
傳回資源的URL (若此節點為JCR節點型資源,則傳回該節點的存放庫URL;若為套裝資源,則傳回jar套裝URL;若為檔案系統資源,則傳回檔案URL)
檔案
如果是檔案系統資源
SlingScript
如果資源是指令碼(例如jsp檔案),其指令碼引擎已在sling中註冊
Servlet
如果資源是向sling註冊指令碼引擎的指令碼(例如jsp檔案),或是servlet資源
字串
布林值

兩次
行事曆

String[]
布林值[]
Long[]
行事曆[]
Value[]
如果是以JCR屬性為基礎的資源,則傳回值(且值符合)
LabeledResource
如果是JCR節點型資源
Page
如果它是JCR節點型資源,且節點是 cq:Page (或 cq:PseudoPage)
元件
如果是 cq:Component 節點資源
設計
如果它是設計節點(cq:Page)
範本
如果是 cq:Template 節點資源
藍圖
如果是 cq:Template 節點資源
資產
如果是dam:Asset節點資源
轉譯
如果是dam:Asset轉譯(nt:file,在dam:Assert的轉譯資料夾下)
標記
如果是 cq:Tag 節點資源
使用者管理員
根據JCR工作階段,如果這是JCR型資源,而且使用者有權存取UserManager
可授權項目
「可授權專案」是「使用者」和「群組」的共同基礎介面
使用者
使用者是可驗證及模擬的特殊可授權專案
Simplesearch
在資源底下搜尋(或使用setSearchIn()) (如果它是以JCR為基礎的資源)
工作流程狀態
特定頁面/工作流程裝載節點的工作流程狀態
復寫狀態
指定資源或其jcr:content子節點的復寫狀態(請先核取)
聯結器資源
如果是JCR節點型資源,則傳回適合特定型別的聯結器資源
設定
如果是 cq:ContentSyncConfig 節點資源
ConfigEntry
如果低於 cq:ContentSyncConfig 節點資源

ResourceResolver 可調整為:

工作階段
請求的JCR工作階段,如果是JCR型資源解析器(預設)
PageManager
元件管理員
Designer
Assetmanager
根據JCR工作階段,如果是JCR型資源解析程式
標籤管理員
根據JCR工作階段,如果是JCR型資源解析程式
使用者管理員
UserManager提供可授權物件(即使用者和群組)的存取權及維護方法。 UserManager繫結至特定工作階段
可授權項目
目前使用者
使用者
目前使用者
Querybuilder
Externalizer
用於將絕對URL外部化,即使沒有請求物件亦然

SlingHttpServletRequest 可調整為:

尚未有目標,但實作可調整的,而且可以在自訂AdapterFactory中作為來源使用。

SlingHttpServletResponse 可調整為:

ContentHandler
(XML)
如果這是Sling重寫程式回應

WCM wcm

頁面 可調整為:

Resource
頁面的資源。
LabeledResource
已標示的資源(==此)。
節點
頁面的節點。
...
頁面資源可適應的所有內容。

元件 可調整為:

Resource
元件的資源。
LabeledResource
已標示的資源(==此)。
節點
元件的節點。
元件資源可適應的所有專案。

範本 可調整為:

Resource
範本的資源。
LabeledResource
已標示的資源(==此)。
節點
此範本的節點。
...
可調整範本資源的所有內容。

安全性 security

可授權使用者、和 群組 適應:

節點
傳回使用者/群組主節點。
復寫狀態
傳回使用者/群組主節點的復寫狀態。

DAM dam

資產 可調整為:

Resource
資產的資源。
節點
資產的節點。
資產資源可適應的所有內容。

標記 tagging

標籤 可調整為:

Resource
標籤的資源。
節點
標籤的節點。
標籤的資源可適應的所有內容。

其他 other

此外,Sling / JCR / OCM也提供 AdapterFactory 自訂OCM (物件內容對應)物件。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab