查詢產生器 API

查詢產生器提供查詢AEM內容存放庫的簡單方式。 功能會透過Java API和REST API公開。 本檔案說明這些API。

伺服器端查詢產生器(QueryBuilder)將接受查詢說明、建立並執行XPath查詢、選擇性篩選結果集，以及視需要擷取Facet。

查詢說明只是一組謂詞(Predicate)。 範例包括全文述詞，此述詞對應於 jcr:contains() 函式。

對於每個謂語類型，都有一個求值器元件(PredicateEvaluator)，知道如何處理XPath、篩選及面向擷取的特定述詞。 很容易建立自訂評估程式，這些評估程式會透過OSGi元件執行階段插入。

REST API可透過HTTP存取完全相同的功能，並在JSON中傳送回應。

Gem會議

AEM Gems 是Adobe專家對Adobe Experience Manager進行的一系列技術深入探討。

您可以 檢閱查詢產生器專用的工作階段 以取得工具的概觀與使用。

範例查詢

這些範例會以Java屬性樣式標籤法提供。 若要與Java API搭配使用，請使用Java HashMap 如下API範例所示。

若 QueryBuilder JSON Servlet，每個範例都包含AEM安裝的範例連結（位於預設位置） http://<host>:<port>)。 請注意，您必須先登入AEM例項，才能使用這些連結。

返回所有結果

以下查詢將 返回十個結果 （或者準確地說，最多10個），但通知您 點擊次數： 即可使用：

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
orderby=path

相同的查詢(連同參數 p.limit=-1)將會 返回所有結果 （根據您的例項，此數字可能會很高）:

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&orderby=path&p.limit=-1

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
p.limit=-1
orderby=path

使用p.guessTotal傳回結果

此 p.guessTotal 參數是傳回適當的結果數，這些結果可借由結合最小可行性而顯示 p.offset 和 p.limit 值。 在大結果集下，使用該參數的優點是提高了效能。 這會避免計算完整總計(例如呼叫 result.getSize())和讀取整個結果集，一直最佳化至OAK引擎和索引。 當結果達數十萬個時，這可能會有顯著差異，包括執行時間和記憶體使用量。

參數的缺點是使用者看不到確切的總計。 但你可以設定一個最小數，如 p.guessTotal=1000 因此，它一律會讀到1000個，因此您會得到較小結果集的確切總計，但如果超出此值，您只能顯示「且更多」。

新增 p.guessTotal=true 查詢以了解其運作方式：

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&p.guessTotal=true&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
p.guessTotal=true
orderby=path

查詢會傳回 p.limit 預設值 10 結果 0 偏移：

"success": true,
"results": 10,
"total": 10,
"more": true,
"offset": 0,

您也可以使用數值來計算最多自訂結果數目上限。 使用與上述查詢相同的查詢，但變更 p.guessTotal to 50:

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&p.guessTotal=50&orderby=path

它會傳回與10個結果相同的預設限制數，但偏移為0，但最多只顯示50個結果：

"success": true,
"results": 10,
"total": 50,
"more": true,
"offset": 0,

實作分頁

依預設，查詢產生器也會提供點擊數。 根據結果大小，確定準確計數可能需要花很長時間，因為需要檢查每個結果以進行訪問控制。 大多數情況下，會使用總計來為使用者UI實作分頁。 由於判斷確切計數可能會很慢，因此建議使用guessTotal功能來實作分頁。

例如，UI可調整下列方法：

• 取得並顯示點擊總數的精確計數(SearchResult.getTotalMatches() 或總計 querybuilder.json 回應)小於或等於100;

• 設定 guessTotal 至100，並呼叫查詢產生器。

• 回應可能會有下列結果：

  • total=43, more=false — 指出點擊總數為43次。 UI最多可在第一個頁面中顯示10個結果，並提供後續3個頁面的分頁。 您也可以使用此實施來顯示描述性文字，例如 「43個結果發現」.
  • total=100, more=true — 指出點擊總數大於100且未知確切計數。 UI最多可在第一頁中顯示10個頁面，並提供後續10個頁面的分頁。 您也可以使用它來顯示類似 「發現100多個結果」. 當使用者前往對查詢產生器進行的後續頁面呼叫時，會增加 guessTotal 以及 offset 和 limit 參數。

