Regole per la qualità del codice personalizzato custom-code-quality-rules

Scopri le regole di qualità del codice personalizzato di Cloud Manager, basate sulle best practice di Adobe Experience Manager Engineering, per garantire codice di alta qualità tramite test approfonditi. Vedi anche test di qualità del codice.

Regole di SonarQube sonarqube-rules

La sezione seguente descrive le regole di SonarQube eseguite da Cloud Manager.

Non utilizzare funzioni potenzialmente pericolose do-not-use-potentially-dangerous-functions

I metodi Thread.stop() e Thread.interrupt() possono generare problemi difficili da riprodurre e, in alcuni casi, vulnerabilità di sicurezza. Il loro utilizzo deve essere controllato e convalidato. In generale, il passaggio di messaggi è un modo più sicuro per raggiungere obiettivi simili.

Codice non conforme 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();
    }
  }
}

Codice conforme 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();
    }
  }
}

Non utilizzare stringhe di formato che possono essere controllate esternamente do-not-use-format-strings-which-may-be-externally-controlled

L’utilizzo di una stringa di formato da un’origine esterna (come un parametro di richiesta o contenuti generati dall’utente) può esporre un’applicazione ad attacchi DoS. In alcune circostanze una stringa di formato può essere controllata esternamente, ma ciò è consentito solo da fonti attendibili.

Codice non conforme 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);
}

Le richieste HTTP devono sempre avere timeout del socket e connessione http-requests-should-always-have-socket-and-connect-timeouts

Quando si effettuano richieste HTTP all’interno di un’applicazione di Experience Manager, è essenziale configurare timeout appropriati per evitare un inutile consumo di thread.
Per impostazione predefinita, sia il client HTTP Java™ (java.net.HttpUrlConnection) che il client Apache HTTP Components ampiamente utilizzato non impongono timeout, pertanto devono essere configurati manualmente. Come best practice, i timeout devono essere impostati su un massimo di 60 secondi.

Codice non conforme 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();
}

Codice conforme 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();
}

Chiudere sempre gli oggetti ResourceResolver resourceresolver-objects-should-always-be-closed

Gli oggetti ResourceResolver ottenuti da ResourceResolverFactory utilizzano risorse di sistema. Sebbene esistano misure per recuperare tali risorse quando un oggetto ResourceResolver non è più in uso, è più efficiente chiudere in modo esplicito qualsiasi oggetto ResourceResolver aperto chiamando il metodo close().

Un equivoco comune è che ResourceResolver oggetti creati con una sessione JCR esistente non devono essere chiusi in modo esplicito o che la loro chiusura influisca sulla sessione JCR. Queste informazioni non sono corrette. ResourceResolver deve essere sempre chiuso quando non è più necessario. Poiché ResourceResolver implementa l'interfaccia Closeable, è possibile utilizzare anche la sintassi try-with-resources anziché chiamare direttamente close().

Codice non conforme 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
}

Codice conforme 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
  }
}

Non utilizzare i percorsi Sling Servlet per registrare i Servlet do-not-use-sling-servlet-paths-to-register-servlets

Come descritto nella documentazione di Sling, i servlet di associazione da percorsi sono sconsigliati. I servlet associati ai percorsi non possono utilizzare controlli dell’accesso JCR standard e, di conseguenza, richiedono un’ulteriore misura di sicurezza. Anziché utilizzare i servlet associati ai percorsi, si consiglia di creare nodi nell’archivio e di registrare i servlet in base al tipo di risorsa.

Codice non conforme non-compliant-code-5

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

Le eccezioni rilevate devono essere registrate o generate, non entrambe caught-exceptions-should-be-logged-or-thrown-but-not-both

In generale, un’eccezione deve essere registrata una sola volta. Registrare le eccezioni più volte può causare confusione. Il motivo è che non è chiaro quante volte si è verificata un’eccezione. Il modello più comune che porta a questo effetto è la registrazione e la generazione di un’eccezione rilevata.

