사용자 정의 코드 품질 규칙 custom-code-quality-rules

AEM 엔지니어링의 모범 사례를 기반으로 코드 품질 테스트의 일환으로 Cloud Manager가 실행하는 사용자 정의 코드 품질 규칙에 대해 자세히 알아보십시오.

SonarQube 규칙 sonarqube-rules

다음 섹션에서는 Cloud Manager에서 실행되는 SonarQube 규칙에 대해 자세히 설명합니다.

잠재적으로 위험한 기능을 사용하지 않음 do-not-use-potentially-dangerous-functions

Thread.stop() 및 Thread.interrupt() 메서드는 재현하기 어려운 문제와 경우에 따라 보안 취약성을 발생시킬 수 있습니다. 이러한 사용은 철저하게 모니터링되고 검증되어야 합니다. 일반적으로 메시지 전달은 유사한 목표를 달성하기 위한 보다 안전한 방법입니다.

비준수 코드 non-compliant-code

public class DontDoThis implements Runnable {
  private Thread thread;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    thread.stop();  // UNSAFE!
  }

  public void run() {
    while (true) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

준수 코드 compliant-code

public class DoThis implements Runnable {
  private Thread thread;
  private boolean keepGoing = true;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    keepGoing = false;
  }

  public void run() {
    while (this.keepGoing) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

외부에서 제어할 수 있는 형식 문자열을 사용하지 않음 do-not-use-format-strings-which-may-be-externally-controlled

외부 소스의 형식 문자열(예: 요청 매개변수 또는 사용자 생성 콘텐츠)을 사용하면 애플리케이션이 서비스 거부 공격에 노출될 수 있습니다. 형식 문자열이 외부에서 제어될 수 있지만 신뢰할 수 있는 소스에서만 허용되는 환경이 있습니다.

비준수 코드 non-compliant-code-1

protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response) {
  String messageFormat = request.getParameter("messageFormat");
  request.getResource().getValueMap().put("some property", String.format(messageFormat, "some text"));
  response.sendStatus(HttpServletResponse.SC_OK);
}

HTTP 요청에 항상 소켓 및 연결 시간 초과가 포함되어 있어야 함 http-requests-should-always-have-socket-and-connect-timeouts

AEM 애플리케이션 내부에서 HTTP 요청을 실행할 때 불필요한 스레드 소비를 방지하기 위해 적절한 시간 초과가 구성되도록 하는 것이 중요합니다. 현재 Java™의 기본 HTTP 클라이언트 java.net.HttpUrlConnection과 널리 사용되는 Apache HTTP 구성 요소 클라이언트에는 기본 시간 초과가 없습니다. 따라서 시간 초과를 명시적으로 구성해야 합니다. 가장 좋은 방법은 이러한 시간 초과를 60초 이내로 설정하는 것입니다.

비준수 코드 non-compliant-code-2

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void dontDoThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  HttpClient httpClient = builder.build();

  // do something with the client
}

public void dontDoThisEither() {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

준수 코드 compliant-code-1

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void doThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000)
    .setSocketTimeout(5000)
    .build();
  builder.setDefaultRequestConfig(requestConfig);

  HttpClient httpClient = builder.build();

  // do something with the client
}

public void orDoThis() {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();
  urlConnection.setConnectTimeout(5000);
  urlConnection.setReadTimeout(5000);

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

ResourceResolver 오브젝트를 항상 닫아야 함 resourceresolver-objects-should-always-be-closed

ResourceResolverFactory에서 가져온 ResourceResolver 오브젝트는 시스템 리소스를 사용합니다. ResourceResolver가 더 이상 사용되지 않을 때 이러한 리소스를 회수하는 방법이 있지만 close() 메서드를 호출하여 열려 있는 ResourceResolver 오브젝트를 명시적으로 닫는 것이 더 효율적입니다.

일반적인 오해 중 하나는 기존 JCR 세션을 사용하여 생성된 ResourceResolver 오브젝트는 명시적으로 닫으면 안 된다는 것입니다. 또 다른 오해는 이러한 오브젝트를 닫으면 기본 JCR 세션이 닫힌다는 것입니다. 이는 사실이 아닙니다. ResourceResolver를 여는 방법과 상관없이 더 이상 사용하지 않을 때는 닫아야 합니다. ResourceResolver는 Closeable 인터페이스를 구현하기 때문에 close()를 명시적으로 호출하는 대신 try-with-resources 구문을 사용하는 것도 가능합니다.

비준수 코드 non-compliant-code-4

public void dontDoThis(Session session) throws Exception {
  ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
  // do some stuff with the resolver
}

준수 코드 compliant-code-2

public void doThis(Session session) throws Exception {
  ResourceResolver resolver = null;
  try {
    resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
    // do something with the resolver
  } finally {
    if (resolver != null) {
      resolver.close();
    }
  }
}

public void orDoThis(Session session) throws Exception {
  try (ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object) session))){
    // do something with the resolver
  }
}

