criterio JavaScript

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

Cosa

Questo criterio ti consente di aggiungere codice JavaScript personalizzato che viene eseguito nel contesto di un flusso proxy API. Nel codice JavaScript personalizzato, puoi utilizzare gli oggetti, i metodi e le proprietà del modello oggetto JavaScript di Apigee. Il modello di oggetti consente di recuperare, impostare e rimuovere le variabili nel contesto del flusso del proxy. Puoi anche utilizzare le funzioni di crittografia di base fornite con il modello di oggetti.

Questo criterio è un criterio estensibile e il suo utilizzo potrebbe comportare implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di norme e le implicazioni sull'utilizzo, consulta Tipi di criteri.

Informazioni

Esistono molti casi d'uso per il criterio JavaScript. Ad esempio, puoi ottenere e impostare il flusso variabili, eseguire logica personalizzata e gestire gli errori, estrarre i dati dalle richieste le risposte, modificare dinamicamente l'URL di destinazione del backend e altro ancora. Questo criterio ti consente di implementare un comportamento personalizzato non coperto da altri criteri Apigee standard. Infatti, puoi utilizzare un criterio JavaScript per ottenere molti degli stessi comportamenti implementati da altri criteri, come AssignMessage ed ExtractVariable.

Un caso d'uso che sconsigliamo per il criterio JavaScript è il logging. La Il criterio MessageLogging è molto più adatto per il logging su piattaforme di logging di terze parti come Splunk, Sumo e Loggly, puoi migliorare le prestazioni del proxy API eseguendo il criterio MessageLogging in PostClientFlow, che viene eseguita dopo che la risposta è stata inviata al client.

Il criterio JavaScript ti consente di specificare un file sorgente JavaScript da eseguire o di includere il codice JavaScript direttamente nella configurazione del criterio con l'elemento <Source>. In ogni caso, il codice JavaScript viene eseguito quando viene eseguito il passaggio a cui è associato il criterio. Per l'opzione file sorgente, il codice sorgente viene sempre archiviato in una posizione standard all'interno del bundle proxy: apiproxy/resources/jsc. In alternativa, puoi anche memorizzare il codice sorgente in un file di risorse a livello di ambiente o organizzazione. Per istruzioni, vedi File di risorse. Puoi e caricare il codice JavaScript tramite l'editor proxy della UI di Apigee.

I file di origine JavaScript devono sempre avere un'estensione .js.

Apigee supporta JavaScript che viene eseguito sul motore Rhino JavaScript 1.7.13.

Video

Nota: il video seguente mostra l'editor di proxy classico nell'interfaccia utente di Apigee. Apigee sta introducendo una nuova versione di Proxy Editor, che ha un design diverso dalla versione classica mostrata nel video.

Guarda un breve video per scoprire come creare un'estensione di criteri personalizzati utilizzando i criteri JavaScript.

Esempi

Riscrivi l'URL di destinazione

Ecco un caso d'uso comune: estrazione di dati dal corpo di una richiesta, memorizzazione in una variabile di flusso e utilizzo di questa variabile di flusso altrove nel flusso del proxy. Supponiamo che tu abbia un'app dove l'utente inserisce il proprio nome in un modulo HTML e lo invia. Vuoi che il proxy API estragga i dati del modulo e li aggiunga dinamicamente all'URL utilizzato per chiamare il servizio di backend. Come lo faresti in una norma JavsScript?

Nota: per provare questo esempio, supponiamo che tu abbia creato una nuova proxy nell'editor proxy. Quando lo crei, specifica un URL del servizio di backend: http://www.example.com. Per questo esempio, riscrivi l'URL del backend in modo dinamico. Se non sai come creare un nuovo proxy, consulta il tutorial introduttivo.

