Zasady dotyczące kodu JavaScript

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Co

Ta zasada umożliwia dodawanie niestandardowego kodu JavaScript, który jest wykonywany w kontekście przepływu 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 dostępnych w modelu obiektu.

Informacje

Zasady JavaScript można wykorzystać na wiele sposobów. 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 wdrożenie niestandardowego działania, które nie jest objęte żadnymi innymi standardowymi zasadami Edge. W rzeczywistości możesz użyć zasady JavaScript, aby uzyskać wiele takich samych zachowań, jakie są implementowane przez inne zasady, np. AssignMessage i ExtractVariable.

Jednym z przypadków użycia, w których nie zalecamy stosowania zasad JavaScriptu, jest rejestrowanie. Zasady rejestrowania wiadomości znacznie lepiej nadają się do rejestrowania danych na platformach rejestrowania innych firm, takich jak Splunk, Sumo i Loggly. Możesz też zwiększyć wydajność serwera proxy interfejsu API, wykonując zasady rejestrowania wiadomości w ramach PostClientFlow, który jest wykonywany po wysłaniu odpowiedzi do klienta.

Zasady JavaScript umożliwiają określenie pliku źródłowego JavaScript do wykonania lub możesz uwzględnić kod JavaScript bezpośrednio w konfiguracji zasad za pomocą elementu <Source>. W obu przypadkach kod JavaScript jest wykonywany, gdy wykonywany jest krok, do którego dołączona jest zasada. W przypadku opcji pliku źródłowego kod źródłowy jest zawsze przechowywany w standardowej lokalizacji w pakiecie 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ć JavaScript za pomocą edytora proxy w interfejsie Apigee.

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

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

Wideo

Obejrzyj krótki film, aby dowiedzieć się, jak utworzyć niestandardowe rozszerzenie zasad za pomocą zasad 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>

Odwołanie do elementu

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

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

Poniższe atrybuty są specyficzne dla tych zasad.

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ść głównego pliku JavaScript określonego za pomocą elementu <ResourceURL> lub <Source>. Skrypty będą oceniane w kolejności, w jakiej są wymienione w zasadach. Kod może używać obiektów, metod i właściwości modelu obiektów JavaScriptu.

Dodaj więcej niż 1 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żna uzyskać dostęp z kodu JavaScript w czasie działania.

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

Atrybuty

Przykład

Przykład znajdziesz 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 API (w sekcji /apiproxy/resources/jsc w pakiecie serwera proxy API lub w sekcji Skrypty w okienku Nawigator edytora serwera proxy API) albo w zakresie organizacji lub środowiska, aby można było go używać w wielu serwerach proxy API, zgodnie z opisem 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 zasad. 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 elementu TargetEndpoint lub TargetServer. Więcej informacji znajdziesz w artykule Konfigurowanie TLS od Edge do backendu.

Zastosowanie

Zasady JavaScript nie zawierają kodu. Zamiast tego zasada JavaScript odwołuje się do „zasobu” JavaScript i określa krok w przepływie interfejsu API, w którym jest wykonywany kod JavaScript. Możesz przesłać skrypt za pomocą edytora proxy interfejsu zarządzania lub dołączyć go do katalogu /resources/jsc w proxy interfejsu API, które tworzysz lokalnie.

Debugowanie kodu zasad JavaScript

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

Aby wyświetlić instrukcje drukowania w Trace:

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

   

4. W tym panelu będą się wyświetlać Twoje wyciągi do druku.

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

Zmienne przepływu

Ta zasada domyślnie nie wypełnia żadnych zmiennych, ale w kodzie JavaScriptu możesz ustawiać (i pobierać) zmienne przepływu, wywołując metody na obiekcie 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 JavaScript Apigee Edge.

Odniesienie do błędu

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 JavaScript
• Instrukcje, przykłady zasad i przykłady kodu JavaScript znajdziesz w artykule Programowanie serwerów proxy interfejsu API za pomocą JavaScriptu.

Artykuły na forum Apigee

Powiązane artykuły znajdziesz w społeczności Apigee:

• Jak obsługiwać nagłówki z wieloma wartościami w JavaScript?