슬링 서블릿 경로를 사용하여 서블릿을 등록 안 함 do-not-use-sling-servlet-paths-to-register-servlets

슬링 설명서에 설명된 대로 경로별로 서블릿을 바인딩하는 것은 권장되지 않습니다. 경로 바인딩 서블릿은 표준 JCR 액세스 제어를 사용할 수 없으며, 결과적으로 엄격한 추가 보안이 요구됩니다. 경로 바인딩 서블릿을 사용하는 대신 저장소에 노드를 생성하고 리소스 유형별로 서블릿을 등록하는 것이 좋습니다.

비준수 코드 non-compliant-code-5

@Component(property = {
  "sling.servlet.paths=/apps/myco/endpoint"
})
public class DontDoThis extends SlingAllMethodsServlet {
 // implementation
}

발견된 예외를 기록하거나 표시하되 둘 다 해서는 안 됨 caught-exceptions-should-be-logged-or-thrown-but-not-both

일반적으로 예외는 정확히 한 번 기록해야 합니다. 예외를 여러 번 기록하면 예외가 몇 번 발생했는지 알 수 없으므로 혼동이 발생할 수 있습니다. 이러한 문제를 발생시키는 가장 일반적인 패턴은 발생한 예외의 기록과 표시입니다.

비준수 코드 non-compliant-code-6

public void dontDoThis() throws Exception {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
    throw e;
  }
}

준수 코드 compliant-code-3

public void doThis() {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
  }
}

public void orDoThis() throws MyCustomException {
  try {
    someOperation();
  } catch (Exception e) {
    throw new MyCustomException(e);
  }
}

throw 문 바로 뒤에 오는 log 문 방지 avoid-having-a-log-statement-immediately-followed-by-a-throw-statement

피해야 할 또 다른 일반적인 패턴은 메시지를 기록한 다음 즉시 예외를 발생시키는 것입니다. 이 문제는 일반적으로 예외 메시지가 로그 파일에 중복됨을 나타내는 것입니다.

비준수 코드 non-compliant-code-7

public void dontDoThis() throws Exception {
  logger.error("something went wrong");
  throw new RuntimeException("something went wrong");
}

준수 코드 compliant-code-4

public void doThis() throws Exception {
  throw new RuntimeException("something went wrong");
}

GET 또는 HEAD 요청을 처리할 때 INFO에서 로깅하지 않음 avoid-logging-at-info-when-handling-get-or-head-requests

일반적으로 INFO 로그 수준은 중요한 작업을 구분하는 데 사용되어야 하며 기본적으로 AEM은 INFO 수준 또는 그 이상에서 기록되도록 구성됩니다. GET 및 HEAD 메서드는 읽기 전용 작업이어야 하므로 중요한 작업을 구성하지 않습니다. GET 또는 HEAD 요청에 대한 응답으로 INFO 수준에서 로깅하면 상당한 로그 노이즈가 발생하여 로그 파일에서 유용한 정보를 식별하기가 더 어려워질 수 있습니다. GET 또는 HEAD 요청을 처리할 때 문제가 발생한 경우 WARN 또는 ERROR 수준으로 로깅해야 합니다. 더 심층적인 문제 해결 정보를 얻으려면 로깅을 DEBUG 또는 TRACE 수준으로 설정해야 합니다.

