Zasady dotyczące kodu JavaScript

Oglądasz dokumentację Apigee Edge.
Wyświetl dokumentację Apigee X.

Co

Ta zasada umożliwia dodanie niestandardowego kodu JavaScriptu, który będzie wykonywany w kontekście przepływu pracy przez serwer proxy interfejsu API. W niestandardowym kodzie JavaScript możesz używać obiektów, metod i właściwości modelu JavaScript Apigee Edge. Model obiektu umożliwia pobieranie, ustawianie i usuwanie zmiennych w kontekście przepływu proxy. Możesz też używać podstawowych funkcji kryptograficznych dostępnych w modelu obiektu.

Informacje

Zasady JavaScript mają wiele zastosowań. Możesz na przykład pobierać i ustawiać zmienne przepływu, uruchamiać niestandardowe funkcje logiczne i obsługiwać błędy, wyodrębniać dane z żądań lub odpowiedzi, dynamicznie edytować docelowy adres URL backendu i nie tylko. Ta zasada pozwala wdrożyć niestandardowe zachowanie, które nie jest objęte innymi standardowymi zasadami Edge. Właściwie możesz użyć zasady JavaScript, aby osiągnąć wiele takich samych zachowań, które są zaimplementowane w innych zasadach, takich jak przypisywanie wiadomości i wyodrębnianie zmiennej.

Jednym z przypadków użycia, którego nie zalecamy w przypadku zasady dotyczącej języka JavaScript, jest rejestrowanie. Zasada logowania wiadomości o wiele lepiej nadaje się do logowania na zewnętrzne platformy logowania, takie jak Splunk, Sumo i Loggly, oraz zwiększa wydajność serwera proxy interfejsu API przez wykonanie zasady Message Logging w PostClientFlow, która jest wykonywana po wysłaniu odpowiedzi do klienta.

Zasada JavaScript umożliwia określenie pliku źródłowego JavaScriptu. Możesz też umieścić kod JavaScript bezpośrednio w konfiguracji zasady za pomocą elementu <Source>. W obu przypadkach kod JavaScript jest uruchamiany w trakcie wykonywania kroku, do którego jest dołączona zasada. W przypadku pliku źródłowego kod źródłowy jest zawsze przechowywany w standardowej lokalizacji w pakiecie pakietów serwera proxy: apiproxy/resources/jsc. Możesz też przechowywać kod źródłowy w pliku zasobów na poziomie środowiska lub organizacji. Instrukcje znajdziesz w artykule Pliki zasobów. Możesz też przesłać kod JavaScript za pomocą edytora proxy interfejsu Apigee UI.

Pliki źródłowe JavaScript muszą zawsze mieć rozszerzenie .js.

W artykule Obsługiwane oprogramowanie i obsługiwane wersje znajdziesz obecną wersję JavaScriptu.

Wideo

Obejrzyj krótki film, aby dowiedzieć się, jak utworzyć niestandardowe rozszerzenie zasad przy użyciu zasady JavaScript.

Sample

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

<?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>

Dokumentacja elementu

Dokumentacja elementu opisuje elementy i atrybuty zasad 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>

Atrybuty <Javascript>

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

Poniższe atrybuty dotyczą tej zasady.

Tabela poniżej opisuje atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

Element <DisplayName>

Używaj atrybutu name tak, aby oznaczyć zasadę w edytorze proxy interfejsu zarządzania inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>

Element <IncludeURL>

Określa plik biblioteki JavaScript, który ma być wczytywany jako zależność od głównego pliku JavaScript określonego za pomocą elementu <ResourceURL> lub <Source>. Skrypty będą sprawdzane w kolejności, w której są wymienione w zasadzie. Kod może korzystać z obiektów, metod i właściwości modelu JavaScriptu.

Uwzględnij więcej niż jeden zasób zależności JavaScript z dodatkowymi elementami <IncludeURL>.

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

Przykład

Zobacz podstawowy przykład w sekcji Przykłady.

Element <Property>

Określa właściwość, do której możesz uzyskać dostęp z kodu JavaScript w czasie działania.

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

Atrybuty

Przykład

Zobacz ten przykład w sekcji Przykłady.

Element <ResourceURL>