Codice non conforme non-compliant-code-6

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

Codice conforme 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);
  }
}

Evitare le istruzioni di registro immediatamente seguite da un’istruzione di generazione avoid-having-a-log-statement-immediately-followed-by-a-throw-statement

Un altro modello comune da evitare è registrare un messaggio e generare immediatamente un’eccezione. Questo indica in genere che il messaggio di eccezione verrà duplicato nei file di log.

Codice non conforme non-compliant-code-7

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

Codice conforme compliant-code-4

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

Evita la registrazione a INFO durante la gestione delle richieste GET o HEAD avoid-logging-at-info-when-handling-get-or-head-requests

In generale, il livello di registro INFO deve essere utilizzato per delimitare azioni importanti e, per impostazione predefinita, Experience Manager è configurato per registrare a livello INFO o superiore. I metodi GET e HEAD devono essere sempre di sola lettura e non costituiscono pertanto azioni importanti. È probabile che la registrazione a livello INFO in risposta alle richieste GET o HEAD generi un notevole disturbo nel registro, rendendo così più difficile identificare le informazioni utili nei file di log. Quando gestisci le richieste di GET o HEAD, registra a livello di WARN o ERROR in caso di errori. Utilizzare i livelli DEBUG o TRACE se sono necessarie informazioni dettagliate sulla risoluzione dei problemi.

Codice non conforme non-compliant-code-8

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

Codice conforme compliant-code-5

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

Non utilizzare Exception.getMessage() come primo parametro di un'istruzione di registrazione do-not-use-exception-getmessage-as-the-first-parameter-of-a-logging-statement

Come best practice, i messaggi del registro devono fornire informazioni contestuali sulla posizione in cui è stata generata un’eccezione nell’applicazione. Mentre il contesto può essere determinato anche tramite l’utilizzo di tracce dello stack, in generale il messaggio di registro sarà più facile da leggere e comprendere. Di conseguenza, quando si registra un’eccezione, non è consigliabile utilizzare il messaggio di eccezione come messaggio di registro. Il messaggio di eccezione spiega cosa è andato storto, mentre il messaggio di registro dovrebbe informare il lettore su ciò che l’applicazione stava facendo quando si è verificata l’eccezione. Il messaggio di eccezione è comunque registrato. Specificando il messaggio, i registri saranno più facili da comprendere.

Codice non conforme non-compliant-code-9

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

Codice conforme compliant-code-6

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

La registrazione dei blocchi catch deve essere a livello WARN o ERROR logging-in-catch-blocks-should-be-at-the-warn-or-error-level

Come suggerisce il nome, le eccezioni Java™ dovrebbero sempre essere utilizzate in circostanze eccezionali. Di conseguenza, quando viene rilevata un’eccezione, è importante assicurarsi che i messaggi del registro vengano registrati al livello appropriato, WARN o ERROR. Questo processo garantisce che tali messaggi vengano visualizzati correttamente nei registri.

Codice non conforme non-compliant-code-10

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

Codice conforme compliant-code-7

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

Non stampare le tracce dello stack sulla console do-not-print-stack-traces-to-the-console

Come già menzionato, il contesto è fondamentale per comprendere i messaggi del registro. L’utilizzo di Exception.printStackTrace() fa sì che solo la traccia dello stack venga trasmessa al flusso di errore standard, perdendo così tutto il contesto. Inoltre, in un’applicazione multi-thread come Experience Manager, se vengono stampate più eccezioni utilizzando questo metodo in parallelo, le rispettive tracce dello stack possono sovrapporsi e creare confusione. Le eccezioni devono essere registrate solo tramite il framework di registrazione.

Codice non conforme non-compliant-code-11

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

Codice conforme compliant-code-8

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

Non trasmettere a output standard o errore standard do-not-output-to-standard-output-or-standard-error

La registrazione ad Experience Manager deve sempre essere effettuata tramite il framework di registrazione (SLF4J). L’output diretto nei flussi di output standard o errore standard perde le informazioni strutturali e contestuali fornite dal framework di registrazione. A volte può causare problemi di prestazioni.