guessTotal 當UI需要使用無限捲動時，也應使用，以避免查詢產生器決定確切的點擊計數。

查找jar檔案並訂購，最新優先

http://<host>:<port>/bin/querybuilder.json?type=nt:file&nodename=*.jar&orderby=@jcr:content/jcr:lastModified&orderby.sort=desc

type=nt:file
nodename=*.jar
orderby=@jcr:content/jcr:lastModified
orderby.sort=desc

查找所有頁面並按上次修改的順序排序

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified

type=cq:Page
orderby=@jcr:content/cq:lastModified

查找所有頁面，並依上次修改的、遞減的順序排序

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified&orderby.sort=desc

type=cq:Page
orderby=@jcr:content/cq:lastModified
orderby.sort=desc

全文搜尋，依分數排序

http://<host>:<port>/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc

fulltext=Management
orderby=@jcr:score
orderby.sort=desc

搜尋具有特定標籤的頁面

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&tagid=wknd:activity/cycling&tagid.property=jcr:content/cq:tags

type=cq:Page
tagid=wknd:activity/cycling
tagid.property=jcr:content/cq:tags

使用 tagid 謂語，如果您知道明確標籤ID，則如範例中。

使用 tag 標籤標題路徑的述詞（不含空格）。

因為在上一個範例中，您搜尋的是頁面(cq:Page 節點)，則您需要將該節點的相對路徑用於 tagid.property 謂語，即 jcr:content/cq:tags. 依預設， tagid.property 就是 cq:tags.

搜尋多個路徑（使用群組）

http://<host>:<port>/bin/querybuilder.json?fulltext=Experience&group.1_path=/content/wknd/us/en/magazine&group.2_path=/content/wknd/us/en/adventures&group.p.or=true

fulltext=Experience
group.p.or=true
group.1_path=/content/wknd/us/en/magazine
group.2_path=/content/wknd/us/en/adventures

此查詢使用 群組 （已命名） group)，其作用是在查詢中分隔子運算式，就像括弧在更標準的字句中所做的一樣。 例如，上一個查詢可能以更熟悉的樣式表示，如下：

"Experience" and ("/content/wknd/us/en/magazine" or "/content/wknd/us/en/adventures")

在範例中的群組內， path 述詞被使用多次。 若要區分並排序謂語的兩個例項（某些謂語需要排序），您必須為謂語加上前置詞 N_ where N 是訂購索引。 在上一個範例中，產生的謂語為 1_path 和 2_path.

此 p in p.or 是特殊分隔字元，表示下列內容(在此例中， or)是 參數 組的子謂語，而非組的子謂語，例如 1_path.

若否 p.or 會指定，則所有謂語會AND結合，也就是說，每個結果必須滿足所有謂語。

搜尋屬性

您可在此使用 cq:template 屬性：

http://<host>:<port>/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&type=cq%3aPageContent

type=cq:PageContent
property=cq:template
property.value=/conf/wknd/settings/wcm/templates/adventure-page-template

這有一個缺點，就是 jcr:content 會傳回頁面的節點，而非頁面本身。 要解決此問題，可以按相對路徑進行搜索：

http://<host>:<port>/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&type=cq%3aPage

type=cq:Page
property=jcr:content/cq:template
property.value=/conf/wknd/settings/wcm/templates/adventure-page-template

搜尋多個屬性

當多次使用屬性述詞時，您必須再次新增數字前置詞：

http://<host>:<port>/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=Cycling%20Tuscany&type=cq%3aPage

type=cq:Page
1_property=jcr:content/cq:template
1_property.value=/conf/wknd/settings/wcm/templates/adventure-page-template
2_property=jcr:content/jcr:title
2_property.value=Cycling Tuscany

搜尋多個屬性值

在您要搜尋屬性的多個值時避免大型群組("A" or "B" or "C")，您可以提供多個值給 property 謂語：

http://<host>:<port>/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Cycling%20Tuscany&property.2_value=Ski%20Touring&property.3_value=Whistler%20Mountain%20Biking

