為查詢產生器實作自訂述詞求值器

本檔案說明如何實作自訂述詞求值器,以擴充查詢產生器

概覽

查詢產生器提供了查詢內容存放庫的簡單方式。 AEM隨附一組謂語求值器🔗,可協助您查詢資料。

不過,您可能想要實作自訂述詞求值器來簡化查詢,該求值器會隱藏一些複雜性,並確保提供更好的語義。

自訂述詞也可以執行XPath不直接可能的其他操作,例如:

  • 從其他服務查詢資料
  • 根據計算自訂篩選
注意

實作自訂述詞時,必須考量效能問題。

秘訣

您可以在查詢產生器檔案中找到查詢範例。

秘訣

您可以在GitHub上找到此頁面的程式碼

注意

本檔案中提供的GitHub上此連結程式碼和程式碼片段僅供示範之用。

詳細資訊中的謂語求值器

謂語求值器處理某些謂語的求值,這些謂語是查詢的定義約束。

它會將較高層級的搜尋限制(例如width>200)對應至符合實際內容模型的特定JCR查詢(例如metadata/@width > 200)。 或者,它可以手動篩選節點並檢查其限制。

秘訣

有關PredicateEvaluatorcom.day.cq.search包的詳細資訊,請參閱Java文檔

為復寫中繼資料實作自訂述詞求值器

例如,本節說明如何建立自訂述詞求值器,以根據復寫中繼資料來協助資料:

  • cq:lastReplicated 儲存上次復寫動作的日期
  • cq:lastReplicatedBy 會儲存觸發上次復寫動作之使用者的id
  • cq:lastReplicationAction 儲存上次復寫動作(例如「啟用」、「停用」)

使用預設謂詞求值器查詢複製元資料

以下查詢將讀取自年初起由admin激活的/content分支中的節點清單。

path=/content

1_property=cq:lastReplicatedBy
1_property.value=admin

2_property=cq:lastReplicationAction
2_property.value=Activate

daterange.property=cq:lastReplicated
daterange.lowerBound=2013-01-01T00:00:00.000+01:00
daterange.lowerOperation=>=

此查詢有效,但難以讀取,並且未突出顯示三個複製屬性之間的關係。 實作自訂謂語求值器可降低此查詢的複雜度並改善其語義。

目標

ReplicationPredicateEvaluator的目標是使用下列語法支援上述查詢。

path=/content

replic.by=admin
replic.since=2013-01-01T00:00:00.000+01:00
replic.action=Activate

使用自訂述詞求值器將復寫中繼資料述詞分組,有助於建立有意義的查詢。

更新Maven相依性

首先,您需要更新專案的Maven相依性。 PredicateEvaluatorcq-search工件的一部分,因此需要將其添加到Maven pom檔案中。

注意

cq-search相依性的範圍設為provided,因為cq-search將由OSGi容器提供。

以下代碼段顯示pom.xml檔案中統一差異格式的差異

@@ -120,6 +120,12 @@
             <scope>provided</scope>
         <dependency>
+            <groupid>com.day.cq</groupid>
+            <artifactid>cq-search</artifactid>
+            <version>5.6.4</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
             <groupid>junit</groupid>
             <artifactid>junit</artifactid>
             <version>3.8.1</version></dependency>

編寫ReplicationPredicateEvaluator

cq-search項目包含AbstractPredicateEvaluator抽象類。 可透過幾個步驟來擴充,以實作您自己的自訂述詞求值器(PredicateEvaluator)。

注意

以下過程說明如何構建Xpath表達式以篩選資料。 另一個選項是實作includes方法,以依列選取資料。 如需詳細資訊,請參閱Java檔案

  1. 建立擴展com.day.cq.search.eval.AbstractPredicateEvaluator的新Java類

  2. 使用@Component類似程式碼片段,以統一差異格式注釋類別

    @@ -19,8 +19,11 @@
      */
     package com.adobe.aem.docs.search;
    
    +import org.apache.felix.scr.annotations.Component;
    +import com.day.cq.search.eval.AbstractPredicateEvaluator;
    
    +@Component(metatype = false, factory = "com.day.cq.search.eval.PredicateEvaluator/repli")
     public class ReplicationPredicateEvaluator extends AbstractPredicateEvaluator {
    
     }
    
    注意

    factory必須是以com.day.cq.search.eval.PredicateEvaluator/開頭並以自訂PredicateEvaluator名稱結尾的唯一字串。

    注意

    PredicateEvaluator的名稱是謂語名稱,用於建立查詢。

  3. 覆寫:

    public String getXPathExpression(Predicate predicate, EvaluationContext context)
    

    在覆寫方法中,您根據引數中提供的Predicate建立Xpath運算式。

復寫中繼資料的自訂謂語求值器範例

PredicateEvaluator的完整實施可能類似於以下類別。

/*
 * #%L
 * aem-docs-custom-predicate-evaluator
 * %%
 * Copyright (C) 2013 Adobe Research
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

package com.adobe.aem.docs.search;

import org.apache.felix.scr.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.day.cq.search.Predicate;
import com.day.cq.search.eval.AbstractPredicateEvaluator;
import com.day.cq.search.eval.EvaluationContext;

@Component(metatype = false, factory = "com.day.cq.search.eval.PredicateEvaluator/repli")

public class ReplicationPredicateEvaluator extends AbstractPredicateEvaluator {

    static final String PE_NAME = "replic";


    static final String PN_LAST_REPLICATED_BY = "cq:lastReplicatedBy";
    static final String PN_LAST_REPLICATED = "cq:lastReplicated";
    static final String PN_LAST_REPLICATED_ACTION = "cq:lastReplicationAction";

    static final String PREDICATE_BY = "by";
    static final String PREDICATE_SINCE = "since";
    static final String PREDICATE_SINCE_OP = " >= ";
    static final String PREDICATE_ACTION = "action";

    Logger log = LoggerFactory.getLogger(getClass());

    /**
     * Returns a XPath expression filtering by replication metadata.
     *
     * @see com.day.cq.search.eval.AbstractPredicateEvaluator#getXPathExpression(com.day.cq.search.Predicate,
     *      com.day.cq.search.eval.EvaluationContext)
     */

    @Override

    public String getXPathExpression(Predicate predicate,
            EvaluationContext context) {

        log.debug("predicate {}", predicate);

        String date = predicate.get(PREDICATE_SINCE);
        String user = predicate.get(PREDICATE_BY);
        String action = predicate.get(PREDICATE_ACTION);

        StringBuilder sb = new StringBuilder();

        if (date != null) {

            sb.append(PN_LAST_REPLICATED).append(PREDICATE_SINCE_OP);
            sb.append("xs:dateTime('").append(date).append("')");

        }

        if (user != null) {

            addAndOperator(sb);
            sb.append(PN_LAST_REPLICATED_BY);
            sb.append("='").append(user).append("'");

        }

        if (action != null) {

            addAndOperator(sb);
            sb.append(PN_LAST_REPLICATED_ACTION);
            sb.append("='").append(action).append("'");

        }

        String xpath = sb.toString();

        log.debug("xpath **{}**", xpath);

        return xpath;

    }

    /**
     * Add an and operator if the builder is not empty.
     *
     * @param sb a {@link StringBuilder} containing the query under construction
     */

    private void addAndOperator(StringBuilder sb) {

        if (sb.length() != 0) {

            sb.append(" and ");

        }

    }

}

本頁內容