Codice non conforme non-compliant-code-12

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

Codice conforme compliant-code-9

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

Evitare app e percorsi libs hardcoded avoid-hardcoded-apps-and-libs-paths

I percorsi che iniziano con /libs e /apps in genere non devono essere hardcoded. Questi percorsi vengono in genere memorizzati in relazione al percorso di ricerca Sling, che ha come impostazione predefinita /libs,/apps. L’utilizzo del percorso assoluto può presentare difetti minimi che appariranno solo successivamente nel ciclo di vita del progetto.

Codice non conforme non-compliant-code-13

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

Codice conforme compliant-code-10

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

Non utilizzare lo Sling Scheduler sonarqube-sling-scheduler

Non utilizzare lo Sling Scheduler per le attività che richiedono un’esecuzione garantita. I processi pianificati Sling garantiscono l’esecuzione e sono più adatti per gli ambienti cluster che per quelli non cluster.

Per ulteriori informazioni sulla gestione dei processi Sling in ambienti cluster, consulta Evento Sling di Apache e Gestione dei processi.

Non utilizzare API obsolete di Experience Manager sonarqube-aem-deprecated

La superficie dell’API di Experience Manager è soggetta a revisione costante per identificare le API di cui si sconsiglia l’utilizzo e pertanto considerate obsolete.

In molti casi, queste API vengono indicate come obsolete con l’annotazione Java™ standard @Deprecated e, in quanto tali, identificate con squid:CallToDeprecatedMethod.

Tuttavia, in alcuni casi un’API può essere obsoleta nel contesto di Experience Manager ma non obsoleta in altri contesti. Questa regola identifica questa seconda classe.

Non utilizzare @Inject’annotazione con @Optional nei modelli Sling sonarqube-slingmodels-inject-optional

Il progetto Apache Sling sconsiglia l'utilizzo dell'annotazione @Inject nel contesto dei modelli Sling, in quanto può causare prestazioni non corrette se combinata con DefaultInjectionStrategy.OPTIONAL (a livello di campo o di classe). Invece, devono essere utilizzate iniezioni più specifiche (come le annotazioni @ValueMapValue o @OsgiInjector).

Consulta la documentazione di Apache Sling per ulteriori informazioni sulle annotazioni consigliate e sul motivo per cui questo consiglio è stato creato.

Riutilizzare le istanze di un client HTTPC sonarqube-reuse-httpclient

Le applicazioni AEM spesso raggiungono altre applicazioni utilizzando il protocollo HTTP e Apache HttpClient è una libreria spesso utilizzata per raggiungere questo scopo. Tuttavia, la creazione di un oggetto HttpClient comporta un certo sovraccarico, pertanto tali oggetti devono essere riutilizzati il più possibile.

Questa regola controlla che tale oggetto HttpClient non sia privato all'interno di un metodo, ma globale a livello di classe, in modo da poterlo riutilizzare. In questo caso, il campo HttpClient deve essere impostato nel costruttore della classe o nel metodo activate() (se questa classe è un componente/servizio OSGi).

Consultare la Guida all'ottimizzazione di HttpClient per informazioni su alcune best practice relative all'utilizzo di HttpClient.

Codice non conforme non-compliant-code-14

public void doHttpCall() {
  HttpClient httpclient = HttpClients.createDefault();
  // do something with the httpclient
}

Codice conforme compliant-code-11

public class myClass {

  HttpClient httpclient;

  public void doHttpCall() {
    // do something with the httpclient
  }

}

Regole per i contenuti OakPAL oakpal-rules

Nella sezione seguente sono descritti i controlli OakPAL eseguiti da Cloud Manager.

I clienti non devono implementare o estendere le API di prodotto annotate con @ProviderType product-apis-annotated-with-providertype-should-not-be-implemented-or-extended-by-customers