property=jcr:title
property.1_value=Cycling Tuscany
property.2_value=Ski Touring
property.3_value=Whistler Mountain Biking

對於多值屬性，您也可以要求多個值相符("A" and "B" and "C"):

http://<host>:<port>/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=Cycling%20Tuscany&property.2_value=Ski%20Touring&property.3_value=Whistler%20Mountain%20Biking

property=jcr:title
property.and=true
property.1_value=Cycling Tuscany
property.2_value=Ski Touring
property.3_value=Whistler Mountain Biking

精簡傳回的內容

依預設，QueryBuilder JSON Servlet會針對搜尋結果中的每個節點（例如路徑、名稱、標題等）傳回一組預設屬性。 若要控制要傳回的屬性，您可以執行下列其中一項操作：

指定

p.hits=full

在這種情況下，每個節點都會包含所有屬性：

http://<host>:<port>/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Cycling%20Tuscany

property=jcr:title
property.value=Cycling Tuscany
p.hits=full

使用

p.hits=selective

並指定您要加入的屬性

p.properties

以空格分隔：

http://<host>:<port>/bin/querybuilder.json?p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Cycling%20Tuscany

property=jcr:title
property.value=Cycling Tuscany
p.hits=selective
p.properties=sling:resourceType jcr:primaryType

另外，您可以在「查詢產生器」回應中加入子節點。 為此，您需要指定

p.nodedepth=n

where n 是您希望查詢傳回的層級數。 請注意，若要傳回子節點，必須由屬性選取器指定

p.hits=full

範例:

http://<host>:<port>/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Cycling%20Tuscany

property=jcr:title
property.value=Cycling Tuscany
p.hits=full
p.nodedepth=5

更多謂語

如需更多述詞，請參閱 查詢產生器述詞參考頁面.

您也可以檢查 Javadoc PredicateEvaluator 類. 這些類的Javadoc包含可使用的屬性清單。

類名的前置詞(例如 similar in SimilarityPredicateEvaluator)是 主要財產 在班裡。 此屬性也是查詢中使用的謂語名稱（小寫為）。

對於這些主體屬性，您可以縮短查詢和使用 similar=/content/en 而不是完全限定的變體 similar.similar=/content/en. 必須將完全限定的表單用於類的所有非主屬性。

查詢產生器API使用範例

   String fulltextSearchTerm = "WKND";

    // create query description as hash map (simplest way, same as form post)
    Map<String, String> map = new HashMap<String, String>();

// create query description as hash map (simplest way, same as form post)
    map.put("path", "/content");
    map.put("type", "cq:Page");
    map.put("group.p.or", "true"); // combine this group with OR
    map.put("group.1_fulltext", fulltextSearchTerm);
    map.put("group.1_fulltext.relPath", "jcr:content");
    map.put("group.2_fulltext", fulltextSearchTerm);
    map.put("group.2_fulltext.relPath", "jcr:content/@cq:tags");

    // can be done in map or with Query methods
    map.put("p.offset", "0"); // same as query.setStart(0) below
    map.put("p.limit", "20"); // same as query.setHitsPerPage(20) below

    Query query = builder.createQuery(PredicateGroup.create(map), session);
    query.setStart(0);
    query.setHitsPerPage(20);

    SearchResult result = query.getResult();

    // paging metadata
    int hitsPerPage = result.getHits().size(); // 20 (set above) or lower
    long totalMatches = result.getTotalMatches();
    long offset = result.getStartIndex();
    long numberOfPages = totalMatches / 20;

    //Place the results in XML to return to client
    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    DocumentBuilder builder = factory.newDocumentBuilder();
    Document doc = builder.newDocument();

    //Start building the XML to pass back to the AEM client
    Element root = doc.createElement( "results" );
    doc.appendChild( root );

    // iterating over the results
    for (Hit hit : result.getHits()) {
       String path = hit.getPath();

      //Create a result element
      Element resultel = doc.createElement( "result" );
      root.appendChild( resultel );

      Element pathel = doc.createElement( "path" );
      pathel.appendChild( doc.createTextNode(path ) );
      resultel.appendChild( pathel );
    }

