Questa pagina è stata tradotta dall'API Cloud Translation.

Anti-pattern: usare il criterio RaiseFault in condizioni inappropriate

Stai visualizzando la documentazione di Apigee e Apigee hybrid.
Visualizza la documentazione di Apigee Edge.

Il criterio RaiseFault consente agli sviluppatori di API di avviare un flusso di errore e impostare le variabili di errore nel corpo del messaggio della risposta e imposta i codici di stato della risposta appropriati. Puoi anche utilizzare il criterio RaiseFault per impostare le variabili di flusso relative all'errore, ad esempio fault.name, fault.type e fault.category. Poiché queste variabili sono visibili nei dati di analisi e nei log di accesso del router utilizzati per il debug, è importante identificare con precisione l'errore.

Puoi utilizzare il criterio RaiseFault per trattare condizioni specifiche come errori, anche se non si è verificato un errore reale in un altro criterio o nel server di backend del proxy API. Ad esempio, se vuoi che il proxy invii un messaggio di errore personalizzato all'app client ogni volta che il corpo della risposta del backend contiene la stringa unavailable, puoi invocare il criterio RaiseFault come mostrato nello snippet di codice di seguito:

<!-- /antipatterns/examples/raise-fault-conditions-1.xml  -->
<TargetEndpoint name="default">
...
  <Response>
    <Step>
      <Name>RF-Service-Unavailable</Name>
      <Condition>(message.content Like "*unavailable*")</Condition>
   </Step>
  </Response>
...

Il nome del criterio RaiseFault è visibile come fault.name in API Monitoring e come x_apigee_fault_policy nei log di accesso ad Analytics e al router. In questo modo è più facile diagnosticare la causa dell'errore.

Antipattern

Utilizzo del criterio RaiseFault in FaultRules dopo che un altro criterio ha già generato un errore

Prendi in considerazione l'esempio seguente, in cui un criterio OAuthV2 nel flusso del proxy API non è riuscito con un errore InvalidAccessToken. In caso di errore, Apigee imposta fault.name su InvalidAccessToken, entra nel flusso di errore ed esegue eventuali regole di errore definite. In FaultRule è presente un criterio RaiseFault denominato RaiseFault che invia una risposta di errore personalizzata ogni volta che si verifica un errore InvalidAccessToken. Tuttavia, l'utilizzo del criterio RaiseFault in una regola di errore comporta la sovrascrittura della variabile fault.name e maschera la causa reale dell'errore.

<!-- /antipatterns/examples/raise-fault-conditions-2.xml  -->
<FaultRules>
  <FaultRule name="generic_raisefault">
    <Step>
        <Name>RaiseFault</Name>
        <Condition>(fault.name equals "invalid_access_token") or (fault.name equals "InvalidAccessToken")</Condition>
    </Step>
  </FaultRule>
</FaultRules>

Utilizzo del criterio RaiseFault in una regola Fault in tutte le condizioni

Nell'esempio seguente, un criterio RaiseFault denominato RaiseFault viene eseguito se fault.name non è RaiseFault:

<!-- /antipatterns/examples/raise-fault-conditions-3.xml  -->
<FaultRules>
    <FaultRule name="fault_rule">
        ....
        <Step>
            <Name>RaiseFault</Name>
            <Condition>!(fault.name equals "RaiseFault")</Condition>
        </Step>
    </FaultRule>
</FaultRules>

Come nel primo scenario, le variabili di errore principali fault.name, fault.code e fault.policy vengono sovrascritte con il nome del criterio RaiseFault. Questo comportamento rende è quasi impossibile determinare quale criterio ha effettivamente causato l'errore senza accedere a una traccia che mostra l'errore o la riproduzione del problema.

Utilizzo del criterio RaiseFault per restituire una risposta HTTP 2xx al di fuori del flusso di errore.

Nell'esempio seguente, un criterio RaiseFault denominato HandleOptionsRequest viene eseguito quando il verbo della richiesta è OPTIONS:

<!-- /antipatterns/examples/raise-fault-conditions-4.xml  -->
<PreFlow name="PreFlow">
    <Request>
        …
        <Step>
            <Name>HandleOptionsRequest</Name>
            <Condition>(request.verb Equals "OPTIONS")</Condition>
        </Step>
        …
</PreFlow>

Lo scopo è restituire immediatamente la risposta al client API senza elaborare altri criteri. Tuttavia, questo comporterà dati di analisi fuorvianti perché le variabili di errore conterranno il nome del criterio RaiseFault, rendendo più difficile il debug del proxy. Il modo corretto per implementare il comportamento desiderato è utilizzare flussi con condizioni speciali, come descritto in Aggiunta del supporto CORS.

Impatto

L'utilizzo del criterio RaiseFault come descritto sopra determina la sovrascrittura delle variabili di errore chiave con il parametro Il nome del criterio RaiseFault anziché il nome del criterio con errori. Nei log di accesso di Analytics e NGINX, le variabili x_apigee_fault_code e x_apigee_fault_policy vengono sovrascritti. In Monitoring API, Fault Code e Fault Policy vengono sovrascritti. Questo comportamento rende difficile la risoluzione dei problemi e la determinazione del criterio che rappresenta la causa effettiva dell'errore.

Nello screenshot di seguito di Monitoraggio API, puoi vedere che il codice di errore e il criterio di errore sono stati sovrascritti con valori RaiseFault generici, rendendo impossibile determinare la causa principale dell'errore dai log:

Best practice

Quando un criterio Apigee genera un errore e vuoi personalizzare il messaggio di risposta di errore, usare il criterio AssegnaMessage o JavaScript anziché il criterio RaiseFault.

Il criterio RaiseFault deve essere utilizzato in un flusso non di errore. Vale a dire, usa RaiseFault solo per trattare un caso specifico come errore, anche se non si è verificato un errore effettivo in un criterio o nel server di backend. del proxy API. Ad esempio, potresti utilizzare il criterio RaiseFault per segnalare che l'input obbligatorio parametri mancanti o con sintassi errata.

Puoi anche utilizzare RaiseFault in una regola di errore se vuoi rilevare un errore durante l'elaborazione di un errore. Ad esempio, il gestore degli errori stesso potrebbe causare un errore che vuoi segnalare utilizzando RaiseFault.