비준수 코드 non-compliant-code-8

public void doGet() throws Exception {
  logger.info("handling a request from the user");
}

준수 코드 compliant-code-5

public void doGet() throws Exception {
  logger.debug("handling a request from the user.");
}

logging 문의 첫 번째 매개변수로 Exception.getMessage() 사용 안 함 do-not-use-exception-getmessage-as-the-first-parameter-of-a-logging-statement

가장 좋은 방법은 로그 메시지가 애플리케이션에서 예외가 발생한 위치에 대한 상황별 정보를 제공하는 것입니다. 스택 추적을 사용하여 컨텍스트를 결정할 수도 있지만 일반적으로 로그 메시지는 읽고 이해하는 것이 더 쉬울 것입니다. 따라서 예외를 기록할 때 예외 메시지를 로그 메시지로 사용하는 것은 잘못된 관행입니다. 예외 메시지에는 발생한 문제에 대해 자세히 설명되어 있습니다. 반면에, 로그 메시지는 예외가 발생했을 때 애플리케이션이 무엇을 하고 있었는지를 나타냅니다. 예외 메시지는 계속 기록됩니다. 고유한 메시지를 지정하면 로그를 쉽게 이해할 수 있습니다.

비준수 코드 non-compliant-code-9

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error(e.getMessage(), e);
  }
}

준수 코드 compliant-code-6

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

Catch 블록에 로그인할 때 WARN 또는 ERROR 수준을 유지해야 함 logging-in-catch-blocks-should-be-at-the-warn-or-error-level

이름에서 알 수 있듯이 Java™ 예외는 예외적인 상황에서 항상 사용되어야 합니다. 결과적으로 예외가 발생하면 로그 메시지가 WARN 또는 ERROR 중 적절한 수준으로 기록되도록 하는 것이 중요합니다. 이렇게 하면 해당 메시지가 로그에 올바르게 표시됩니다.

비준수 코드 non-compliant-code-10

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.debug(e.getMessage(), e);
  }
}

준수 코드 compliant-code-7

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

콘솔에 스택 추적을 인쇄하지 않음 do-not-print-stack-traces-to-the-console

로그 메시지를 이해할 때 컨텍스트는 중요합니다. Exception.printStackTrace()를 사용하면 스택 추적만 표준 오류 스트림으로 출력되므로 모든 컨텍스트가 손실됩니다. 또한 AEM과 같은 다중 스레드 애플리케이션에서 이 방법을 사용하여 여러 예외를 병렬로 인쇄하면 스택 추적이 겹쳐서 상당한 혼동을 일으킬 수 있습니다. 예외는 로깅 프레임워크에서만 기록되어야 합니다.

비준수 코드 non-compliant-code-11

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    e.printStackTrace();
  }
}

준수 코드 compliant-code-8

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

표준 출력 또는 표준 오류로 출력하지 않음 do-not-output-to-standard-output-or-standard-error

AEM에서의 로깅은 항상 로깅 프레임워크인 SLF4J를 통해 수행되어야 합니다. 표준 출력 또는 표준 오류 스트림으로 직접 출력하면 로깅 프레임워크에서 제공하는 구조 및 컨텍스트 정보가 손실되고 경우에 따라 성능 문제가 발생할 수 있습니다.

비준수 코드 non-compliant-code-12

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    System.err.println("Unable to do something");
  }
}

준수 코드 compliant-code-9

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

하드코딩된 /apps 경로 및 /libs 경로 방지 avoid-hardcoded-apps-and-libs-paths

/libs 및 /apps로 시작하는 경로는 일반적으로 하드코딩해서는 안 됩니다. 이러한 경로는 일반적으로 슬링 검색 경로를 기준으로 저장되며, 기본값은 /libs,/apps입니다. 절대 경로를 사용하면 프로젝트 수명 주기의 후반에만 나타나는 미묘한 결함이 발생할 수 있습니다.

비준수 코드 non-compliant-code-13

public boolean dontDoThis(Resource resource) {
  return resource.isResourceType("/libs/foundation/components/text");
}

