Zasady dotyczące kodu JavaScript

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Co

Ta zasada pozwala dodawać niestandardowy kod JavaScript, który jest wykonywany w kontekście interfejsu API z serwera proxy. W niestandardowym kodzie JavaScript możesz używać obiektów, metod i właściwości modelu obiektów JavaScript Apigee Edge. Model obiektów umożliwia pobieranie, ustawianie i usuwanie w kontekście procesu proxy. Ty może też używać podstawowych funkcji kryptograficznych udostępnianych przez model obiektowy.

Informacje

Istnieje wiele przypadków użycia zasad JavaScript. Możesz na przykład pobrać i ustawić przepływ zmiennych, uruchamiać niestandardową logikę i usuwać błędy, wyodrębniać dane z żądań lub odpowiedzi, dynamicznej edycji docelowego adresu URL backendu i nie tylko. Ta zasada umożliwia: zaimplementować niestandardowe zachowanie, którego nie obejmują inne standardowe zasady Edge. Tak naprawdę mogą używać zasad JavaScriptu, aby osiągnąć podobny efekt za pomocą innych zasad np. AssignMessage i ExtractVariable.

Jednym z przypadków, których nie zalecamy w przypadku zasad JavaScriptu, jest logowanie. Zasada logowania wiadomości na potrzeby logowania na zewnętrznych platformach logowania, takich jak Splunk, Sumo czy Loggly, poprawia wydajność serwera proxy API przez uruchomienie zasad logowania komunikatów w PostClientFlow, który jest wykonywany po wysłaniu odpowiedzi do klienta.

Zasada JavaScript pozwala określić źródłowy plik JavaScript do wykonania lub możesz umieścić kod JavaScript bezpośrednio w konfiguracji zasady za pomocą interfejsu <Source> . W obu przypadkach kod JavaScript jest wykonywany po wykonaniu kroku, do którego przyłączona jest zasada. W przypadku opcji pliku źródłowego kod źródłowy jest zawsze przechowywany w standardowa lokalizacja w pakiecie proxy: apiproxy/resources/jsc. Możesz też przechowywać kod źródłowy w pliku zasobów na poziomie środowiska lub organizacji. Dla: instrukcji znajdziesz w artykule Pliki zasobów. Dostępne opcje możesz też przesłać JavaScript za pomocą edytora serwera proxy interfejsu Apigee.

Źródłowe pliki JavaScript muszą zawsze mieć rozszerzenie .js.

Zobacz Obsługiwane oprogramowanie i obsługiwane wersje dla obecnie obsługiwanej wersji JavaScriptu.

Wideo

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

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

<Javascript> Atrybuty

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

Poniższe atrybuty są charakterystyczne dla tej zasady.

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

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

<IncludeURL> element

Określa plik biblioteki JavaScript, który ma być wczytywany jako zależność od głównego pliku JavaScript określona za pomocą elementu <ResourceURL> lub <Source>. Skrypty zostaną ocenione w w takiej kolejności, w jakiej są wymienione w zasadach. W kodzie możesz używać obiektów, metod właściwości obiektowego modelu JavaScript.

Uwzględnij więcej niż jeden zasób zależności JavaScript oraz dodatkowe <IncludeURL> elementów.

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

Przykład

Przykład podstawowy znajdziesz w sekcji Sample.

<Property> element

Wskazuje właściwość, do której masz dostęp z kodu JavaScript w czasie działania.

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

Atrybuty

Przykład

Przykład znajdziesz w sekcji Sample.

<ResourceURL> element

Określa główny plik JavaScript, który zostanie uruchomiony w przepływie interfejsu API. Możesz zapisać ten plik w zakresie serwera proxy interfejsu API (w sekcji /apiproxy/resources/jsc w pakiecie proxy API lub w sekcji Skrypty w panelu Nawigator edytora serwera proxy interfejsu API) albo w organizacji lub zakresy środowiskowe do ponownego wykorzystania na wielu serwerach proxy interfejsu API, zgodnie z opisem w artykule Pliki zasobów. Twój kod może używać obiektów, i metodach obiektowego modelu JavaScript.

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

Przykład

Przykład podstawowy znajdziesz w sekcji Sample.

<Source> element

Umożliwia wstawienie kodu JavaScript bezpośrednio do konfiguracji XML zasady. Wstawione 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>

<SSLInfo> element

Określa właściwości używane do konfigurowania TLS we wszystkich instancjach klienta HTTP utworzonych przez zasady 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 w przypadku klienta HTTP jest taki sam jak w przypadku konfigurowania Protokół TLS dla punktu końcowego lub serwera docelowego. Zobacz Konfigurowanie TLS z Edge do backendu. .

Zastosowanie

Zasada JavaScript nie zawiera rzeczywistego kodu. Zamiast tego zasada JavaScript odwołuje się do „zasób” JavaScriptu i definiuje krok w przepływie interfejsu API, w którym wykonuje się JavaScript. Dostępne opcje prześlij skrypt za pomocą edytora serwera proxy interfejsu zarządzania, ale możesz go też umieścić w Katalog /resources/jsc na serwerach proxy interfejsu API, które tworzysz lokalnie.

Debugowanie kodu zasad JavaScript

Użyj funkcji print(), by wysłać informacje o debugowaniu transakcji. panelu wyjściowego w narzędziu Trace. Szczegółowe informacje i przykłady znajdziesz w artykule Debugowanie z użyciem JavaScriptu print().

Aby wyświetlić instrukcje wydruku w Trace:

1. Otwórz narzędzie Trace i rozpocznij sesję śledzenia dla serwera proxy zawierającego Twój JavaScript .
2. Wywołaj serwer proxy.
3. W narzędziu do śledzenia kliknij Wyniki ze wszystkich transakcji, aby wyświetlić dane wyjściowe. panel.

   

4. W tym panelu pojawią się oświadczenia dotyczące drukowania.

Możesz użyć funkcji Print(), aby wyświetlić w narzędziu do śledzenia informacje o debugowaniu. Ta funkcja jest dostępna bezpośrednio za pomocą obiektowego modelu JavaScript. Aby dowiedzieć się więcej, zapoznaj się z sekcją „Debugowanie JavaScriptu za pomocą funkcji Print()” wyciągi”.

Zmienne przepływu

Ta zasada domyślnie nie uzupełnia żadnych zmiennych. możesz jednak ustawić (i uzyskać) przepływ, w kodzie JavaScript przez wywołanie metod w obiekcie kontekstu. Typowy wzór 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.

Informacje o błędzie

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

Powiązane artykuły

• Obiektowy model JavaScript
• Instrukcje, przykłady zasad i przykłady JavaScriptu znajdziesz na stronie Programming API i serwery proxy z JavaScriptem.

Artykuły społeczności Apigee

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

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