Określa główny plik JavaScript, który będzie wykonywany w ramach interfejsu API. Możesz przechowywać ten plik w zakresie serwera proxy interfejsu API (w sekcji /apiproxy/resources/jsc w pakiecie proxy interfejsu API, w sekcji Skrypty w panelu nawigatora proxy interfejsu API) albo w zakresie organizacji lub środowiska do ponownego użycia na wielu serwerach proxy interfejsu API zgodnie z opisem w plikach zasobów. Kod może korzystać z obiektów, metod i właściwości modelu JavaScriptu.

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

Przykład

Zobacz podstawowy przykład w sekcji Przykłady.

Element <Source>

Umożliwia wstawianie kodu JavaScript bezpośrednio do konfiguracji XML zasady. Wstawiony kod JavaScript jest wywoływany, gdy zasada wykonuje się podczas przepływu API.

Przykład

<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>

Element <SSLInfo>

Określa właściwości służące do konfigurowania TLS we wszystkich instancjach klienta HTTP utworzonych przez zasadę JavaScript.

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

Proces konfigurowania protokołu TLS dla klienta HTTP to ten sam proces, który służy do konfigurowania protokołu TLS dla serwera docelowego/serwera docelowego. Więcej informacji znajdziesz w sekcji Konfigurowanie TLS z Edge do backendu.

Zastosowanie

Zasada JavaScript nie zawiera rzeczywistego kodu. Zasada JavaScript odwołuje się do „zasobu” JavaScriptu i definiuje krok w jego trakcie, gdzie wykonywany jest kod JavaScript. Skrypt możesz przesłać za pomocą edytora proxy interfejsu zarządzania, ale możesz też umieścić go w katalogu /resources/jsc na serwerach proxy interfejsu API, które tworzysz lokalnie.

Debugowanie kodu zasad JavaScript

Użyj funkcji print(), aby wyświetlać dane debugowania w panelu wyników transakcji w narzędziu śledzenia. Szczegółowe informacje i przykłady znajdziesz w instrukcji Debug with JavaScript print().

Aby wyświetlić wyciągi drukowane w Trace:

1. Otwórz narzędzie śledzenia i rozpocznij sesję śledzenia dla serwera proxy, który zawiera zasadę JavaScript.
2. Wywołaj serwer proxy.
3. W narzędziu śledzenia kliknij Wyniki ze wszystkich transakcji, aby otworzyć panel wyjściowy.

   

4. Wyciągi drukowane pojawią się w tym panelu.

Możesz użyć funkcjiprint(), by przesłać dane debugowania do narzędzia śledzenia. Ta funkcja jest dostępna bezpośrednio przez model obiektu JavaScript. Więcej informacji znajdziesz w sekcji Debugowanie JavaScript za pomocą instrukcji instrukcji()().

Zmienne przepływu

Ta zasada domyślnie nie uzupełnia żadnych zmiennych. Możesz jednak ustawiać (i pobierać) zmienne przepływu w kodzie JavaScript, wywołując metody w obiekcie kontekstu. Typowy wzorzec wygląda tak:

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

Obiekt kontekstowy jest częścią modelu obiektu JavaScript Apigee Edge.

Dokumentacja błędu

W tej sekcji opisano kody błędów i zwracane komunikaty o błędach, które są zmieniane przez Edge po wywołaniu tej zasady. Ta informacja jest ważna, gdy opracowujesz reguły obsługi błędów. Więcej informacji znajdziesz w artykułach Co musisz wiedzieć o błędach zasad i Obsługa błędów.

Błędy w czasie wykonywania

Te błędy mogą wystąpić podczas wykonywania zasady.

Błędy wdrażania

Te błędy mogą wystąpić, gdy wdrażasz serwer proxy zawierający tę zasadę.

Zmienne błędów

Zmienne te są ustawiane, gdy ta zasada powoduje błąd w czasie działania. Więcej informacji znajdziesz w artykule Co musisz wiedzieć o błędach zasad.

Przykładowa odpowiedź na błąd

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

Przykładowa reguła awarii

<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>

Schemat

Każdy typ zasady jest zdefiniowany za pomocą schematu XML (.xsd). Informacje o schematach zasad są dostępne na GitHubie.

Powiązane artykuły

• Model obiektu JavaScript
• Instrukcje, przykłady zasad i przykłady JavaScript znajdziesz w artykule Programowanie serwerów proxy interfejsu API za pomocą JavaScriptu.

Artykuły dotyczące społeczności Apigee

Więcej powiązanych artykułów znajdziesz na stronie społeczności Apigee:

• Jak obsługiwać nagłówki wielowartościowe w JavaScript?