준수 코드 compliant-code-10

public void doThis(Resource resource) {
  return resource.isResourceType("foundation/components/text");
}

슬링 스케줄러를 사용하면 안 됨 sonarqube-sling-scheduler

보장된 실행이 필요한 작업에는 Sling 스케줄러를 사용하지 마십시오. Sling의 예정된 작업은 실행을 보장하며 클러스터된 환경과 클러스터되지 않은 환경 모두에 더 적합합니다.

클러스터 환경에서 Sling 작업이 처리되는 방법에 대한 자세한 내용은 Apache Sling 이벤트 및 작업 처리 설명서를 참조하십시오.

더 이상 사용되지 않는 AEM API를 사용하면 안 됨 sonarqube-aem-deprecated

AEM API 표면은 사용이 권장되지 않아 더 이상 사용되지 않는 것으로 간주되는 API를 식별하기 위해 지속적으로 수정되고 있습니다.

대부분의 경우 이러한 API는 표준 Java™ @Deprecated 주석을 사용하여 더 이상 사용되지 않으며, squid:CallToDeprecatedMethod에 의해 식별됩니다.

그러나 AEM의 컨텍스트에서는 API가 더 이상 사용되지 않지만 다른 컨텍스트에서는 사용되는 경우가 있습니다. 이 규칙은 이 두 번째 클래스를 식별합니다.

OakPAL 콘텐츠 규칙 oakpal-rules

다음 섹션에서는 Cloud Manager에서 실행되는 OakPAL 검사에 대해 자세히 설명합니다.

@ProviderType으로 주석이 달린 제품 API는 고객이 구현하거나 확장해서는 안 됨 product-apis-annotated-with-providertype-should-not-be-implemented-or-extended-by-customers

AEM API는 사용자 정의 코드에 의해 사용될 뿐 구현되지 않는 Java™ 인터페이스와 클래스를 포함합니다. 예를 들어 AEM만 com.day.cq.wcm.api.Page 인터페이스를 구현합니다.

이러한 인터페이스에 새로운 메서드를 추가해도 기존 코드에는 영향을 미치지 않으므로 새로운 메서드를 추가해도 이전 버전과 호환됩니다. 그러나 사용자 정의 코드로 이러한 인터페이스 중 하나를 구현하는 경우 해당 사용자 정의 코드로 인해 이전 버전과 호환되지 않는 문제가 발생합니다.

AEM은 구현되도록 의도된 인터페이스 및 클래스에 org.osgi.annotation.versioning.ProviderType 또는 경우에 따라 aQute.bnd.annotation.ProviderType 기존 주석을 주석으로 추가합니다. 이 규칙은 사용자 정의 코드가 이러한 인터페이스를 구현하거나 클래스를 확장하는 인스턴스를 감지합니다.

비준수 코드 non-compliant-code-3

import com.day.cq.wcm.api.Page;

public class DontDoThis implements Page {
// implementation here
}

고객 패키지는 /libs에서 노드를 생성하거나 수정해서는 안 됨 oakpal-customer-package

AEM 콘텐츠 저장소의 /libs 콘텐츠 트리는 고객이 읽기 전용으로 간주해야 하는 것이 오랜 모범 사례였습니다. /libs에서 노드 및 속성을 수정하면 주 업데이트 및 부 업데이트에 상당한 위험이 발생합니다. /libs에 대한 편집은 공식 채널을 통해 Adobe에 의해서만 이루어져야 합니다.

패키지에 중복된 OSGi 구성을 포함하지 않음 oakpal-package-osgi

복잡한 프로젝트에서 발생하는 일반적인 문제는 동일한 OSGi 구성 요소가 여러 번 구성되는 경우입니다. 이러한 문제로 인해 어떤 구성이 작동 가능할지 모호해집니다. 이 규칙은 동일한 구성 요소가 동일한 실행 모드 또는 실행 모드 조합에서 여러 번 구성된 문제만 식별한다는 점에서 “실행 모드 인식” 규칙입니다.

비준수 코드 non-compliant-code-osgi

