查询生成器 API

资产共享查询生成器的功能通过Java API和REST API公开。 本节介绍这些API。

服务器端查询构建器(QueryBuilder)将接受查询描述,创建并运行XPath查询,有选择地过滤结果集,如果需要还提取彩块化。

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

对于每个谓词类型,都有一个计算器组件(PredicateEvaluator),它知道如何处理XPath、筛选和facet提取的特定谓词。 创建自定义求值器非常容易,它们通过OSGi组件运行时插入。

REST API通过HTTP提供对完全相同功能的访问,并在JSON中发送响应。

注意

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

Gem会话

AEM Gemsis公司由Adobe专家向Adobe Experience Manager公司进行了一系列深入的技术开发。此专用于查询生成器的会话对于工具的概述和使用非常有用。

注意

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

示例查询

这些范例以Java属性样式表示法提供。 要将它们与Java API一起使用,请使用Java HashMap,如下面的API范例中所示。

对于QueryBuilder JSON Servlet,每个示例都包含一个指向本地CQ安装的链接(位于默认位置http://localhost:4502)。 请注意,您必须先登录到CQ实例,然后才能使用这些链接。

注意

默认情况下,查询构建器json servlet最多显示10次点击。

添加以下参数后,servlet将显示所有查询结果:

p.limit=-1

注意

要在浏览器中视图返回的JSON数据,您可能需要使用插件,如JSONView for Firefox。

返回所有结果

以下查询将​返回十个结果(或精确到最多十个结果),但通知您实际可用的​命中次数::

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返回结果

p.guessTotal参数的目的是返回通过组合最小可行的p.offset和p.limit值可显示的适当结果数。 使用此参数的优点是在大结果集下提高了性能。 这避免了计算完全总数(如调用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

该查询将返回10结果的p.limit默认值,其偏移值为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

它将返回一个与默认限制相同的数字,该数字限制为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在第一页中最多可显示十个结果,并为后三页提供分页。 您还可以使用此实现显示描述性文本,如​"43 results found"
    • total=100, more=true -指示点击总数大于100且不知道确切计数。UI在第一页中最多可显示10个,并为接下来的10个页面提供分页。 您还可以使用它显示文本,如​“找到100个以上结果”。 当用户转到下一页时,对查询生成器的调用将增加guessTotal以及offsetlimit参数的限制。

guessTotal 还应用于UI需要使用无限滚动的情况,以避免查询生成器确定确切的点击计数。

查找jar文件并对其进行排序,最新优先

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

查找所有页面并按上次修改时间对它们进行排序

http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified

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

查找所有页面并按上次修改时间排序,但降序

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

全文搜索,按得分排序

http://localhost:4502/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc

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

搜索用特定标记标记的页面

“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

在多个路径下搜索(使用组)

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(名为“ 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结合在一起,即每个结果必须满足所有谓词。

注意

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

搜索属性

在此,您将使用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

搜索多个属性

当多次使用属性谓词时,您必须再次添加编号前缀:

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

搜索多个属性值

要避免在搜索属性("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

优化返回的内容

默认情况下,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

更多谓词

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

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

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

对于此类主体属性,您可以缩短查询并使用“ similar=/content/en”而不是完全限定的变体“ similar.similar=/content/en”。 完全限定的表单必须用于类的所有非主属性。

查询生成器API使用示例

   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 );
    }
注意

要了解如何构建使用QueryBuilder API的OSGi捆绑包并在Adobe Experience Manager应用程序中使用该OSGi捆绑包,请参阅创建使用查询生成器API的Adobe CQOSGi捆绑包。

使用查询生成器(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

存储和加载查询

查询可以存储到存储库,以便以后可以使用它们。 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

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

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

测试和调试

要播放和调试querybuilder查询,可使用QueryBuilder调试器控制台(位于

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

或者,在以下位置查询querybuilder json servlet

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

path=/tmp仅是示例)。

常规调试Recommendations

通过记录获取可解释的XPath

根据查询索引集说明开发周期中的​所有​目标。

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

    • 导航到https://<serveraddress>:<serverport>/system/console/slinglog。 在​DEBUG​为com.day.cq.search.impl.builder.QueryImpl创建新记录器。
  • 为上述类启用DEBUG后,日志将显示由查询生成器生成的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查询粘贴到解释查询作为XPath以获取查询计划

通过查询生成器调试器获取可解释的XPath

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

根据查询索引集说明开发周期中的​所有​目标。

通过日志获取可解释的XPath

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

    • 导航到https://<serveraddress>:<serverport>/system/console/slinglog。 在​DEBUG​为com.day.cq.search.impl.builder.QueryImpl创建新记录器。
  • 为上述类启用DEBUG后,日志将显示由查询生成器生成的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查询粘贴到解释查询作为XPath以获取查询计划

通过查询生成器调试器获得可解释的XPath

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

chlimage_1-66

  1. 在查询生成器调试器中提供查询生成器查询
  2. 执行搜索
  3. 获取生成的XPath
  4. 将XPath查询粘贴到Explain查询中作为XPath,以获取查询计划
注意

非querybuilder查询(XPath、JCR-SQL2)可直接提供给“说明查询”。

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

使用日志调试查询

注意

有关登录程序的配置,请参见创建您自己的登录程序和作者

执行测试和调试中所述的查询时,查询生成器实现的日志输出(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 彩块化
com.day.cq.search.facets.buckets 桶(包含在彩块化中)
com.day.cq.search.eval 谓词计算器
com.day.cq.search.facets.extractors Facet提取器(用于计算器)
com.day.cq.search.writer 用于Querybuilder servlet的JSON结果命中程序(/bin/querybuilder.json?lang=zh-Hans)

On this page

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now