Политика JavaScript

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

Что

Эта политика позволяет добавлять собственный код 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() для вывода отладочной информации в инструмент Trace . Эта функция доступна непосредственно через объектную модель 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 ?