+ apps
  + projectA
    + config
      + com.day.cq.commons.impl.ExternalizerImpl
  + projectB
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

준수 코드 compliant-code-osgi

+ apps
  + shared-config
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

구성 및 설치 폴더에 OSGi 노드만 포함해야 함 oakpal-config-install

보안상의 이유로 /config/ 및 /install/가 포함된 경로는 AEM의 관리 사용자만 읽을 수 있으며 OSGi 구성 및 OSGi 번들에만 사용해야 합니다. 이러한 세그먼트를 포함하는 경로에 다른 유형의 콘텐츠를 배치하면 관리 사용자와 비관리 사용자 간에 의도하지 않게 달라지는 애플리케이션 비헤이비어가 발생합니다.

일반적인 문제는 구성 요소 대화 상자 내에서 config라는 노드를 사용하거나 인라인 편집을 위해 리치 텍스트 편집기 구성을 지정할 때 발생합니다. 이 문제를 해결하려면 문제가 있는 노드의 이름을 규정 준수 이름으로 변경해야 합니다. 리치 텍스트 편집기 구성의 경우 cq:inplaceEditing 노드의 configPath 속성을 사용하여 새 위치를 지정하십시오.

비준수 코드 non-compliant-code-config-install

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    + config [nt:unstructured]
      + rtePlugins [nt:unstructured]

준수 코드 compliant-code-config-install

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    ./configPath = inplaceEditingConfig (String)
    + inplaceEditingConfig [nt:unstructured]
      + rtePlugins [nt:unstructured]

패키지를 겹치지 않음 oakpal-no-overlap

패키지에 중복된 OSGi 구성 규칙을 포함해서는 안 됨과 마찬가지로, 이 문제는 여러 개의 개별 콘텐츠 패키지에 의해 동일한 노드 경로가 기록되는 복잡한 프로젝트에서 일반적인 문제입니다. 콘텐츠 패키지 종속성을 사용하면 일관된 결과를 보장할 수 있지만 중복을 완전히 피하는 것이 좋습니다.

기본 작성 모드는 클래식 UI가 아니어야 함 oakpal-default-authoring

OSGi 구성 com.day.cq.wcm.core.impl.AuthoringUIModeServiceImpl AEM 내의 기본 제작 모드를 정의합니다. AEM 6.4 이후 클래식 UI가 더 이상 사용되지 않으므로 기본 제작 모드가 클래식 UI로 구성되면 문제가 발생합니다.

대화 상자가 있는 구성 요소에는 터치 UI 대화 상자가 있어야 함 oakpal-components-dialogs

클래식 UI 대화 상자가 있는 AEM 구성 요소에는 클래식 UI를 지원하지 않는 Cloud Service 배포 모델과의 최적의 작성 및 호환성을 위해 터치 UI 대화 상자도 있어야 합니다. 이 규칙은 다음 시나리오를 확인합니다.

AEM 현대화 도구 설명서는 구성 요소를 클래식 UI에서 터치 UI로 변환하는 방법에 대한 세부 정보와 도구를 제공합니다. 자세한 내용은 AEM 현대화 도구 설명서를 참조하십시오.

역방향 복제 에이전트를 사용하면 안 됨 oakpal-reverse-replication

릴리스 정보: 복제 에이전트 제거에서 설명한 대로 Cloud Service 배포에서는 역방향 복제에 대한 지원을 사용할 수 없습니다.

역방향 복제를 사용하는 고객은 Adobe에 대체 솔루션을 문의해야 합니다.

프록시가 활성화된 클라이언트 라이브러리에 포함된 리소스는 “resources” 폴더에 있어야 함 oakpal-resources-proxy

AEM 클라이언트 라이브러리는 이미지 및 글꼴과 같은 정적 리소스를 포함할 수 있습니다. 클라이언트측 라이브러리 사용 설명서에 설명된 대로 프록시 클라이언트 라이브러리를 사용할 때 게시 인스턴스에서 효과적으로 참조하려면 이러한 정적 리소스가 resources라는 하위 폴더에 포함되어 있어야 합니다.