1. Nella UI di Apigee, apri il proxy che hai creato nell'editor proxy.
2. Seleziona la scheda Sviluppo.
3. Nel menu Nuovo, seleziona Nuovo script.
4. Nella finestra di dialogo, seleziona JavaScript e assegna allo script un nome, ad esempio js-example.
5. Incolla il seguente codice nell'editor di codice e salva il proxy. L'elemento importante da notare è l'oggetto context. Questo oggetto è disponibile per il codice JavaScript in qualsiasi punto del flusso del proxy. È usata per ottenere costanti specifiche del flusso, per richiamare get/set e per altre operazioni. Questa parte dell'oggetto fa parte del modello oggetto JavaScript di Apigee. Tieni presente che che la variabile di flusso target.url è una variabile integrata di lettura/scrittura che è accessibile nel flusso Richiesta di destinazione. Se impostiamo la variabile con l'URL dell'API, Apigee effettua la chiamata di backend a quell'URL. Fondamentalmente abbiamo riscritto l'URL di destinazione originale, ovvero il valore specificato al momento della creazione del proxy (ad es. http://www.example.com).
   
   

   if (context.flow=="PROXY_REQ_FLOW") {
        var username = context.getVariable("request.formparam.user");
        context.setVariable("info.username", username);
   }
   
   
   if (context.flow=="TARGET_REQ_FLOW") {
        context.setVariable("request.verb", "GET");
        var name = context.getVariable("info.username");
        var url = "http://mocktarget.apigee.net/"
        context.setVariable("target.url", url + "?user=" + name);
   }
6. Dal menu Nuova norma, seleziona JavaScript.
7. Assegna un nome al criterio, ad esempio target-rewrite. Accetta i valori predefiniti e salva il criterio.
8. Se selezioni il Preflow dell'endpoint proxy in Navigator, vedrai che il criterio è stato aggiunto a quel flusso.
9. In Navigator, seleziona l'icona PreFlow endpoint target.
10. Dal Navigatore, trascina il criterio JavaScript sul lato Richiesta della finestra Endpoint nell'editor del flusso.
11. Salva.
12. Chiama l'API in questo modo, sostituendo il nome corretto dell'organizzazione e il nome del proxy con appropriato:

curl -i -H 'Content-Type: application/x-www-form-urlencoded' -X POST -d 'user=Will' http://myorg-test.apigee.net/js-example

Infine, esaminiamo la definizione XML del criterio JavaScript utilizzato in in questo esempio. È importante notare che il <ResourceURL> viene utilizzato per specificare il file sorgente JavaScript da eseguire. Viene usato lo stesso pattern per qualsiasi file sorgente JavaScript: jsc://filename.js. Se il tuo codice JavaScript richiede, puoi utilizzare uno o più elementi <IncludeURL> come descritto più avanti in questo riferimento.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="target-rewrite">
    <DisplayName>target-rewrite</DisplayName>
    <Properties/>
    <ResourceURL>jsc://js-example.js</ResourceURL>
</Javascript>

Recuperare il valore della proprietà da JavaScript

Puoi aggiungere un elemento <Property> nella configurazione, quindi recuperare il valore con JavaScript in fase di esecuzione.

Utilizza l'attributo name dell'elemento per specificare il nome con cui accedere all'elemento proprietà del codice JavaScript. Il valore dell'elemento <Property> (il valore tra i tag di apertura e chiusura) è il valore letterale che riceverà JavaScript.

In JavaScript, puoi recuperare il valore della proprietà della norma accedendovi come proprietà dell'oggetto Properties, come nel seguente esempio:

• Configura la proprietà. Qui, il valore della proprietà è il nome della variabile response.status.code.

  <Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="JavascriptURLRewrite">
      <DisplayName>JavascriptURLRewrite</DisplayName>
      <Properties>
          <Property name="source">response.status.code</Property>
      </Properties>
      <ResourceURL>jsc://JavascriptURLRewrite.js</ResourceURL>
  </Javascript>

• Recupera la proprietà con JavaScript. In questo caso, il valore recuperato, ossia il nome di una variabile, viene quindi utilizzato dalla funzione getVariable per recuperare il valore della variabile.

  var responseCode = properties.source; // Returns "response.status.code"
  var value = context.getVariable(responseCode); // Get the value of response.status.code
  context.setVariable("response.header.x-target-response-code", value);

Gestione degli errori

Per esempi e una discussione sulle tecniche di gestione degli errori che puoi utilizzare in uncallout JavaScript, consulta Modo corretto per restituire un errore dal criterio JavaScript. I suggerimenti offerti nella community Apigee sono solo informativi e non rappresentano necessariamente le best practice consigliate da Google.

All'interno di un criterio JavaScript, l'accesso a request.content.asJSON in una capacità di sola lettura, i numeri interi di grandi dimensioni vengono convertiti in notazione esponenziale nel corpo del messaggio. Di conseguenza, il messaggio verrà sovrascritto con i valori convertiti.

---

Riferimento elemento

Il riferimento all'elemento descrive gli elementi e gli attributi del criterio JavaScript.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" 
        continueOnError="false" enabled="true" timeLimit="200" 
        name="JavaScript-1">
    <DisplayName>JavaScript 1</DisplayName>
    <Properties>
        <Property name="propName">propertyValue</Property>
    </Properties>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>
    <IncludeURL>jsc://a-javascript-library-file</IncludeURL>
    <ResourceURL>jsc://my-javascript-source-file</ResourceURL>
    <Source>insert_js_code_here</Source>
</Javascript>

<Javascript> Attributi

<Javascript name="Javascript-1" enabled="true" continueOnError="false" async="false" timeLimit="200">

I seguenti attributi sono specifici di questo criterio.

Attributo	Descrizione	Predefinito	Presenza
timeLimit	Specifica il tempo massimo (in millisecondi) che lo script può eseguire eseguire il deployment. Ad esempio, se viene superato un limite di 200 ms, il criterio genera il seguente errore: Javascript.policy_name failed with error: Javascript runtime exceeded limit of 200ms. Nota: per gli account di prova gratuiti, il tempo di esecuzione è limitato a 200 ms.	N/D	Obbligatorio

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Attributo	Descrizione	Predefinito	Presenza
name	Il nome interno del criterio. Il valore dell'attributo name può Deve contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.	N/D	Obbligatorio
continueOnError	Imposta il valore su false per restituire un errore quando un criterio non funziona. Si tratta di un comportamento previsto comportamento per la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche: Le regole di errore vengono attivate SOLO in uno stato di errore (informazioni su continueOnError) Gestione degli errori all'interno del flusso corrente	falso	Facoltativo
enabled	Imposta su true per applicare il criterio. Imposta false per disattivare il criterio. Il criterio non verrà applicata anche se rimane collegata a un flusso.	true	Facoltativo
async	Questo attributo è stato ritirato.	falso	Ritirato

<DisplayName> elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Predefinito	N/D Se ometti questo elemento, il valore dell'attributo name del criterio è in uso.
Presenza	Facoltativo
Tipo	Stringa

Elemento <IncludeURL>

Specifica un file della libreria JavaScript da caricare come dipendenza dal file JavaScript principale specificato con l'elemento <ResourceURL> o <Source>. Gli script verranno valutati nell'ordine in cui sono elencati nelle norme. Il codice può utilizzare gli oggetti, i metodi e le proprietà del modello oggetto JavaScript.

Includi più di una risorsa di dipendenza JavaScript con <IncludeURL> elementi.

Avviso: se i file JavaScript sono archiviati a livello di organizzazione o di ambiente, assicurati che siano stati caricati correttamente con cURL utilizzando l'opzione -F o come allegato tramite un client REST. Content-Type è multipart/form-data. Per saperne di più, consulta Gestire le risorse.

<IncludeURL>jsc://my-javascript-dependency.js</IncludeURL>

Predefinita:	Nessuno
Presenza:	Facoltativo
Tipo:	Stringa

Esempio

Consulta l'esempio di base nella sezione Samples.

Elemento <Property>

Specifica una proprietà a cui puoi accedere dal codice JavaScript in fase di esecuzione.

<Properties>
    <Property name="propName">propertyValue</Property>
</Properties>

Valore predefinito:	Nessuno
Presenza:	Facoltativo
Tipo:	Stringa

Attributi

Attributo	Descrizione	Predefinito	Presenza
nome	Specifica il nome della proprietà.	N/D	Obbligatorio.

Esempio

Consulta l'esempio nella sezione Samples (Esempi).

&lt;ResourceURL&gt; elemento

Specifica il file JavaScript principale che verrà eseguito nel flusso dell'API. Puoi archiviare questo file nell'ambito del proxy API (in /apiproxy/resources/jsc nel bundle proxy API o sezione Script del riquadro di navigazione dell'editor proxy API) o a livello di organizzazione Ambiti di ambiente per il riutilizzo in più proxy API, come descritto in Gestione delle risorse. Il codice può utilizzare gli oggetti, metodi e proprietà del modello oggetto JavaScript.

<ResourceURL>jsc://my-javascript.js</ResourceURL>

Valore predefinito:	Nessuno
Presenza:	È obbligatorio specificare <ResourceURL> o <Source>. Se sono presenti sia <ResourceURL> che <Source>, <ResourceURL> viene ignorato.
Tipo:	Stringa

Esempio

Consulta l'esempio di base nella sezione Samples.

Elemento <Source>

Consente di inserire JavaScript direttamente nella configurazione XML del criterio. Il valore inserito Il codice JavaScript viene eseguito quando il criterio viene eseguito nel flusso dell'API.

Predefinita:	Nessuno
Presenza:	È obbligatorio specificare <ResourceURL> o <Source>. Se sono presenti sia <ResourceURL> che <Source>, <ResourceURL> viene ignorato.
Tipo:	Stringa

Esempio

<Javascript name='JS-ParseJsonHeaderFullString' timeLimit='200' >
  <Properties>
    <Property name='inboundHeaderName'>specialheader</Property>
    <Property name='outboundVariableName'>json_stringified</Property>
  </Properties>
  <Source>
var varname = 'request.header.' + properties.inboundHeaderName + '.values.string';
var h = context.getVariable(varname);
if (h) {
  h = JSON.parse(h);
  h.augmented = (new Date()).valueOf();
  var v = JSON.stringify(h, null, 2) + '\n';
  // further indent
  var r = new RegExp('^(\S*)','mg');
  v= v.replace(r,'    $1');
  context.setVariable(properties.outboundVariableName, v);
}
  </Source>
</Javascript>

&lt;SSLInfo&gt; elemento

Specifica le proprietà utilizzate per configurare TLS per tutte le istanze del client HTTP create dal criterio JavaScript.

    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>

Predefinita:	Nessuno
Presenza:	Facoltativo
Tipo:	Stringa

La procedura per configurare TLS per un client HTTP è la stessa che utilizzi per configurare TLS per un TargetEndpoint/TargetServer. Per ulteriori informazioni, vedi Opzioni per la configurazione di TLS.

Note sull'utilizzo

Avviso: le chiamate di sistema non sono consentite dal modello di sicurezza. Ad esempio, quando il file system interno esegue operazioni di lettura o scrittura oppure recupera le informazioni dell'utente corrente, dell'elenco di processi o utilizzo di CPU/memoria. Sebbene alcune di queste chiamate possano essere funzionali, non sono supportati e potrebbero essere disattivati attivamente in qualsiasi momento. Per la compatibilità futura, dovresti evitare di effettuare queste chiamate nel codice.

Debug del codice dei criteri JavaScript

Utilizza la funzione print() per inviare le informazioni di debug alla transazione riquadro di output nello strumento di debug. Per dettagli ed esempi, vedi Debug con JavaScript print() estratti conto.

Per visualizzare le istruzioni di stampa in Debug:

1. Apri lo strumento di debug e avvia una sessione di traccia per un proxy contenente il tuo criterio JavaScript.
2. Chiama il proxy.
3. Nello strumento di debug, fai clic su Output di tutte le transazioni per aprire il riquadro di output.

   

4. Le istruzioni di stampa verranno visualizzate in questo riquadro.

Puoi utilizzare la funzione print() per visualizzare le informazioni di debug nello strumento di debug. Questa funzione è disponibile direttamente attraverso il modello a oggetti JavaScript. Per maggiori dettagli, vedi Esegui il debug di JavaScript con le istruzioni Print().

Variabili di flusso

Per impostazione predefinita, questo criterio non compila alcuna variabile. Tuttavia, puoi impostare (e ottenere) le variabili di flusso nel codice JavaScript chiamando i metodi sull'oggetto context. Un modello tipico ha il seguente aspetto:

context.setVariable("response.header.X-Apigee-Target", context.getVariable("target.name"))

L'oggetto context fa parte del modello oggetto JavaScript di Apigee.

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore. impostate da Apigee quando questo criterio attiva un errore. È importante conoscere queste informazioni se stai sviluppando regole di errore per gestire gli errori. Per saperne di più, consulta Cosa devi sapere sugli errori relativi ai criteri e sulla gestione di errore.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correzione per informazioni dettagliate sulla risoluzione dei problemi.

Codice di errore	Stato HTTP	Causa	Correggi
steps.javascript.ScriptExecutionFailed	500	Il criterio JavaScript può generare molti tipi diversi di errori ScriptExecutionFailed. Normalmente i tipi di errori visti includono: RangeError, ReferenceError, SyntaxError, TypeError e URIError.
steps.javascript.ScriptExecutionFailedLineNumber	500	Si è verificato un errore nel codice JavaScript. Consulta la stringa di errore per i dettagli.	N/D
steps.javascript.ScriptSecurityError	500	Si è verificato un errore di sicurezza durante l'esecuzione di JavaScript. Per i dettagli, consulta la stringa di errore.	N/D

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su accanto alla descrizione della causa dell'errore per visitare la pagina di risoluzione dei problemi.

Nome errore	Causa	Correggi
InvalidResourceUrlFormat	Se il formato dell'URL della risorsa specificato nell'elemento <ResourceURL> o <IncludeURL> del criterio JavaScript non è valido, il deployment del proxy API non va a buon fine.
InvalidResourceUrlReference	Se gli elementi <ResourceURL> o <IncludeURL> fanno riferimento a un file JavaScript non esistente, il deployment del proxy API non va a buon fine. Il file di origine a cui viene fatto riferimento deve esistere a livello di organizzazione, di proxy API o di ambiente.
WrongResourceType	Questo errore si verifica durante il deployment se gli elementi <ResourceURL> o <IncludeURL> del criterio JavaScript fanno riferimento a un tipo di risorsa diverso da jsc (file JavaScript).
NoResourceURLOrSource	Il deployment del criterio JavaScript può non riuscire con questo errore se <ResourceURL> non viene dichiarato o l'URL della risorsa non è definito all'interno di questo elemento. L'elemento <ResourceURL> è obbligatorio. In alternativa, l'elemento <IncludeURL> è dichiarato, ma l'URL della risorsa non è definito all'interno di questo elemento. L'elemento <IncludeURL> è facoltativo, ma se viene dichiarato, l'URL della risorsa deve essere specificato all'interno dell'elemento <IncludeURL>.

Variabili di errore

Queste variabili vengono impostate quando questo criterio attiva un errore in fase di runtime. Per ulteriori informazioni, consulta Cosa che devi conoscere sugli errori relativi alle norme.

Variabili	Dove	Esempio
fault.name="fault_name"	fault_name è il nome dell'errore, come indicato nella tabella Errori di runtime sopra. Il nome dell'errore è l'ultima parte del codice di errore.	fault.name Matches "ScriptExecutionFailed"
javascript.policy_name.failed	policy_name è il nome specificato dall'utente del criterio che ha generato l'errore.	javascript.JavaScript-1.failed = true

Esempio di risposta di errore

Nota: per la gestione degli errori, la best practice è il trap errorcode parte della risposta di errore. Non fare affidamento sul testo in faultstring, perché potrebbe cambiare.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Esempio di regola di errore

<FaultRule name="JavaScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(javascript.JavaScript-1.failed = true) </Condition>
</FaultRule>

Schema

Ogni tipo di criterio è definito da uno schema XML (.xsd). Come riferimento, gli schemi di criteri sono disponibili su GitHub.

Argomenti correlati

• Modello a oggetti JavaScript

Articoli della community Apigee

Puoi trovare questi articoli correlati nella community Apigee:

• Come gestire le intestazioni a più valori in JavaScript?