查询生成器 API query-builder-api

资产共享查询生成器的功能通过Java™ API和REST API公开。 此部分介绍了这些API。

服务器端查询生成器(QueryBuilder)接受查询说明,创建并运行XPath查询,可以选择筛选结果集,并根据需要提取Facet。

查询描述只是一组谓词(Predicate)。 示例包括与XPath中的jcr:contains()函数对应的全文谓词。

对于每个谓词类型,都有一个计算器组件(PredicateEvaluator),该组件知道如何处理XPath、筛选和Facet提取的特定谓词。 可以轻松创建自定义评估器,这些评估器通过OSGi组件运行时插入。

REST API通过HTTP提供对相同功能的访问,响应以JSON发送。

NOTE
QueryBuilder API是使用JCR API构建的。 您还可以使用OSGi捆绑包中的JCR API查询Adobe Experience Manager JCR。 有关信息,请参阅使用JCR API的Adobe Experience Manager

Gem会议 gem-session

Adobe Experience Manager (AEM) Gems是Adobe专家提供的一系列深入探讨Adobe Experience Manager的技术资料。 专门用于查询生成器的此会话对于概述和使用工具非常有用。

NOTE
AEM Gem会话使用AEM查询生成器轻松搜索表单,以详细了解查询生成器。

示例查询 sample-queries

这些示例以Java™属性样式表示法提供。 要将其与Java™ API结合使用,请使用Java™ HashMap,如下面的API示例所示。

对于QueryBuilder JSON Servlet,每个示例都包含一个指向您的本地CQ安装(默认位置: http://localhost:4502)的链接。 在使用这些链接之前,请登录到您的CQ实例。

CAUTION
默认情况下,查询生成器json servlet最多显示10次点击。
添加以下参数允许servlet显示所有查询结果:
p.limit=-1
NOTE
要在浏览器中查看返回的JSON数据,您可能要使用诸如JSONView for Firefox之类的插件。

返回所有结果 returning-all-results

以下查询​ 返回10个结果(确切地说,最多返回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限制值可以显示的适当数量的结果。 使用该参数的优点是改善了性能,且结果集大。 这样可避免计算完整总计(例如,调用result.getSize())和读取整个结果集,从而可一直优化到Oak引擎和索引。 当有100,000个结果(包括执行时间和内存使用量)时,这可能有显着差异。

此参数的缺点是用户看不到确切的总数。 但您可以设置一个最小值,如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的值更改为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

它返回一个数字,该数字与偏移量为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个作为第一页的一部分显示,并为接下来的10个页面提供分页。 您还可以使用此项显示诸如​ “找到100个以上的结果” ​之类的文本。 当用户进入下一页时,调用查询生成器将增加guessTotal以及offsetlimit参数的上限。

在UI需要使用无限滚动以避免Query Builder确定确切点击计数的情况下,应使用guessTotal

查找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

如果您知道显式标记ID,请使用tagid谓词,如示例中所示。

为标记标题路径使用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_path2_path

p.or中的p是一个特殊分隔符,它指示后面的内容(在本例中为or)是组的​ 参数,而不是组的子谓词,如1_path

如果未给定p.or,则所有谓词都将进行AND运算,即,每个结果必须满足所有谓词。

NOTE
不能在一个查询中使用相同的数字前缀,即使对于不同的谓词也是如此。

搜索属性 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

其中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

有关更多谓词,请参阅查询生成器谓词引用页

您还可以检查PredicateEvaluator类的Javadoc。 这些类的Javadoc包含您可以使用的属性列表。

类名的前缀(例如,SimilarityPredicateEvaluator中的“similar”)是该类的​ 主体属性。 此属性也是要在查询中使用的谓词名称(小写)。

对于此类主体属性,您可以缩短查询并使用“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 );
    }
NOTE
要了解如何生成使用QueryBuilder API并在Adobe Experience Manager应用程序中使用该OSGi包的OSGi包,请参阅创建使用查询生成器AP的Adobe CQ OSGi包I。

使用查询生成器(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方法时,根据createFile参数值,给定的Query将作为文件或属性存储在存储库中。 以下示例显示如何将路径/mypath/getfilesQuery另存为文件:

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

可以使用QueryBuilder#loadQuery方法从存储库加载任何以前存储的查询:

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

例如,存储到路径/mypath/getfilesQuery可通过以下代码片段加载:

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

测试和调试 testing-and-debugging

要尝试和调试QueryBuilder查询,您可以使用位于的QueryBuilder调试器控制台

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

或者查询生成器json servlet位于

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

path=/tmp只是一个示例)。

常规调试Recommendations general-debugging-recommendations

通过日志记录获取可解释的XPath obtain-explain-able-xpath-via-logging

说明在开发周期期间针对目标索引集进行的​ 所有 ​查询。

  • 启用QueryBuilder的DEBUG日志,以获取基础的可解释XPath查询

    • 导航到https://<serveraddress>:<serverport>/system/console/slinglog。 在​ DEBUG ​为com.day.cq.search.impl.builder.QueryImpl创建日志记录器。
  • 为上述类启用DEBUG后,日志会显示由Query Builder生成的XPath。

  • 从关联的QueryBuilder查询的日志条目中复制XPath查询,例如:

    • 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"))]
  • 将XPath查询粘贴到Explain查询中作为XPath以获取查询计划

通过Query Builder调试器获取可解释的XPath obtain-explain-able-xpath-via-the-query-builder-debugger

  • 使用AEM QueryBuilder调试器生成可解释的XPath查询:

说明在开发周期期间针对目标索引集进行的​ 所有 ​查询。

通过日志记录获取可解释的XPath

  • 启用QueryBuilder的DEBUG日志,以获取基础的可解释XPath查询

    • 导航到https://<serveraddress>:<serverport>/system/console/slinglog。 在​ DEBUG ​为com.day.cq.search.impl.builder.QueryImpl创建日志记录器。
  • 为上述类启用DEBUG后,日志会显示由Query Builder生成的XPath。

  • 从关联的QueryBuilder查询的日志条目中复制XPath查询,例如:

    • 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"))]
  • 将XPath查询粘贴到Explain查询中作为XPath以获取查询计划

通过Query Builder调试器获取可解释的XPath

  • 使用AEM QueryBuilder调试器生成可解释的XPath查询:

chlimage_1-66

  1. 在Query Builder调试器中提供Query Builder查询
  2. 执行搜索
  3. 获取生成的XPath
  4. 将XPath查询作为XPath粘贴到Explain查询中以获取查询计划
NOTE
可以直接提供非Querybuilder查询(XPath、JCR-SQL2)来解释查询。

有关如何使用QueryBuilder调试查询的下拉列表,请观看以下视频。

使用日志记录调试查询 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=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
描述
com.day.cq.search
基本QueryBuilder和查询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
Querybuilder servlet的JSON结果命中写入程序(https://experienceleague.adobe.com/bin/querybuilder.json?lang=zh-Hans)
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2