비준수 코드 non-compliant-proxy-enabled

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + images
        + myimage.jpg

준수 코드 compliant-proxy-enabled

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + resources
        + myimage.jpg

Cloud Service의 호환되지 않는 워크플로 프로세스 사용 oakpal-usage-cloud-service

AEM Cloud Service에서 자산 처리를 위해 Asset 마이크로 서비스로 이동하면서 AEM의 온프레미스 및 AMS 버전에서 사용되던 여러 워크플로 프로세스가 지원되지 않거나 불필요하게 되었습니다.

AEM Assets as a Cloud Service GitHub 저장소에 있는 마이그레이션 도구를 사용하여 AEM as a Cloud Service로 마이그레이션하는 동안 워크플로 모델을 업데이트할 수 있습니다.

편집 가능한 템플릿을 위해 정적 템플릿을 사용하지 않음 oakpal-static-template

정적 템플릿의 사용은 역사적으로 AEM 프로젝트에서 흔했지만 편집 가능한 템플릿은 가장 유연하고 정적 템플릿에 없는 추가 기능을 지원하기 때문에 적극 권장됩니다. 자세한 내용은 페이지 템플릿 - 편집 가능 문서에서 확인할 수 있습니다.

정적 템플릿에서 편집 가능 템플릿으로의 마이그레이션은 AEM 현대화 도구를 사용하여 대부분 자동화할 수 있습니다.

기존 기초 구성 요소를 사용하지 않음 oakpal-usage-legacy

레거시 Foundation 구성 요소(즉, /libs/foundation 아래의 구성 요소)는 핵심 구성 요소를 위한 여러 AEM 릴리스에서 더 이상 사용되지 않습니다. 기존 Foundation 구성 요소를 오버레이 또는 상속 여부에 관계없이 사용자 정의 구성 요소의 기준으로 사용하는 것은 권장되지 않으며 해당 핵심 구성 요소로 변환해야 합니다.

이러한 변환은 AEM 현대화 도구를 통해 촉진될 수 있습니다.

사용자 정의 검색 인덱스 정의 노드는 /oak:index의 직접 하위 노드여야 함 oakpal-custom-search

AEM Cloud Service를 사용하려면 사용자 정의 검색 인덱스 정의(즉, oak:QueryIndexDefinition 유형의 노드)가 /oak:index의 직접 하위 노드여야 합니다. AEM Cloud Service와 호환되려면 다른 위치의 인덱스를 이동해야 합니다. 검색 인덱스에 대한 자세한 내용은 콘텐츠 검색 및 색인화 설명서를 참조하십시오.

사용자 정의 검색 인덱스 정의 노드의 compatVersion을 2로 설정해야 함 oakpal-custom-search-compatVersion

AEM Cloud Service를 사용하려면 사용자 정의 검색 인덱스 정의(즉, oak:QueryIndexDefinition 유형의 노드)에 2로 설정된 compatVersion 속성이 있어야 합니다. 다른 값은 AEM Cloud Service에서 지원되지 않습니다. 검색 인덱스에 대한 자세한 내용은 콘텐츠 검색 및 색인화 설명서를 참조하십시오.

사용자 정의 검색 인덱스 정의 노드의 하위 노드 유형은 nt:unstructured여야 함 oakpal-descendent-nodes

사용자 정의 검색 인덱스 정의 노드에 순서가 지정되지 않은 하위 노드가 있으면 문제를 해결하기 어려운 문제가 발생할 수 있습니다. 이러한 노드를 방지하려면 oak:QueryIndexDefinition 노드의 모든 하위 노드가 nt:unstructured 유형인 것이 좋습니다.

사용자 정의 검색 인덱스 정의 노드는 하위 노드가 있는 indexRules라는 하위 노드를 포함해야 함 oakpal-custom-search-index

올바르게 정의된 사용자 정의 검색 인덱스 정의 노드에는 indexRules라는 하위 노드가 있어야 하며, 이 노드에는 하나 이상의 하위 노드가 있어야 합니다. 자세한 내용은 Oak 문서에서 확인할 수 있습니다.

