Regole per la qualità del codice personalizzato

Questa pagina descrive le regole di qualità del codice personalizzate eseguite da Cloud Manager create in base alle best practice di AEM Engineering.

NOTA

Gli esempi di codice forniti qui sono solo a scopo illustrativo. Per informazioni sui concetti e sulle regole di qualità di SonarQube, vedere Concetti.

Regole SonarQube

Nella sezione seguente vengono evidenziate le regole SonarQube:

Non utilizzare funzioni potenzialmente pericolose

Chiave: CQRules:CWE-676

Tipo: Vulnerabilità

Gravità: Maggiore

Dal momento: Versione 2018.4.0

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

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

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

Chiave: CQRules:CWE-134

Tipo: Vulnerabilità

Gravità: Maggiore

Dal momento: Versione 2018.4.0

L'utilizzo di una stringa di formato da un'origine esterna (ad esempio, un parametro di richiesta o contenuto generato dall'utente) può determinare l'esposizione di un'applicazione agli attacchi di negazione del servizio. In alcune circostanze una stringa di formato può essere controllata esternamente, ma è consentita solo da fonti attendibili.

Codice non conforme

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 socket e timeout di connessione

Chiave: CQRules:ConnectionTimeoutMechanism

Tipo: Bug

Gravità: Critico

Dal momento: Versione 2018.6.0

Durante l'esecuzione di richieste HTTP dall'interno di un'applicazione AEM, è fondamentale assicurarsi che i timeout corretti siano configurati in modo da evitare il consumo di thread non necessario. Purtroppo, il comportamento predefinito sia del client HTTP predefinito Java (java.net.HttpUrlConnection) che del client Apache HTTP Components comunemente utilizzato non ha mai un timeout, pertanto i timeout devono essere impostati in modo esplicito. Inoltre, come procedura ottimale, questi timeout non devono superare i 60 secondi.

Codice non conforme

@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

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

Le API prodotto annotate con @ProviderType non devono essere implementate o estese dai clienti

Chiave: Dipendenze CQBP-84, CQBP-84

Tipo: Bug

Gravità: Critico

Dal momento: Versione 2018.7.0

L’API AEM contiene interfacce e classi Java che devono essere utilizzate solo con il codice personalizzato, ma che non devono essere implementate. Ad esempio, l’interfaccia com.day.cq.wcm.api.Page è progettata per essere implementata solo da AEM.

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

Le interfacce (e le classi) che devono essere implementate solo da AEM vengono annotate con org.osgi.annotation.versioning.ProviderType (o, in alcuni casi, con un'annotazione precedente simile Quute.bnd.annotation.ProviderType). Questa regola identifica i casi in cui tale interfaccia viene implementata (o una classe viene estesa) dal codice personalizzato.

Codice non conforme

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

public class DontDoThis implements Page {
// implementation here
}

Gli oggetti ResourceResolver devono essere sempre chiusi

Chiave: CQRules:CQBP-72

Tipo: Odore di codice

Gravità: Maggiore

Dal momento: Versione 2018.4.0

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

Un'errata concezione relativamente comune è che gli oggetti ResourceResolver creati utilizzando una sessione JCR esistente non dovrebbero essere chiusi in modo esplicito, altrimenti la sessione JCR sottostante verrà chiusa. Questo non è il caso - indipendentemente dalla modalità di apertura di ResourceResolver, deve essere chiuso quando non viene più utilizzato. Poiché ResourceResolver implementa l'interfaccia Closeable, è anche possibile utilizzare la sintassi try-with-resources invece di richiamare esplicitamente close().

Codice non conforme

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

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 percorsi servlet Sling per registrare i servlet

Chiave: CQRules:CQBP-75

Tipo: Odore di codice

Gravità: Maggiore

Dal momento: Versione 2018.4.0

Come descritto nella Documentazione Sling, i servlet di binding per percorsi non sono consigliati. I servlet vincolati al percorso non possono utilizzare controlli di accesso JCR standard e, di conseguenza, richiedono un ulteriore rigore di sicurezza. Anziché utilizzare i servlet associati al percorso, si consiglia di creare nodi nel repository e registrare i servlet in base al tipo di risorsa.

Codice non conforme

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

Le eccezioni rilevate devono essere registrate o generate, ma non entrambe

Chiave: CQRules:CQBP-44—CatchAndLogOrThrow

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2018.4.0

In generale, un'eccezione deve essere registrata esattamente una volta. Le eccezioni di registrazione più volte possono creare confusione in quanto non è chiaro quante volte si è verificata un'eccezione. Il modello più comune che porta a questo è il taglio e la generazione di un'eccezione colta.

Codice non conforme

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

Codice conforme

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 di avere un'istruzione di registro immediatamente seguita da un'istruzione di rilascio

Chiave: CQRules:CQBP-44—ConsecutivamenteLogAndThrow

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2018.4.0

Un altro pattern comune da evitare è quello di registrare un messaggio e di generare immediatamente un'eccezione. Questo indica in genere che il messaggio di eccezione viene duplicato nei file di registro.

Codice non conforme

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

Codice conforme

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

Evitate la registrazione a INFO quando gestite richieste di GET o HEAD

Chiave: CQRules:CQBP-44—LogInfoInGetOrHeadRequests

Tipo: Odore di codice

Gravità: Minore

In generale, il livello di registro INFO dovrebbe essere utilizzato per delimitare azioni importanti e, per impostazione predefinita, AEM configurato per il login al livello INFO o superiore. I metodi GET e HEAD devono essere sempre di sola lettura e non costituiscono pertanto azioni importanti. La registrazione a livello di INFO in risposta a richieste di GET o HEAD può generare un disturbo significativo del registro, rendendo più difficile l’identificazione di informazioni utili nei file di registro. La registrazione durante la gestione delle richieste di GET o HEAD deve essere a livello di AVVISO o ERRORE quando si è verificato un errore o a livello di DEBUG o di TRACE, se utili informazioni più approfondite sulla risoluzione dei problemi.

ATTENZIONE

Ciò non si applica alla registrazione di access.log per ogni richiesta.

Codice non conforme

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

Codice conforme

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

Non utilizzate Exception.getMessage() come primo parametro di un'istruzione di registrazione

Chiave: CQRules:CQBP-44—ExceptionGetMessageIsFirstLogParam

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2018.4.0

Come procedura ottimale, i messaggi di registro dovrebbero fornire informazioni contestuali sulla posizione in cui si è verificata un'eccezione nell'applicazione. Anche se il contesto può essere determinato anche tramite l'uso di tracce dello stack, in generale il messaggio di registro sarà più semplice da leggere e comprendere. Di conseguenza, durante la registrazione di un'eccezione, è una procedura non corretta utilizzare il messaggio dell'eccezione come messaggio di registro. Il messaggio di eccezione conterrà ciò che è andato storto, mentre il messaggio di registro dovrebbe essere utilizzato per comunicare al lettore di log cosa stava facendo l'applicazione quando si è verificata l'eccezione. Il messaggio di eccezione verrà comunque registrato; specificando il proprio messaggio, i registri saranno più facili da comprendere.

Codice non conforme

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

Codice conforme

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

L'accesso ai blocchi catch deve essere al livello AVVISO o ERRORE

Chiave: CQRules:CQBP-44—WrongLogLevelInCatchBlock

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2018.4.0

Come suggerisce il nome, le eccezioni Java devono sempre essere utilizzate in circostanze eccezionali. Di conseguenza, quando viene rilevata un'eccezione, è importante assicurarsi che i messaggi di registro siano registrati al livello appropriato, ovvero AVVERTENZA o ERRORE. In questo modo i messaggi verranno visualizzati correttamente nei registri.

Codice non conforme

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

Codice conforme

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

Non stampare le tracce dello stack nella console

Chiave: CQRules:CQBP-44—ExceptionPrintStackTrace

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2018.4.0

Come già detto, il contesto è fondamentale per comprendere i messaggi di registro. Se si utilizza Exception.printStackTrace(), la traccia dello stack viene generata solo nel flusso di errore standard, perdendo così tutto il contesto. Inoltre, in un'applicazione multi-thread come AEM se vengono stampate più eccezioni utilizzando questo metodo in parallelo, le loro tracce di stack possono sovrapporsi e generare una notevole confusione. Le eccezioni devono essere registrate solo tramite il framework di registrazione.

Codice non conforme

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

Codice conforme

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

Non trasmettere l'output a Standard Output o Standard Error

Chiave: CQRules:CQBP-44—LogLevelConsolePrinters

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2018.4.0

L’accesso AEM deve essere sempre effettuato tramite il framework di registrazione (SLF4J). L'output diretto ai flussi di output standard o di errore standard perde le informazioni strutturali e contestuali fornite dal framework di registrazione e può, in alcuni casi, causare problemi di prestazioni.

Codice non conforme

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

Codice conforme

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

Evitare percorsi /apps e /libs hardcoded

Chiave: CQRules:CQBP-71

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2018.4.0

In generale, i percorsi che iniziano con /libs e /apps non devono essere hardcoded in quanto i percorsi a cui fanno riferimento sono generalmente memorizzati come percorsi relativi al percorso di ricerca Sling (che per impostazione predefinita è impostato su /libs,/apps). L’utilizzo del percorso assoluto potrebbe introdurre lievi difetti che verrebbero visualizzati solo successivamente nel ciclo di vita del progetto.

Codice non conforme

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

Codice conforme

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

Il Programma Sling Non Deve Essere Utilizzato

Chiave: CQRules:AMSCORE-554

Tipo: Compatibilità Cloud Service/odore del codice

Gravità: Minore

Dal momento: Versione 2020.5.0

Sling Scheduler non deve essere utilizzato per le attività che richiedono un'esecuzione garantita. I processi pianificati Sling garantiscono l’esecuzione e sono più adatti sia per gli ambienti cluster che per quelli non cluster.

Fare riferimento a Apache Sling Eventing and Job Handling per ulteriori informazioni su come i processi Sling vengono gestiti in ambienti cluster.

AEM le API obsolete non devono essere utilizzate

Chiave: AMSCORE-553

Tipo: Compatibilità Cloud Service/odore del codice

Gravità: Minore

Dal momento: Versione 2020.5.0

La superficie dell'API AEM è soggetta a revisione costante per identificare le API per le quali l'utilizzo è scoraggiato e quindi considerato obsoleto.

In molti casi, queste API sono obsolete utilizzando l'annotazione Java @Deprecated standard e, come tali, identificata da squid:CallToDeprecatedMethod.

Tuttavia, in alcuni casi un'API è obsoleta nel contesto di AEM ma non può essere rimossa in altri contesti. Questa regola identifica questa seconda classe.

Regole contenuto OakPAL

Di seguito sono riportati i controlli OakPAL eseguiti da Cloud Manager.

NOTA

OakPAL è un framework sviluppato da un partner AEM (e vincitore del 2019 AEM Rockstar Nord America) che convalida i pacchetti di contenuto utilizzando un repository Oak standalone.

I pacchetti cliente non devono creare o modificare nodi in /libs

Chiave: BanningPaths

Tipo: Bug

Gravità: Blocco

Dal momento: Versione 2019.6.0

È stata una procedura consigliata di vecchia data che la struttura di contenuto /libs nell'archivio dei contenuti AEM venga considerata di sola lettura dai clienti. La modifica di nodi e proprietà in /libs comporta rischi significativi per gli aggiornamenti principali e secondari. Le modifiche a /libs devono essere apportate solo da Adobe attraverso canali ufficiali.

I pacchetti non devono contenere configurazioni OSGi duplicate

Chiave: DuplicateOsgiConfigurations

Tipo: Bug

Gravità: Maggiore

Dal momento: Versione 2019.6.0

Un problema comune che si verifica in progetti complessi è rappresentato dalla configurazione ripetuta dello stesso componente OSGi. Ciò crea un'ambiguità sulla configurazione che sarà operativa. Questa regola è "in modalità di esecuzione" in quanto identifica solo i problemi per i quali lo stesso componente è configurato più volte nella stessa modalità di esecuzione (o combinazione di modalità di esecuzione).

Codice non conforme

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

Codice conforme

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

Le cartelle di configurazione e installazione devono contenere solo nodi OSGi

Chiave: ConfigAndInstallShouldOnlyContainOsgiNodes

Tipo: Bug

Gravità: Maggiore

Dal momento: Versione 2019.6.0

Per motivi di sicurezza, i percorsi contenenti /config/ e /install/ sono leggibili solo dagli utenti amministrativi in AEM e devono essere utilizzati solo per la configurazione OSGi e i bundle OSGi. Posizionando altri tipi di contenuto in percorsi che contengono questi segmenti, il comportamento dell'applicazione varia involontariamente tra utenti amministrativi e non amministrativi.

Un problema comune è rappresentato dall'uso 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 ha commesso l'errore deve essere rinominato in un nome conforme. Per la configurazione dell'editor di testo RTF, utilizzare la proprietà configPath sul nodo cq:inplaceEditing per specificare la nuova posizione.

Codice non conforme

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

Codice conforme

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

I Pacchetti Non Devono Sovrapporre

Chiave: PackageOverlaps

Tipo: Bug

Gravità: Maggiore

Dal momento: Versione 2019.6.0

Analogamente ai pacchetti Non devono contenere configurazioni OSGi duplicate, si tratta di un problema comune nei progetti complessi in cui lo stesso percorso nodo è scritto da più pacchetti di contenuto separati. Anche se è possibile utilizzare le dipendenze del pacchetto di contenuti per garantire un risultato coerente, è meglio evitare sovrapposizioni del tutto.

La modalità di authoring predefinita non deve essere un'interfaccia classica

Chiave: ClassicUIAuthoringMode

Tipo: Compatibilità Cloud Service/odore del codice

Gravità: Minore

Dal momento: Versione 2020.5.0

La configurazione OSGi com.day.cq.wcm.core.impl.AuthoringUIModeServiceImpl definisce la modalità di authoring predefinita in AEM. Poiché l’interfaccia classica è obsoleta a partire dalla AEM 6.4, ora viene generato un problema quando la modalità di authoring predefinita è configurata per l’interfaccia classica.

I componenti con finestre di dialogo devono avere finestre di dialogo dell'interfaccia touch

Chiave: ComponentWithOnlyClassicUIDialog

Tipo: Compatibilità Cloud Service/odore del codice

Gravità: Minore

Dal momento: Versione 2020.5.0

AEM I componenti che dispongono di una finestra di dialogo dell’interfaccia classica devono sempre disporre di una finestra di dialogo dell’interfaccia utente touch corrispondente sia per fornire un’esperienza di authoring ottimale, sia per essere compatibili con il modello di distribuzione del Cloud Service, in cui l’interfaccia classica non è supportata. Questa regola verifica i seguenti scenari:

  • Un componente con una finestra di dialogo dell’interfaccia classica (ovvero un nodo secondario finestra di dialogo) deve avere una finestra di dialogo dell’interfaccia touch corrispondente (ovvero un nodo secondario cq:dialog).
  • Un componente con una finestra di dialogo per la progettazione dell’interfaccia classica (ad es. un nodo design_dialog) deve avere una finestra di dialogo corrispondente per la progettazione dell’interfaccia utente touch (ovvero un nodo secondario cq:design_dialog).
  • Un componente con una finestra di dialogo per l’interfaccia classica e una finestra di dialogo per la progettazione dell’interfaccia classica deve avere una finestra di dialogo per l’interfaccia utente touch corrispondente e una finestra di dialogo per la progettazione dell’interfaccia touch corrispondente.

La documentazione AEM Strumenti di modernizzazione fornisce documentazione e strumenti per la conversione dei componenti dall’interfaccia classica all’interfaccia utente touch. Per ulteriori informazioni, fare riferimento a Strumenti di modernizzazione AEM.

I pacchetti non devono mescolare contenuto variabile e immutabile

Chiave: ImmutableMeableMixedPackage

Tipo: Compatibilità Cloud Service/odore del codice

Gravità: Minore

Dal momento: Versione 2020.5.0

Per essere compatibile con il modello di distribuzione del Cloud Service, i singoli pacchetti di contenuto devono contenere contenuto per le aree immutabili dell'archivio (ovvero, /apps and /libs, although /libs non deve essere modificato dal codice cliente e causerà una violazione separata) o l'area modificabile (ovvero tutto il resto), ma non entrambi. Ad esempio, un pacchetto che include sia /apps/myco/components/text and /etc/clientlibs/myco non è compatibile con il Cloud Service e causerà la segnalazione di un problema.

Per ulteriori informazioni, fare riferimento a AEM struttura del progetto.

Gli agenti di replica inversi non devono essere utilizzati

Chiave: ReverseReplication

Tipo: Compatibilità Cloud Service/odore del codice

Gravità: Minore

Dal momento: Versione 2020.5.0

Il supporto per la replica inversa non è disponibile nelle distribuzioni di Cloud Service, come descritto in Note sulla versione: Rimozione di agenti di replica.

I clienti che utilizzano la replica inversa devono contattare Adobe per soluzioni alternative.

OakPAL - Le risorse contenute nelle librerie client abilitate per il proxy devono trovarsi in una cartella denominata risorse

Chiave: ClientlibProxyResource

Tipo: Bug

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM librerie client possono contenere risorse statiche come immagini e font. Come descritto in Utilizzo dei preprocessori, quando si utilizzano librerie client proxy, queste risorse statiche devono essere contenute in una cartella secondaria denominata resources per poter fare riferimento efficacemente alle istanze di pubblicazione.

Codice non conforme

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

Codice conforme

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

OakPAL - Utilizzo di processi di flusso di lavoro non compatibili con il Cloud Service

Chiave: CloudServiceIncompatibleWorkflowProcess

Tipo: Bug

Gravità: Maggiore

Dal momento: Versione 2021.2.0

Con il passaggio ai micro-servizi Asset per l'elaborazione delle risorse AEM Cloud Service, diversi processi di workflow utilizzati nelle versioni locale e AMS di AEM sono diventati non supportati o non necessari. Lo strumento di migrazione all'indirizzo aem-cloud-Migration può essere utilizzato per aggiornare i modelli di workflow durante AEM migrazione dei Cloud Service.

OakPAL - L'utilizzo di modelli statici è sconsigliato a favore di modelli modificabili

Chiave: StaticTemplateUsage

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

Anche se l'utilizzo di modelli statici è stato storicamente molto comune nei progetti AEM, i modelli modificabili sono altamente consigliati in quanto offrono la massima flessibilità e supportano funzionalità aggiuntive non presenti nei modelli statici. Ulteriori informazioni sono disponibili in Modelli di pagina - Modificabili. La migrazione dai modelli statici a quelli modificabili può essere automatizzata in gran parte mediante gli AEM Strumenti di modernizzazione.

OakPAL - Utilizzo dei componenti di base legacy scoraggiato

Chiave: LegacyFoundationComponentUsage

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

I componenti di base legacy (ovvero i componenti in /libs/foundation) sono stati ritirati per diverse versioni AEM a favore dei componenti core di WCM. L’utilizzo dei componenti di base legacy come base per i componenti personalizzati, sia per sovrapposizione che per ereditarietà, viene scoraggiato e deve essere convertito nel componente di base corrispondente. Questa conversione può essere facilitata da AEM Strumenti di modernizzazione.

OakPAL - Vengono utilizzati solo i nomi e l'ordine delle modalità di esecuzione supportati

Chiave: SupportedRunmode

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM Cloud Service applica un criterio di denominazione rigoroso per i nomi in modalità di esecuzione e un ordine rigoroso per tali modalità di esecuzione. L'elenco delle modalità di esecuzione supportate è disponibile in Modalità di esecuzione e qualsiasi scostamento da tale modalità sarà identificato come un problema.

Chiave: OakIndexLocation

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM Cloud Service richiede che le definizioni dell'indice di ricerca personalizzata (ovvero i nodi di tipo oak:QueryIndexDefinition) siano nodi secondari diretti di /oak:index. Gli indici in altre posizioni devono essere spostati per essere compatibili con AEM Cloud Service. Ulteriori informazioni sugli indici di ricerca sono disponibili in Content Search and Indexing.

OakPAL - I nodi di definizione dell'indice di ricerca personalizzati devono avere una versione compat di 2

Chiave: IndexCompatVersion

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM Cloud Service richiede che le definizioni dell'indice di ricerca personalizzata (ovvero i nodi di tipo oak:QueryIndexDefinition) abbiano la proprietà compatVersion impostata su 2. Qualsiasi altro valore non è supportato da AEM Cloud Service. Ulteriori informazioni sugli indici di ricerca sono disponibili in Content Search and Indexing.

OakPAL - I nodi discendenti dei nodi di definizione dell'indice di ricerca personalizzata devono essere di tipo nt:unstructure

Chiave: IndexDescendingNodeType

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

Difficile risolvere i problemi possono verificarsi quando un nodo di definizione dell'indice di ricerca personalizzato contiene nodi figlio non ordinati. Per evitare questo problema, si consiglia che tutti i nodi discendenti di un nodo oak:QueryIndexDefinition siano di tipo nt:unstructure.

OakPAL - I nodi di definizione dell'indice di ricerca personalizzata devono contenere un nodo secondario denominato indexRules con elementi secondari

Chiave: IndexRulesNode

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

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

OakPAL - I nodi di definizione dell'indice di ricerca personalizzati devono seguire le convenzioni di denominazione

Chiave: NomeIndice

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM Cloud Service richiede che le definizioni dell'indice di ricerca personalizzata (ovvero, i nodi di tipo oak:QueryIndexDefinition) siano denominati in base a un pattern specifico descritto in Ricerca e indicizzazione contenuto.

OakPAL - I nodi di definizione dell'indice di ricerca personalizzati devono utilizzare il tipo di indice lucene

Chiave: IndexType

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM Cloud Service richiede che le definizioni dell'indice di ricerca personalizzata (ovvero i nodi di tipo oak:QueryIndexDefinition) abbiano una proprietà type con il valore impostato su lucene. L'indicizzazione utilizzando tipi di indice legacy deve essere aggiornata prima della migrazione al Cloud Service AEM. Per ulteriori informazioni, vedere Ricerca e indicizzazione dei contenuti.

OakPAL - I nodi di definizione dell'indice di ricerca personalizzato non devono contenere una proprietà denominata seed

Chiave: IndexSeedProperty

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM Cloud Service non consente alle definizioni dell'indice di ricerca personalizzata (ovvero, ai nodi di tipo oak:QueryIndexDefinition) di contenere una proprietà denominata seed. L'indicizzazione utilizzando questa proprietà deve essere aggiornata prima della migrazione al Cloud Service AEM. Per ulteriori informazioni, vedere Ricerca e indicizzazione dei contenuti.

OakPAL - I nodi di definizione dell'indice di ricerca personalizzato non devono contenere una proprietà denominata reindex

Chiave: IndexReindexProperty

Tipo: Odore di codice

Gravità: Minore

Dal momento: Versione 2021.2.0

AEM Cloud Service non consente alle definizioni dell'indice di ricerca personalizzata (ovvero, ai nodi di tipo oak:QueryIndexDefinition) di contenere una proprietà denominata reindex. L'indicizzazione utilizzando questa proprietà deve essere aggiornata prima della migrazione al Cloud Service AEM. Per ulteriori informazioni, vedere Ricerca e indicizzazione dei contenuti.

In questa pagina

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free