使用查詢產生器(JSON)Servlet透過HTTP執行的相同查詢：

http://<host>:<port>/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=WKND&group.1_fulltext.relPath=jcr:content&group.2_fulltext=WKND&group.2_fulltext.relPath=jcr:content/@cq:tags&p.offset=0&p.limit=20

儲存和載入查詢

查詢可以儲存到儲存庫，以便以後使用。 此 QueryBuilder 提供 storeQuery 方法，具有下列簽名：

void storeQuery(Query query, String path, boolean createFile, Session session) throws RepositoryException, IOException;

使用 QueryBuilder#storeQuery 方法，給定 Query 會儲存在存放庫中，作為檔案或屬性，根據 createFile 引數值。 下列範例說明如何儲存 Query 到路徑 /mypath/getfiles 作為檔案：

builder.storeQuery(query, "/mypath/getfiles", true, session);

任何先前儲存的查詢都可透過 QueryBuilder#loadQuery 方法：

Query loadQuery(String path, Session session) throws RepositoryException, IOException

例如， Query 儲存到路徑 /mypath/getfiles 可由下列程式碼片段載入：

Query loadedQuery = builder.loadQuery("/mypath/getfiles", session);

測試和除錯

若要播放和偵錯查詢產生器查詢，您可以在

http://<host>:<port>/libs/cq/search/content/querydebug.html

或是使用查詢產生器JSON servlet(位於

http://<host>:<port>/bin/querybuilder.json?path=/tmp

path=/tmp 只是個例子。

一般偵錯Recommendations

通過日誌記錄獲取可解釋的XPath

說明 all 在開發週期期間根據目標索引集查詢。

1. 啟用QueryBuilder的DEBUG日誌以獲取基礎、可解釋的XPath查詢
   • 導覽至 https://<host>:<port>/system/console/slinglog。為建立新記錄器 com.day.cq.search.impl.builder.QueryImpl at 除錯.
2. 為上述類別啟用DEBUG後，記錄檔會顯示查詢產生器產生的XPath。
3. 從關聯查詢生成器查詢的日誌條目複製XPath查詢，例如：
   • com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "WKND") or jcr:contains(jcr:content/@cq:tags, "WKND"))]
4. 將XPath查詢貼入Explain Query as XPath中，以獲得查詢計畫。

透過Query Builder Debugger取得可說明的XPath

使用AEM Query Builder偵錯工具產生可說明的XPath查詢。

1. 在查詢產生器偵錯工具中提供查詢產生器查詢
2. 執行搜索
3. 獲取生成的XPath
4. 將XPath查詢貼入Explain Query as XPath中，以獲得查詢計畫

使用記錄對查詢進行調試

執行上一節所述的查詢時，查詢產生器實作的記錄輸出（INFO層級） 測試和偵錯：

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: limit=20, offset=0[
    {group=group: or=true[
        {1_fulltext=fulltext: fulltext=WKND, relPath=jcr:content}
        {2_fulltext=fulltext: fulltext=WKND, relPath=jcr:content/@cq:tags}
    ]}
    {path=path: path=/content}
    {type=type: type=cq:Page}
]
com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "WKND") or jcr:contains(jcr:content/@cq:tags, "WKND"))]
com.day.cq.search.impl.builder.QueryImpl no filtering predicates
com.day.cq.search.impl.builder.QueryImpl query execution took 69 ms

如果您有使用謂詞求值器來篩選的查詢，或使用按比較器的自定義順序的查詢，查詢中也會注意到：

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: [
    {nodename=nodename: nodename=*.jar}
    {orderby=orderby: orderby=@jcr:content/jcr:lastModified}
    {type=type: type=nt:file}
]
com.day.cq.search.impl.builder.QueryImpl custom order by comparator: jcr:content/jcr:lastModified
com.day.cq.search.impl.builder.QueryImpl XPath query: //element(*, nt:file)
com.day.cq.search.impl.builder.QueryImpl filtering predicates: {nodename=nodename: nodename=*.jar}
com.day.cq.search.impl.builder.QueryImpl query execution took 272 ms

Javadoc連結

Business.Adobe.com資源