사용자 정의 검색 인덱스 정의 노드는 명명 규칙을 준수해야 함 oakpal-custom-search-definitions

AEM Cloud Service를 사용하려면 사용자 정의 검색 인덱스 정의(즉, oak:QueryIndexDefinition 유형의 노드)를 콘텐츠 검색 및 색인화에 설명된 특정 패턴에 따라 지정해야 합니다.

사용자 정의 검색 인덱스 정의 노드는 lucene 유형의 인덱스를 사용해야 함 oakpal-index-type-lucene

AEM Cloud Service를 사용하려면 사용자 정의 검색 인덱스 정의(즉, oak:QueryIndexDefinition 유형의 노드)에 값이 lucene로 설정된 type 속성이 있어야 합니다. 레거시 인덱스 유형을 사용하는 색인화는 AEM Cloud Service로 마이그레이션하기 전에 업데이트해야 합니다. 자세한 내용은 콘텐츠 검색 및 색인화 문서를 참조하십시오.

사용자 정의 검색 인덱스 정의 노드에는 seed라는 속성이 포함되어서는 안 됨 oakpal-property-name-seed

AEM Cloud Service는 사용자 정의 검색 인덱스 정의(즉, oak:QueryIndexDefinition 유형의 노드)에 seed라는 속성을 포함하는 것을 금지합니다. 이 속성을 사용하는 색인화는 AEM Cloud Service로 마이그레이션하기 전에 업데이트해야 합니다. 자세한 내용은 콘텐츠 검색 및 색인화 문서를 참조하십시오.

사용자 정의 검색 인덱스 정의 노드에는 reindex라는 속성이 포함되어서는 안 됨 oakpal-reindex-property

AEM Cloud Service는 사용자 정의 검색 인덱스 정의(즉, oak:QueryIndexDefinition 유형의 노드)에 reindex라는 속성을 포함하는 것을 금지합니다. 이 속성을 사용하는 색인화는 AEM Cloud Service로 마이그레이션하기 전에 업데이트해야 합니다. 자세한 내용은 콘텐츠 검색 및 색인화 문서를 참조하십시오.

UI 콘텐츠 패키지에 색인 정의 노드를 배포하면 안 됨 oakpal-ui-content-package

AEM Cloud Service는 UI 콘텐츠 패키지에 사용자 정의 검색 색인 정의(유형 oak:QueryIndexDefinition의 노드)를 배포할 수 없도록 합니다.

유형 damAssetLucene의 사용자 정의 전체 텍스트 색인 정의는 damAssetLucene 접두사가 올바르게 추가되어야 함 oakpal-dam-asset-lucene

AEM Cloud Service는 damAssetLucene의 사용자 정의 전체 텍스트 색인 정의에 damAssetLucene 이외의 접두사가 붙지 못하도록 합니다.

색인 정의 노드에는 동일한 이름의 속성이 포함되면 안 됨 oakpal-index-property-name

AEM Cloud Service는 사용자 정의 검색 색인 정의(즉, 유형 oak:QueryIndexDefinition의 노드)에 동일한 이름의 속성을 포함하는 것을 금지합니다.

특정 기본 제공 색인 정의는 사용자 정의할 수 없음 oakpal-customizing-ootb-index

AEM Cloud Service는 다음 OOTB 색인의 무단 수정을 금지합니다.

분석기의 토큰화 구성은 tokenizer라는 이름으로 생성해야 함 oakpal-tokenizer

AEM Cloud Service는 분석기에서 잘못된 이름을 가진 토큰화 생성을 금지합니다. 토큰화는 항상 tokenizer로 정의되어야 합니다.

색인화 정의 구성에 공백이 포함되어서는 안 됨 oakpal-indexing-definitions-spaces

AEM Cloud Service는 공백이 있는 속성을 포함하는 색인화 ​​정의 생성을 금지합니다.

Dispatcher 최적화 도구 dispatcher-optimization-tool-rules

다음 섹션에서는 Cloud Manager에서 실행되는 DOT(Dispatcher 최적화 도구) 검사를 나열합니다. GitHub 정의 및 세부 정보를 확인하려면 각 링크를 따르십시오.