Политика JavaScript

Вы просматриваете документацию Apigee Edge .
Перейти к документации Apigee X. info

Что

Эта политика позволяет добавлять пользовательский код JavaScript, выполняемый в контексте потока прокси-сервера API. В вашем пользовательском коде JavaScript вы можете использовать объекты, методы и свойства объектной модели JavaScript Apigee Edge. Объектная модель позволяет получать, устанавливать и удалять переменные в контексте потока прокси-сервера. Вы также можете использовать базовые криптографические функции, предоставляемые объектной моделью.

О

Существует множество вариантов использования политики JavaScript. Например, вы можете получать и задавать переменные потока, выполнять пользовательскую логику и выполнять обработку ошибок, извлекать данные из запросов и ответов, динамически редактировать целевой URL-адрес бэкэнда и многое другое. Эта политика позволяет реализовать пользовательское поведение, не охватываемое другими стандартными политиками Edge. Фактически, с помощью политики JavaScript можно реализовать многие из тех же действий, которые реализуются другими политиками, такими как AssignMessage и ExtractVariable.

Один из вариантов использования политики JavaScript, который мы не рекомендуем, — это ведение журналов. Политика ведения журналов сообщений гораздо лучше подходит для ведения журналов на сторонних платформах, таких как Splunk, Sumo и Loggly, а производительность прокси-сервера API повышается за счёт применения политики ведения журналов сообщений в PostClientFlow, который выполняется после отправки ответа клиенту.

Политика JavaScript позволяет указать исходный файл JavaScript для выполнения или включить код JavaScript непосредственно в конфигурацию политики с помощью элемента <Source> . В любом случае код JavaScript выполняется при выполнении шага, к которому прикреплена политика. При использовании исходного файла исходный код всегда хранится в стандартном расположении внутри пакета прокси: apiproxy/resources/jsc . Также можно сохранить исходный код в файле ресурсов на уровне среды или организации. Инструкции см. в разделе Файлы ресурсов . Вы также можете загрузить свой JavaScript через редактор прокси Apigee UI.

Исходные файлы JavaScript всегда должны иметь расширение .js .

Информацию о поддерживаемой в настоящее время версии JavaScript см. в разделе Поддерживаемое программное обеспечение и поддерживаемые версии .

Видео

Посмотрите короткое видео, чтобы узнать, как создать пользовательское расширение политики с помощью политики JavaScript.

Образцы

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>

Ссылка на элемент

Ссылка на элемент описывает элементы и атрибуты политики 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>

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

Следующие атрибуты являются специфичными для этой политики.

В следующей таблице описаны атрибуты, общие для всех родительских элементов политики:

Элемент <DisplayName>

Используйте в дополнение к атрибуту name , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим именем на естественном языке.

<DisplayName>Policy Display Name</DisplayName>

Элемент <IncludeURL>

Указывает файл библиотеки JavaScript, который будет загружен в качестве зависимости от основного файла JavaScript, указанного в элементе <ResourceURL> или <Source> . Скрипты будут выполняться в порядке, указанном в политике. Ваш код может использовать объекты, методы и свойства объектной модели JavaScript .

Включите более одного ресурса зависимости JavaScript с дополнительными элементами <IncludeURL> .

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

Пример

См. базовый пример в разделе «Примеры» .

Элемент <Свойства>

Указывает свойство, к которому можно получить доступ из кода JavaScript во время выполнения.

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

Атрибуты

Пример

См. пример в разделе «Примеры» .

Элемент <ResourceURL>

Указывает основной файл JavaScript, который будет выполняться в потоке API. Этот файл можно сохранить в области действия прокси API (в папке /apiproxy/resources/jsc в пакете прокси API или в разделе «Скрипты» на панели «Навигатор» редактора прокси API), а также в области действия организации или среды для повторного использования в нескольких прокси API, как описано в разделе «Файлы ресурсов» . Ваш код может использовать объекты, методы и свойства объектной модели JavaScript .

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

Пример

См. базовый пример в разделе «Примеры» .

Элемент <Источник>

Позволяет вставлять JavaScript непосредственно в XML-конфигурацию политики. Вставленный код JavaScript выполняется при выполнении политики в потоке API.

Пример

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

Задает свойства, используемые для настройки TLS для всех экземпляров HTTP-клиентов, созданных политикой JavaScript.

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

Процесс настройки TLS для HTTP-клиента аналогичен процессу настройки TLS для TargetEndpoint/TargetServer. Подробнее см. в разделе «Настройка TLS от Edge до бэкенда» .

Примечания по использованию

Политика JavaScript не содержит фактического кода. Вместо этого политика JavaScript ссылается на «ресурс» JavaScript и определяет шаг в потоке API, на котором выполняется JavaScript. Вы можете загрузить свой скрипт через редактор прокси-сервера интерфейса управления или включить его в каталог /resources/jsc в прокси-серверах API, которые вы разрабатываете локально.

Отладка кода политики JavaScript

Используйте функцию print() для вывода отладочной информации на панель вывода транзакций в инструменте трассировки. Подробности и примеры см. в разделе Отладка с помощью операторов JavaScript print() .

Чтобы просмотреть операторы печати в Trace:

1. Откройте инструмент трассировки и запустите сеанс трассировки для прокси-сервера, содержащего вашу политику JavaScript.
2. Позвоните прокси-серверу.
3. В инструменте трассировки нажмите Вывод всех транзакций , чтобы открыть панель вывода.

   

4. Ваши печатные выписки будут отображаться на этой панели.

Функцию print() можно использовать для вывода отладочной информации в инструмент трассировки . Эта функция доступна непосредственно через объектную модель JavaScript. Подробнее см. в разделе « Отладка JavaScript с помощью операторов print() ».

Переменные потока

Эта политика не заполняет переменные по умолчанию; однако вы можете задать (и получить) переменные потока в коде JavaScript, вызывая методы объекта контекста. Типичный шаблон выглядит следующим образом:

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

Объект контекста является частью объектной модели JavaScript Apigee Edge.

Ссылка на ошибку

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Example error response

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

Example fault rule

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

Схема

Каждый тип политики определяется XML-схемой ( .xsd ). Схемы политик доступны на GitHub.

Похожие темы

• Объектная модель JavaScript
• Инструкции, примеры политик и примеры JavaScript см. в разделе Программирование прокси-серверов API с помощью JavaScript .

Статьи сообщества Apigee

Вы можете найти эти статьи по теме в сообществе Apigee :

• Как обрабатывать многозначные заголовки в Javascript ?