L'API Experience Manager contiene interfacce e classi Java™ che devono essere utilizzate solo dal codice personalizzato, ma non implementate. Solo Experience Manager, ad esempio, deve implementare l'interfaccia com.day.cq.wcm.api.Page.

Quando a queste interfacce vengono aggiunti nuovi metodi, questi non influiscono sul codice esistente che utilizza tali interfacce. Di conseguenza, l’aggiunta di nuovi metodi a queste interfacce è considerata retrocompatibile. Tuttavia, se il codice personalizzato implementa una di queste interfacce, genera per il cliente un rischio di retrocompatibilità con le versioni precedenti.

Le interfacce e le classi, come implementate da Experience Manager, includono un’annotazione org.osgi.annotation.versioning.ProviderType o a volte un’annotazione aQute.bnd.annotation.ProviderType legacy simile. Questa regola identifica i casi in cui il codice personalizzato implementa tale interfaccia o estende una classe.

Codice non conforme non-compliant-code-3

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

public class DontDoThis implements Page {
// implementation here
}

Gli indici Oak Lucene personalizzati devono avere una configurazione Tika oakpal-indextikanode

Più indici Oak predefiniti in Experience Manager includono una configurazione Tika. Le personalizzazioni di questi indici devono includere una configurazione Tika. Questa regola controlla le personalizzazioni degli indici damAssetLucene, lucene e graphqlConfig e genera un problema se il nodo tika risulta mancante o se nel nodo tika manca un nodo secondario denominato config.xml.

Per ulteriori informazioni sulla personalizzazione delle definizioni dell’indice, consulta Indicizzazione della documentazione.

Codice non conforme non-compliant-code-indextikanode

+ oak:index
    + damAssetLucene-1-custom
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene

Codice conforme compliant-code-indextikanode

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Gli indici Oak Lucene personalizzati non devono essere sincroni oakpal-indexasync

Gli indici Oak di tipo lucene devono essere sempre asincroni. In caso contrario, il sistema potrebbe diventare instabile. Ulteriori informazioni sulla struttura degli indici Lucene sono disponibili nella documentazione di Oak.

Codice non conforme non-compliant-code-indexasync

+ oak:index
    + damAssetLucene-1-custom
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      - tags: [visualSimilaritySearch]
      + tika
        + config.xml

Codice conforme compliant-code-indexasync

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Gli indici Oak DAM Asset Lucene personalizzati sono strutturati correttamente oakpal-damAssetLucene-sanity-check

Affinché la ricerca delle risorse in Experience Manager Assets funzioni correttamente, le personalizzazioni dell'indice Oak damAssetLucene devono seguire una serie di linee guida specifiche di questo indice. Questa regola verifica che la definizione dell'indice debba avere una proprietà multivalore denominata tags, che contiene il valore visualSimilaritySearch.

Codice non conforme non-compliant-code-damAssetLucene

+ oak:index
    + damAssetLucene-1-custom
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      + tika
        + config.xml

Codice conforme compliant-code-damAssetLucene

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

I pacchetti cliente non devono creare o modificare nodi in libs oakpal-customer-package

È una best practice consolidata da tempo che la struttura del contenuto /libs nell’archivio dei contenuti Experience Manager debba essere considerata di sola lettura per i clienti. Modificare nodi e proprietà in /libs crea rischi significativi per gli aggiornamenti principali e secondari. Utilizzare Adobe, tramite i canali ufficiali, per apportare modifiche a /libs.

I pacchetti non devono contenere duplicati delle configurazioni OSGi oakpal-package-osgi

Un problema comune che si verifica in progetti complessi è che lo stesso componente OSGi viene configurato più volte. Questo crea un’ambiguità in merito alla configurazione da applicare. Questa regola è “sensibile alla modalità di esecuzione”, in quanto individua solo i problemi in cui lo stesso componente è configurato più volte nella stessa modalità di esecuzione o nella stessa combinazione di modalità di esecuzione.

Codice non conforme non-compliant-code-osgi

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

