查詢產生器 API query-builder-api

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

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

查詢說明只是一組述詞(Predicate)。 範例包括全文檢索述詞,其對應至 jcr:contains() XPath中的函式。

對於每個述詞型別,都有一個計算器元件(PredicateEvaluator)知道如何處理XPath、篩選和Facet擷取的特定述詞。 可輕鬆建立自訂評估器,並透過OSGi元件執行階段插入。

REST API透過HTTP提供相同功能的存取權,且回應會以JSON傳送。

NOTE
QueryBuilder API是使用JCR API建置。 您也可以使用OSGi套件組合中的JCR API來查詢AEM JCR。 如需詳細資訊,請參閱 使用JCR API查詢Adobe Experience Manager資料.

Gem講座 gem-session

AEM Gems 是Adobe專家提供的一系列深入探討Adobe Experience Manager的技術影片。

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

範例查詢 sample-queries

這些範例以Java™屬性樣式標籤法提供。 若要搭配Java™ API使用,請使用Java™ HashMap 與下列API範例相同。

對於 QueryBuilder JSON Servlet,每個範例都包含指向AEM安裝的範例連結(在預設位置, http://<host>:<port>)。 在使用這些連結之前,請登入您的AEM執行個體。

CAUTION
依預設,查詢產生器JSON servlet最多會顯示十次點選。
新增以下引數可讓servlet顯示所有查詢結果:
p.limit=-1
NOTE
若要在瀏覽器中檢視傳回的JSON資料,您可能會想要使用JSONView for Firefox之類的外掛程式。

傳回所有結果 returning-all-results

下列查詢 傳回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傳回結果 using-p-guesstotal-to-return-the-results

目的 p.guessTotal 引數是傳回適當數目的結果,這些結果可以透過結合最小可行值來顯示 p.offsetp.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 offset:

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

您也可以使用數值,以計入自訂的最大結果數量。 使用與上述相同的查詢,但變更值 p.guessTotal50

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,

實作分頁 implementing-pagination

依預設,查詢產生器也會提供點選次數。 根據結果大小,這個數字可能需要很長的時間,因為要判斷準確的計數,必須檢查每個存取控制結果。 總計主要用於為一般使用者UI實作分頁。 由於判斷確切計數可能會變得緩慢,建議您使用guessTotal功能來實施分頁。

例如,UI可以調整以下方法:

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

  • 設定 guessTotal 以100呼叫查詢產生器。

  • 回應可能會產生下列結果:

    • total=43more=false — 表示總點選數為43。 UI可以在第一頁顯示最多十個結果,並為接下來的三個頁面提供分頁功能。 您也可以使用此實施來顯示描述性文字,例如 「找到43個結果」.
    • total=100more=true — 表示點選總數大於100,但不確定確切計數。 UI最多可在第一頁中顯示十頁,並為接下來的10頁提供分頁。 您也可以使用此功能來顯示文字,例如 「找到100個以上的結果」. 當使用者前往下一頁時,對查詢產生器進行的呼叫將增加限制 guessTotal 以及 offsetlimit 引數。

另外,使用 guessTotal 在使用者介面必須使用無限捲動以避免Query Builder判斷確切點選計數的情況下。

尋找jar檔案並對其進行排序,最新者優先 find-jar-files-and-order-them-newest-first

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

尋找所有頁面,並依上次修改時間排序 find-all-pages-and-order-them-by-last-modified

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

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

尋找所有頁面,並依上次修改時間(降序)排序 find-all-pages-and-order-them-by-last-modified-but-descending

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

全文檢索搜尋,依分數排序 fulltext-search-ordered-by-score

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

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

搜尋具有特定標籤的頁面 search-for-pages-tagged-with-a-certain-tag

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.

搜尋多個路徑(使用群組) search-under-multiple-paths-using-groups

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_ 位置 N 是排序索引。 在上一個範例中,產生的述詞是 1_path2_path.

pp.or 是一個特殊分隔符號,指示接下來的(在此例中為 or)是 引數 的群組,而不是群組的副述詞,例如 1_path.

若否 p.or 給定,然後所有述詞一起進行AND運算,也就是說,每個結果必須滿足所有述詞。

NOTE
您無法在一個單一查詢中使用相同的數值首碼,即使是不同的述詞亦然。

搜尋屬性 search-for-properties

您在這裡使用 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

搜尋多個屬性 search-for-multiple-properties

多次使用屬性述詞時,您必須再次新增數字首碼:

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

搜尋多個屬性值 search-for-multiple-property-values

若要在搜尋屬性的多個值時避免大型群組("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

精簡傳回的專案 refining-what-is-returned

依預設,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

位置 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

更多述詞 morepredicates

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

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

類別名稱的前置詞(例如 similarSimilarityPredicateEvaluator)是 主體屬性 類別的。 此屬性也是要在查詢中使用的述詞名稱(小寫)。

對於這類主體屬性,您可以縮短查詢並使用 similar=/content/en 而不是完整變體 similar.similar=/content/en. 類別的所有非主要屬性都必須使用完整格式。

查詢產生器API使用範例 example-query-builder-api-usage

   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

儲存和載入查詢 storing-and-loading-queries

查詢可以儲存在存放庫中,以便您稍後使用。 此 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);

測試和偵錯 testing-and-debugging

若要解決和偵錯Query Builder查詢,您可以使用位於的Query Builder Debugger主控台

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

或者,您也可以使用位於的查詢產生器JSON servlet

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

path=/tmp 僅供範例使用。

Recommendations的一般偵錯 general-debugging-recommendations

透過記錄取得可解釋的XPath obtain-explain-able-xpath-via-logging

說明 全部 在目標索引集的開發週期中進行查詢。

  1. 啟用QueryBuilder的DEBUG記錄檔以取得基礎的、可解釋的XPath查詢
    • 瀏覽至 https://<host>:<port>/system/console/slinglog. 建立記錄器 com.day.cq.search.impl.builder.QueryImpl偵錯.
  2. 為上述類別啟用DEBUG之後,記錄會顯示查詢產生器產生的XPath。
  3. 從關聯的Query Builder查詢的記錄專案複製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做為XPath,以便您可以取得查詢計畫。

透過Query Builder Debugger取得可說明的XPath obtain-explain-able-xpath-via-the-query-builder-debugger

使用AEM Query Builder Debugger產生可說明的XPath查詢。

Query Builder Debugger

  1. 在Query Builder Debugger中提供查詢產生器查詢
  2. 執行搜尋
  3. 取得產生的XPath
  4. 將XPath查詢貼入Explain Query做為XPath,以便您可以取得查詢計畫
NOTE
非查詢產生器查詢(XPath、JCR-SQL2)可以直接提供來說明查詢。

使用記錄功能偵錯查詢 debugging-queries-with-logging

NOTE
檔案中會說明記錄器的設定 記錄.

執行上一節所述的查詢時,查詢產生器實作的記錄輸出(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
說明
com.day.cq.search
基本查詢產生器和查詢API
com.day.cq.search.result
結果API
com.day.cq.search.facets
Facet
com.day.cq.search.facets.buckets
值區(包含在Facet中)
com.day.cq.search.eval
述詞評估工具
com.day.cq.search.facets.extractors
Facet擷取器(適用於評估器)
com.day.cq.search.writer
查詢產生器servlet的JSON結果點選寫入器(/bin/querybuilder.json)
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab