查詢產生器 API query-builder-api

功能 資產共用查詢產生器 會透過Java API和REST API公開。 本節將說明這些API。

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

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

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

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

Gem會議 gem-session

AEM Gems 是Adobe專家對Adobe Experience Manager進行的一系列技術深入探討。 此查詢產生器專用的工作階段對於概述和使用工具非常有用。

範例查詢 sample-queries

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

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

返回所有結果 returning-all-results

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

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
orderby=path

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

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.limit=-1&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.limit=-1
orderby=path

使用p.guessTotal傳回結果 using-p-guesstotal-to-return-the-results

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

參數的缺點是使用者看不到確切的總計。 但您可以設定一個最小數字，例如p.guessTotal=1000，這樣一來，它就一律可讀取到1000，這樣您就能得到較小結果集的確切總數，但如果數字大於此值，您只能顯示「且更多」。

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

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=true&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.guessTotal=true
orderby=path

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

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

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

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&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可調整下列方法：

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

查找jar檔案並訂購，最新優先 find-jar-files-and-order-them-newest-first

http://localhost:4502/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://localhost:4502/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://localhost:4502/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://localhost:4502/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://localhost:4502/bin/querybuilder.json?type=cq:Page&tagid=marketing:interest/product&tagid.property=jcr:content/cq:tags

type=cq:Page
tagid=marketing:interest/product
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://localhost:4502/bin/querybuilder.json?fulltext=Management&group.1_path=/content/geometrixx/en/company/management&group.2_path=/content/geometrixx/en/company/bod&group.p.or=true

fulltext=Management
group.p.or=true
group.1_path=/content/geometrixx/en/company/management
group.2_path=/content/geometrixx/en/company/bod

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

"Management" and ("/content/geometrixx/en/company/management" or "/content/geometrixx/en/company/bod")

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

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

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

搜尋屬性 search-for-properties

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

http://localhost:4502/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPageContent

type=cq:PageContent
property=cq:template
property.value=/apps/geometrixx/templates/homepage

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

http://localhost:4502/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPage

type=cq:Page
property=jcr:content/cq:template
property.value=/apps/geometrixx/templates/homepage

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

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

http://localhost:4502/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=English&type=cq%3aPage

type=cq:Page
1_property=jcr:content/cq:template
1_property.value=/apps/geometrixx/templates/homepage
2_property=jcr:content/jcr:title
2_property.value=English

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

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

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Products&property.2_value=Square&property.3_value=Events

property=jcr:title
property.1_value=Products
property.2_value=Square
property.3_value=Events

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

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=test&property.2_value=foo&property.3_value=bar

property=jcr:title
property.and=true
property.1_value=test
property.2_value=foo
property.3_value=bar

精簡傳回的內容 refining-what-is-returned

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

指定

p.hits=full

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

http://localhost:4502/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=full

使用

p.hits=selective

並指定您要加入的屬性

p.properties

以空格分隔：

http://localhost:4502/bin/querybuilder.json?p.hits=selective&property=jcr%3atitle&property.value=Triangle

http://localhost:4502/bin/querybuilder.json? p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Triangle

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

另外，您可以在QueryBuilder回應中加入子節點。 為此，您需要指定

p.nodedepth=n

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

p.hits=full

範例:

http://localhost:4502/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Triangle

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

更多謂語 morepredicates

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

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

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

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

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

   String fulltextSearchTerm = "Geometrixx";

    // 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://localhost:4502/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=Geometrixx&group.1_fulltext.relPath=jcr:content&group.2_fulltext=Geometrixx&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

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

http://localhost:4502/libs/cq/search/content/querydebug.html

或是在

http://localhost:4502/bin/querybuilder.json?path=/tmp

( path=/tmp 只是範例)。

一般偵錯Recommendations general-debugging-recommendations

通過日誌獲取可解釋的XPath obtain-explain-able-xpath-via-logging

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

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

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

通過日誌獲取可解釋的XPath

透過Query Builder除錯程式取得可說明的XPath

如需如何使用QueryBuilder除錯查詢的執行個體，請參閱下方的影片。

使用記錄對查詢進行調試 debugging-queries-with-logging

執行測試和除錯中所述的查詢時，查詢產生器實作的記錄輸出（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=Geometrixx, relPath=jcr:content}
        {2_fulltext=fulltext: fulltext=Geometrixx, 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, "Geometrixx") or jcr:contains(jcr:content/@cq:tags, "Geometrixx"))]
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連結 javadoc-links