Codice conforme compliant-code-osgi

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

Le cartelle di configurazione e installazione devono contenere solo nodi OSGi oakpal-config-install

Per motivi di sicurezza, i percorsi contenenti /config/ e /install/ sono leggibili solo dagli utenti amministratori in Experience Manager e devono essere utilizzati solo per la configurazione OSGi e i bundle OSGi. Se si inseriscono altri tipi di contenuto in percorsi contenenti questi segmenti, il comportamento dell’applicazione varia involontariamente tra utenti amministratori e non amministratori.

Un problema comune è l’utilizzo di nodi denominati config nelle finestre di dialogo dei componenti o quando si specifica la configurazione dell’editor Rich Text per la modifica in linea. Per risolvere questo problema, il nodo che causa la violazione deve essere rinominato con un nome conforme. Per la configurazione del rich text editor, specifica la nuova posizione con la proprietà configPath nel nodo cq:inplaceEditing.

Codice non conforme non-compliant-code-config-install

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

Codice conforme compliant-code-config-install

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

I pacchetti non devono sovrapporsi oakpal-no-overlap

Simile alla regola I pacchetti non devono contenere duplicati delle configurazioni OSGi, questa situazione è un problema comune nei progetti complessi in cui lo stesso percorso del nodo viene scritto da più pacchetti di contenuto separati. Benché sia possibile utilizzare le dipendenze tra pacchetti di contenuti per garantire risultati coerenti, è meglio evitare del tutto le sovrapposizioni.

La modalità di authoring predefinita non deve essere interfaccia classica oakpal-default-authoring

La configurazione OSGi com.day.cq.wcm.core.impl.AuthoringUIModeServiceImpl definisce la modalità di authoring predefinita in Experience Manager. Poiché l’interfaccia classica è diventata obsoleta a partire dalla versione 6.4 di Experience Manager, ora viene segnalato un problema se la modalità di authoring predefinita è configurata sull’interfaccia utente classica.

I componenti con finestre di dialogo devono avere finestre di dialogo per l’interfaccia touch oakpal-components-dialogs

I componenti di Experience Manager che hanno una finestra di dialogo per l’interfaccia classica devono sempre avere una finestra di dialogo corrispondente per l’interfaccia touch. Entrambi offrono un’esperienza di authoring ottimale compatibile con il modello di distribuzione di Cloud Service, in cui l’interfaccia classica non è più supportata. Questa regola verifica i seguenti scenari:

La documentazione sugli strumenti di modernizzazione di Experience Manager fornisce informazioni e strumenti per la conversione dei componenti dall’interfaccia utente classica all’interfaccia Touch. Per ulteriori informazioni, consulta la documentazione degli strumenti di modernizzazione di Experience Manager.

I pacchetti non devono contenere un mix di contenuti mutabili e immutabili oakpal-packages-immutable

Per la compatibilità con il modello di distribuzione di Cloud Service, i singoli pacchetti di contenuti devono contenere contenuti per aree non modificabili dell’archivio (/apps e /libs) o per l’area modificabile (ovvero tutto ciò che non si trova in /apps o /libs), ma non per entrambi i tipi. Ad esempio, un pacchetto che include sia /apps/myco/components/text che /etc/clientlibs/myco non è compatibile con il Cloud Service e causa la segnalazione di un problema.

Per ulteriori informazioni, consulta Struttura dei progetti Experience Manager.

Non utilizzare agenti di replica inversa oakpal-reverse-replication

Il supporto per la replica inversa non è disponibile nelle distribuzioni di Cloud Service, come descritto nelle note sulla versione di Experience Manager as a Cloud Service.

Se utilizzi la replica inversa, contatta Adobe per scoprire le soluzioni alternative.

Le risorse da librerie client abilitate per i proxy devono essere in una cartella denominata risorse oakpal-resources-proxy

Le librerie client Experience Manager possono contenere risorse statiche come immagini e font. Come descritto nel documento Utilizzo dei preprocessori, quando si utilizzano le librerie client abilitate al proxy le risorse statiche devono essere contenute in una cartella secondaria denominata resources affinché sia possibile farvi riferimento nelle istanze di pubblicazione.

Codice non conforme non-compliant-proxy-enabled

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

Codice conforme compliant-proxy-enabled

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

Utilizzo di processi di flusso di lavoro non compatibili con Cloud Service oakpal-usage-cloud-service

Con il passaggio ai microservizi per le risorse per l’elaborazione delle risorse in Adobe Experience Manager as a Cloud Service, diversi processi di flusso di lavoro utilizzati nelle versioni on-premise e AMS non sono più supportati. Anche molti di questi flussi di lavoro sono diventati superflui.

Lo strumento di migrazione nell’archivio GitHub di Assets Experience Manager as a Cloud Service può essere usato per aggiornare i modelli del flusso di lavoro durante la migrazione a Experience Manager as a Cloud Service.

È preferibile utilizzare modelli modificabili rispetto ai modelli statici oakpal-static-template

Sebbene l’utilizzo di modelli statici sia storicamente comune nei progetti di Experience Manager, Adobe consiglia di utilizzare modelli modificabili in quanto forniscono la massima flessibilità e supportano funzionalità aggiuntive non presenti nei modelli statici. Per ulteriori informazioni, consulta il documento Modelli pagina.

La migrazione da modelli statici a modificabili può essere in gran parte automatizzata utilizzando gli strumenti di modernizzazione di Experience Manager.

L’utilizzo dei componenti di base precedenti è sconsigliato oakpal-usage-legacy

I componenti Foundation legacy (ovvero i componenti in /libs/foundation) sono ora obsoleti per diverse versioni di Experience Manager, in favore dei componenti core. L’utilizzo dei componenti Foundation come base per i componenti personalizzati (tramite sovrapposizione o ereditarietà) viene scoraggiato; si consiglia di optare per la conversione nei corrispondenti componenti core.

Strumenti di modernizzazione di Experience Manager possono facilitare questa conversione.

Utilizza solo i nomi e l’ordine delle modalità di esecuzione supportati oakpal-supported-runmodes

Experience Manager as a Cloud Service applica un criterio di denominazione rigoroso per i nomi delle modalità di esecuzione e un ordine rigoroso per tali modalità di esecuzione. L'elenco delle modalità di esecuzione supportate si basa sul documento Distribuzione nell'Experience Manager as a Cloud Service e qualsiasi deviazione da questo elenco è identificata come un problema.

I nodi di definizione dell’indice di ricerca personalizzato devono essere nodi secondari diretti di /oak:index oakpal-custom-search

Experience Manager as a Cloud Service richiede che le definizioni dell’indice di ricerca personalizzato (ovvero i nodi di tipo oak:QueryIndexDefinition) siano nodi secondari diretti di /oak:index. Per la compatibilità con Experience Manager as a Cloud Service è necessario spostare gli indici in altre posizioni. Ulteriori informazioni sugli indici di ricerca sono disponibili nel documento Ricerca e indicizzazione dei contenuti.

I nodi di definizione dell’indice di ricerca personalizzato devono avere una compatVersion di 2 oakpal-custom-search-compatVersion

Experience Manager as a Cloud Service richiede che nelle definizioni dell’indice di ricerca personalizzato (ovvero i nodi di tipo oak:QueryIndexDefinition) la proprietà compatVersion sia impostata su 2. Adobe Experience Manager as a Cloud Service non supporta altri valori. Per ulteriori informazioni sugli indici di ricerca, vedere Ricerca e indicizzazione dei contenuti.

I nodi discendenti dei nodi di definizione dell’indice di ricerca personalizzato devono essere di tipo nt:unstructured

È possibile che si verifichino problemi difficili da risolvere quando un nodo di definizione dell’indice di ricerca personalizzato ha nodi secondari non ordinati. Per evitare questa situazione, è consigliabile che tutti i nodi discendenti di un nodo oak:QueryIndexDefinition siano di tipo nt:unstructured.

