Политика 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() для вывода отладочной информации на панель вывода транзакций в инструменте трассировки. Подробности и примеры см. в разделе «Отладка с помощью операторов print() в JavaScript».

Чтобы просмотреть выписки в 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.

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

В этом разделе описаны коды ошибок и сообщения об ошибках, которые возвращаются, а также переменные ошибок, которые устанавливаются Edge, когда эта политика вызывает ошибку. Эту информацию важно знать, если вы разрабатываете правила обработки ошибок. Дополнительные сведения см. в разделах Что нужно знать об ошибках политики и Обработка ошибок .

Ошибки выполнения

Эти ошибки могут возникнуть при выполнении политики.

Ошибки развертывания

Эти ошибки могут возникнуть при развертывании прокси-сервера, содержащего эту политику.

Переменные неисправности

Эти переменные устанавливаются, когда эта политика вызывает ошибку во время выполнения. Дополнительные сведения см. в разделе Что нужно знать об ошибках политики .

Пример ответа об ошибке

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

Пример правила неисправности

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