Zasady dotyczące kodu JavaScript

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Co

Ta zasada umożliwia dodawanie niestandardowego kodu JavaScript, który jest wykonywany w kontekście przepływu serwera proxy interfejsu API. W niestandardowym kodzie JavaScript możesz używać obiektów, metod i właściwości modelu obiektów JavaScriptu Apigee Edge . Model obiektów umożliwia pobieranie, ustawianie i usuwanie zmiennych w kontekście przepływu serwera proxy. Możesz też używać podstawowych funkcji kryptograficznych, które są dostępne w modelu obiektów.

Informacje

Zasada JavaScript ma wiele zastosowań. Możesz na przykład pobierać i ustawiać zmienne przepływu , wykonywać niestandardową logikę i obsługiwać błędy, wyodrębniać dane z żądań lub odpowiedzi, dynamicznie edytować docelowy adres URL backendu i wiele innych. Ta zasada umożliwia implementowanie niestandardowych działań, które nie są objęte żadnymi innymi standardowymi zasadami Edge. W rzeczywistości możesz użyć zasady JavaScript, aby uzyskać wiele tych samych działań, które są implementowane przez inne zasady, takie jak AssignMessage i ExtractVariable.

Jednym z przypadków użycia, których nie zalecamy w przypadku zasady JavaScript, jest logowanie. Zasada Message Logging znacznie lepiej nadaje się do logowania na platformach logowania innych firm, takich jak Splunk, Sumo i Loggly. Możesz też zwiększyć wydajność serwera proxy interfejsu API, wykonując zasadę Message Logging w PostClientFlow, która jest wykonywana po wysłaniu odpowiedzi do klienta.

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

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

Aktualnie obsługiwaną wersję JavaScriptu znajdziesz w artykule Obsługiwane oprogramowanie i obsługiwane wersje.

Wideo

Obejrzyj krótki film, aby dowiedzieć się, jak utworzyć niestandardowe rozszerzenie zasady za pomocą zasady JavaScript.

Przykłady

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 elementów

Dokumentacja elementów zawiera opis elementów i atrybutów zasady 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 elementu <Javascript>

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

Te atrybuty są specyficzne dla tej zasady.

W tej tabeli opisano atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

&lt;DisplayName&gt; element

Używaj oprócz atrybutu name do oznaczania zasady w edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>

Element <IncludeURL>

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

Dołącz więcej niż 1 zasób zależności JavaScript za pomocą dodatkowych <IncludeURL> elementów.

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

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

Atrybuty

Przykład

Zobacz przykład w sekcji Przykłady.

Element <ResourceURL>

Określa główny plik JavaScript, który będzie wykonywany w przepływie interfejsu API. Ten plik możesz przechowywać w zakresie serwera proxy interfejsu API (w katalogu /apiproxy/resources/jsc w pakiecie serwera proxy interfejsu API lub w sekcji Skrypty w panelu nawigatora edytora serwera proxy interfejsu API) albo w zakresie organizacji lub środowiska, aby można go było używać w wielu serwerach proxy interfejsu API, jak opisano w artykule Pliki zasobów. Kod może używać obiektów, metod i właściwości modelu obiektów 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 wykonywany, gdy zasada jest wykonywana w przepływie interfejsu 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 używane do konfigurowania protokołu TLS dla wszystkich instancji 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 jest taki sam jak proces konfigurowania protokołu TLS dla punktu końcowego docelowego lub serwera docelowego. Więcej informacji znajdziesz w artykule Konfigurowanie protokołu TLS z Edge do backendu.

Zastosowanie

Zasada JavaScript nie zawiera żadnego kodu. Zamiast tego zasada JavaScript odwołuje się do „zasobu” JavaScript i definiuje krok w przepływie interfejsu API, w którym jest wykonywany kod JavaScript. Skrypt możesz przesłać za pomocą edytora serwera proxy w interfejsie zarządzania lub umieścić go w /resources/jsc katalogu w serwerach proxy interfejsu API, które tworzysz lokalnie.

Debugowanie kodu zasady JavaScript

Użyj funkcji print() , aby wyświetlać informacje debugowania w panelu danych wyjściowych transakcji w narzędziu Trace. Szczegółowe informacje i przykłady znajdziesz w artykule Debugowanie za pomocą instrukcji JavaScript print().

Aby wyświetlić instrukcje print w narzędziu Trace:

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

   

4. W tym panelu pojawią się instrukcje print.

Za pomocą funkcji print() możesz wyświetlać informacje debugowania w narzędziu Trace. Ta funkcja jest dostępna bezpośrednio w modelu obiektów JavaScriptu. Więcej informacji znajdziesz w artykule "Debugowanie JavaScriptu za pomocą instrukcji print() statements".

Zmienne przepływu

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

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

Obiekt kontekstu jest częścią modelu obiektów JavaScriptu Apigee Edge .

Dokumentacja błędów

W tej sekcji opisano zwracane kody błędów i komunikaty o błędach oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wywołuje błąd. To ważna informacja jeśli tworzysz reguły błędów obsługi błędów. Więcej informacji znajdziesz w artykule Co musisz wiedzieć o błędach związanych z zasadami i postępowaniu z błędami

Błędy w czasie wykonywania

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

Błędy wdrażania

Te błędy mogą wystąpić podczas wdrażania serwera proxy zawierającego tę zasadę.

Zmienne błędów

Te zmienne są ustawiane, gdy ta zasada wywołuje błąd w czasie działania. Aby dowiedzieć się więcej, zapoznaj się z artykułem Co musisz wiedzieć o błędach związanych z naruszeniem 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 błędu

<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 przez schemat XML (.xsd). Schematy zasad są dostępne na GitHubie.

Powiązane artykuły

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

Artykuły w Społeczności Apigee

Te powiązane artykuły znajdziesz w Społeczności Apigee:

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