I nodi di definizione dell’indice di ricerca personalizzato devono contenere un nodo secondario denominato indexRules con elementi secondari oakpal-custom-search-index

Un nodo di definizione dell'indice di ricerca personalizzato definito correttamente deve contenere un nodo figlio denominato indexRules, che a sua volta deve avere almeno un nodo figlio. Ulteriori informazioni sono disponibili nella sezione Documentazione Oak.

I nodi di definizione dell’indice di ricerca personalizzato devono rispettare le convenzioni di denominazione oakpal-custom-search-definitions

Experience Manager as a Cloud Service richiede che la denominazione delle definizioni dell’indice di ricerca personalizzato (ossia i nodi di tipo oak:QueryIndexDefinition) rispetti un modello specifico descritto nel documento Ricerca e indicizzazione dei contenuti.

I nodi di definizione dell’indice di ricerca personalizzato devono utilizzare il tipo di indice Lucene oakpal-index-type-lucene

Experience Manager as a Cloud Service richiede che le definizioni dell’indice di ricerca personalizzato (ovvero i nodi di tipo oak:QueryIndexDefinition) presentino una proprietà type con valore impostato su lucene. Prima della migrazione a Experience Manager as a Cloud Service è necessario aggiornare l’indicizzazione che utilizza i tipi di indice legacy. Per ulteriori informazioni, consulta il documento Ricerca e indicizzazione dei contenuti.

I nodi di definizione dell’indice di ricerca personalizzato non devono contenere una proprietà denominata seed oakpal-property-name-seed

Experience Manager as a Cloud Service non consente che le definizioni dell’indice di ricerca personalizzato (ovvero i nodi di tipo oak:QueryIndexDefinition) contengano una proprietà denominata seed. Prima della migrazione a Experience Manager as a Cloud Service è necessario aggiornare l’indicizzazione che utilizza questa proprietà. Per ulteriori informazioni, consulta il documento Ricerca e indicizzazione dei contenuti.

I nodi di definizione dell’indice di ricerca personalizzato non devono contenere una proprietà denominata reindex oakpal-reindex-property

Experience Manager as a Cloud Service non consente che le definizioni dell’indice di ricerca personalizzato (ovvero i nodi di tipo oak:QueryIndexDefinition) contengano una proprietà denominata reindex. L’indicizzazione tramite questa proprietà deve essere aggiornata prima della migrazione ad Experience Manager as a
Cloud Service. Per ulteriori informazioni, consulta il documento Ricerca e indicizzazione dei contenuti.

I nodi Lucene delle risorse DAM personalizzati non devono specificare queryPaths oakpal-damAssetLucene-queryPaths

Codice non conforme non-compliant-code-damAssetLucene-queryPaths

+ oak:index
    + damAssetLucene-1-custom-1
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - queryPaths: [/content/dam]
      - type: lucene
      + tika
        + config.xml

Codice conforme compliant-code-damAssetLucene-queryPaths

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Se la definizione dell'indice di ricerca personalizzato contiene compatVersion, deve essere impostata su 2 oakpal-compatVersion

Il nodo indice che specifica includedPaths deve specificare anche queryPaths con gli stessi valori oakpal-included-paths-without-query-paths

Per gli indici personalizzati, configurare includedPaths e queryPaths con valori identici. Se ne viene specificata una, l'altra deve corrispondere. Tuttavia, esiste un caso speciale per gli indici di damAssetLucene, incluse le versioni personalizzate. Per questi casi, fornisci solo includedPaths.

Il nodo indice che specifica nodeScopeIndex nel tipo di nodo generico deve specificare anche includedPaths e queryPaths oakpal-full-text-on-generic-node-type

Quando si imposta la proprietà nodeScopeIndex su un tipo di nodo "generico" come nt:unstructured o nt:base, è necessario specificare anche le proprietà includedPaths e queryPaths.
Il tipo di nodo nt:base può essere considerato "generico" perché tutti i tipi di nodo ereditano da esso. L'impostazione di un nodeScopeIndex su nt:base determina quindi l'indicizzazione di tutti i nodi dell'archivio. Analogamente, nt:unstructured è anche considerato "generico" in quanto ci sono molti nodi negli archivi che sono di questo tipo.

Codice non conforme non-compliant-code-full-text-on-generic-node-type

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

Codice conforme compliant-code-full-text-on-generic-node-type

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
  - includedPaths: ["/content/dam/"]
  - queryPaths: ["/content/dam/"]
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

La proprietà queryLimitReads del motore di query non deve essere sostituita oakpal-query-limit-reads

L’override del valore predefinito può rallentare le letture delle pagine, in particolare quando viene aggiunto più contenuto.

Più versioni attive dello stesso indice oakpal-multiple-active-versions

Codice non conforme non-compliant-code-multiple-active-versions

+ oak:index
  + damAssetLucene-1-custom-1
    ...
  + damAssetLucene-1-custom-2
    ...
  + damAssetLucene-1-custom-3
    ...

Codice conforme compliant-code-multiple-active-versions

+ damAssetLucene-1-custom-3
    ...

Il nome delle definizioni di indice completamente personalizzate deve essere conforme alle linee guida ufficiali oakpal-fully-custom-index-name

Il modello previsto per i nomi di indice completamente personalizzati è: [prefix].[indexName]-custom-[version]. Ulteriori informazioni sono disponibili nel documento Ricerca e indicizzazione dei contenuti.

Stessa proprietà con valori analizzati diversi nella stessa definizione di indice oakpal-same-property-different-analyzed-values

Codice non conforme non-compliant-code-same-property-different-analyzed-values

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status

Codice conforme compliant-code-same-property-different-analyzed-values

Esempio:

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

Esempio:

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

Se la proprietà analizzata non è impostata in modo esplicito, il relativo valore predefinito è false.

Proprietà Tags tags-property

Per indici specifici, assicurati di mantenere la proprietà tags e i relativi valori correnti. Anche se è possibile aggiungere nuovi valori alla proprietà tags, l’eliminazione di eventuali valori esistenti (o del tutto la proprietà ) può causare risultati imprevisti.

I nodi di definizione dell’indice non devono essere distribuiti nel pacchetto di contenuti dell’interfaccia utente oakpal-ui-content-package

AEM Cloud Service non consente di distribuire nel pacchetto di contenuti dell’interfaccia utente le definizioni di indici di ricerca personalizzati (nodi di tipo oak:QueryIndexDefinition).

La definizione dell’indice full-text personalizzato di tipo damAssetLucene deve avere il prefisso corretto "damAssetLucene" oakpal-dam-asset-lucene

AEM Cloud Service non consente che la definizione di indici testuali personalizzati di tipo damAssetLucene sia preceduta da un prefisso diverso da damAssetLucene.

I nodi di definizione dell’indice non devono contenere proprietà con lo stesso nome oakpal-index-property-name

AEM Cloud Service non consente che le definizioni dell’indice di ricerca personalizzato (ovvero, i nodi di tipo oak:QueryIndexDefinition) contengano una proprietà denominata con lo stesso nome.

Non è consentito personalizzare alcune definizioni di indici predefiniti oakpal-customizing-ootb-index

AEM Cloud Service non consente modifiche non autorizzate ai seguenti indici integrati:

La configurazione dei tokenizer negli analizzatori deve essere creata con il nome "tokenizer" oakpal-tokenizer

AEM Cloud Service vieta la creazione di tokenizer con nomi non corretti negli analizzatori. I tokenizzatori devono sempre essere definiti come tokenizer.

La configurazione delle definizioni di indicizzazione non deve contenere spazi oakpal-indexing-definitions-spaces

AEM Cloud Service non consente la creazione di definizioni di indicizzazione che contengono proprietà con spazi.