このページは Cloud Translation API によって翻訳されました。

JavaScript ポリシー

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

JavaScript ポリシーを使用すると、API プロキシフローのコンテキストで実行されるカスタム JavaScript コードを追加できます。このポリシーを使用すると、Apigee ポリシーでカバーされていないカスタム動作を実装できます。

カスタム JavaScript コードでは、Apigee JavaScript オブジェクトモデルのオブジェクト、メソッド、プロパティを使用できます。プロキシフローコンテキストで変数の取得、設定、削除、カスタムロジックの実行、障害処理の実施、リクエストやレスポンスからのデータの抽出、バックエンドターゲット URL の動的編集を行うことができます。オブジェクトモデルで使用できる基本的な暗号機能を使用することもできます。

JavaScript ポリシーでは、実行する JavaScript ソースファイルを指定できます。また、<Source> 要素を使用して、ポリシーの構成に直接 JavaScript コードを組み込むことができます。いずれの場合も、ポリシーが関連付けられているステップが実行されると JavaScript コードが実行されます。

ソースファイルオプションでは、ソースコードは常にプロキシバンドル内の標準の場所（apiproxy/resources/jsc）に格納されます。ソースコードを環境レベルまたは組織レベルのリソースファイルに保存することもできます。手順については、リソースファイルをご覧ください。Apigee UI プロキシエディタを使用して JavaScript をアップロードすることもできます。

Apigee では、次の目的で JavaScript ポリシーを使用することをおすすめしません。

Logging。MessageLogging ポリシーは、Splunk、Sumo、Loggly などのサードパーティのロギングプラットフォームでのロギングに適しています。このポリシーは、レスポンスがクライアントに返された後に PostClientFlow で実行されるため、API プロキシのパフォーマンスも向上させます。
Apigee ポリシーの置き換え。JavaScript ポリシーは、Apigee ポリシーの機能を置き換えるものではありません。必要な機能が Apigee ポリシーで利用可能な場合は、カスタム JavaScript ソリューションを実装する代わりに、そのポリシーを使用します。カスタム JavaScript コードは、Apigee ポリシーのパフォーマンスと最適化に匹敵しない可能性があります。

JavaScript ソースファイルには .js という拡張子を付ける必要があります。

Apigee では、Rhino JavaScript エンジン 1.7.13 で実行される JavaScript をサポートしています。

このポリシーは拡張可能なポリシーであり、Apigee ライセンスによっては、このポリシーの使用によって費用や使用量に影響する場合があります。ポリシータイプと使用量への影響については、ポリシータイプをご覧ください。

サンプル

ターゲット URL を書き直す

一般的なユースケースでは、リクエスト本文からデータを抽出し、フロー変数に保存して、そのフロー変数をプロキシフローの他の場所で使用します。たとえば、ユーザーが HTML フォームに名前を入力して送信するとします。フォームのデータを抽出してバックエンドサービスの URL に動的に追加するには、JavaScript ポリシーを使用します。

注: この例を試すには、プロキシエディタで新しいプロキシを作成します。プロキシを作成するときに、バックエンドサービスの URL（http://www.example.com など）を指定します。この例では、バックエンド URL を動的に書き換えます。新しいプロキシを作成する必要がある場合は、スタートガイドをご覧ください。

Apigee UI で、プロキシエディタで作成したプロキシを開きます。
[Develop] タブを選択します。
[New] メニューから [New Script] を選択します。
ダイアログで JavaScript を選択し、スクリプトに js-example という名前を付けます。
次のコードをコードエディタに貼り付けて、プロキシを保存します。context オブジェクトは、プロキシフローのどこにあっても JavaScript コードで使用できます。フロー固有の定数を取得したり、便利な get/set メソッドを呼び出したり、その他のオペレーションを実行したりします。このオブジェクトは、Apigee JavaScript オブジェクトモデルの一部です。target.url フロー変数は、ターゲットリクエストフローでアクセスできる組み込みの読み取り/書き込み変数です。この変数を API URL に設定すると、Apigee はそのバックエンド URL を呼び出します。これにより、元のターゲット URL（プロキシの作成時に指定した URL（http://www.example.com など））が書き換えられます。
```
if (context.flow=="PROXY_REQ_FLOW") {
     var username = context.getVariable("request.formparam.user");
     context.setVariable("info.username", username);
}


if (context.flow=="TARGET_REQ_FLOW") {
     context.setVariable("request.verb", "GET");
     var name = context.getVariable("info.username");
     var url = "http://mocktarget.apigee.net/"
     context.setVariable("target.url", url + "?user=" + name);
}
```
[New Policy] メニューから [JavaScript] を選択します。
ポリシーに target-rewrite という名前を付けます。デフォルト値をそのまま使用して、ポリシーを保存します。
[ナビゲータ] で [Proxy Endpoint Preflow] を選択すると、そのフローにポリシーが追加されます。
[Navigator] で、[Target Endpoint PreFlow] を選択します。
フローエディタの [Navigator] から、[Target Endpoint] の [Request] 側に JavaScript ポリシーをドラッグします。
保存します。
API を呼び出すときは、組織名とプロキシ名を置き換えます。

curl -i -H 'Content-Type: application/x-www-form-urlencoded' -X POST -d 'user=Will' http://myorg-test.apigee.net/js-example

この例で使用した JavaScript ポリシーの XML 定義を見てみましょう。<ResourceURL> 要素は、実行する JavaScript ソースファイルを指定します。このパターンは、すべての JavaScript ソースファイル（jsc://filename.js）に適用されます。JavaScript コードでインクルードが必要な場合は、このドキュメントで後述するように、1 つ以上の <IncludeURL> 要素を使用します。

<?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 からプロパティ値を取得する

構成に <Property> 要素を追加して、ランタイムに JavaScript で値を取得できます。

要素の name 属性を使用して、JavaScript コードからプロパティにアクセスするための名前を指定します。<Property> 要素の値（開始タグと終了タグの間の値）は、JavaScript が受け取るリテラル値です。

JavaScript では、次のように Properties オブジェクトのプロパティとしてアクセスし、ポリシーのプロパティ値を取得します。

プロパティを構成します。プロパティ値は変数名 response.status.code です。

<Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="JavascriptURLRewrite">
    <DisplayName>JavascriptURLRewrite</DisplayName>
    <Properties>
        <Property name="source">response.status.code</Property>
    </Properties>
    <ResourceURL>jsc://JavascriptURLRewrite.js</ResourceURL>
</Javascript>

JavaScript を使用してプロパティを取得します。getVariable 関数は、取得した変数名を使用して変数の値を取得します。

var responseCode = properties.source; // Returns "response.status.code"
var value = context.getVariable(responseCode); // Get the value of response.status.code
context.setVariable("response.header.x-target-response-code", value);

エラー処理

JavaScript コールアウトで使用できるエラー処理手法の例については、 JavaScript ポリシーからエラーを返す正しい方法をご覧ください。Apigee コミュニティでお知らせしている提案事項は情報提供のみを目的としたものであり、必ずしも Google が推奨するベストプラクティスではありません。

JavaScript ポリシー内から読み取り専用モードで request.content.asJSON にアクセスすると、メッセージ本文で大きい整数が指数表記に変換されます。これにより、メッセージは変換された値で上書きされます。

要素リファレンス

要素リファレンスは、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> 属性

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

属性	説明	デフォルト	要否
languageVersion	コードが記述されている JavaScript 言語のバージョンを指定します。値には、`VERSION_DEFAULT`、`VERSION_1_0`、`VERSION_1_1`、`VERSION_1_2`、`VERSION_1_3`、`VERSION_1_4`、`VERSION_1_5`、`VERSION_1_6`、`VERSION_1_7`、`VERSION_1_8`、`VERSION_ES6` などがあります。	VERSION_DEFAULT	省略可
timeLimit	スクリプトを実行できる最大時間（ミリ秒）を指定します。たとえば、200 ミリ秒の上限を超えると、ポリシーはエラー `Javascript.policy_name failed with error: Javascript runtime exceeded limit of 200ms` をスローします。注: 無料トライアルアカウントの場合、実行時間は 200 ミリ秒に制限されています。	なし	必須

次の表に、すべてのポリシーの親要素に共通する属性を示します。

属性	説明	デフォルト	要否
`name`	ポリシーの内部名。`name` 属性の値には、英字、数字、スペース、ハイフン、アンダースコア、ピリオドを使用できます。この値は 255 文字を超えることはできません。管理 UI プロキシエディタで `<DisplayName>` 要素を追加して、ポリシーのラベルに使用する別の自然言語名を指定することもできます。	なし	必須
`continueOnError`	ポリシーが失敗したときにエラーを返す場合は、`false` に設定します。これは、ほとんどのポリシーで想定される動作です。ポリシーが失敗した後もフローの実行を続行する場合は、`true` に設定します。関連項目: 障害ルールはエラー状態の場合にのみトリガーされる（continueOnError について）現在のフローにおける障害処理	false	省略可
`enabled`	ポリシーを適用するには、`true` に設定します。ポリシーを無効にするには、`false` に設定します。ポリシーがフローに接続されている場合でも適用されません。	true	省略可
`async`	この属性は非推奨となりました。	false	非推奨

<DisplayName> 要素

管理 UI プロキシエディタで name 属性と一緒に使用して、ポリシーのラベルに使用する自然言語名を指定します。

<DisplayName>Policy Display Name</DisplayName>

デフォルト

デフォルト	なしこの要素を省略した場合、ポリシーの `name` 属性の値が使用されます。
要否	省略可
タイプ	文字列

なし

この要素を省略した場合、ポリシーの name 属性の値が使用されます。

要否省略可

タイプ文字列

<IncludeURL> 要素

<ResourceURL> 要素または <Source> 要素で指定されたメインの JavaScript ファイルの依存関係として読み込む JavaScript ライブラリファイルを指定します。ポリシーは、ポリシーに記述されている順序でスクリプトを評価します。コードでは、JavaScript オブジェクトモデルのオブジェクト、メソッド、プロパティを使用できます。

複数の JavaScript 依存関係リソースを含めるには、追加の <IncludeURL> 要素を使用します。

警告: JavaScript ファイルがプロキシレベルまたは環境レベルで保存されている場合は、-F オプションを使用して cURL で、または REST クライアント経由で添付ファイルとして、正しくアップロードされるようにしてください。Content-Type は multipart/form-data です。詳細については、リソースの管理をご覧ください。

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

デフォルト:	なし
要否:	省略可
型:	文字列

<Property> 要素

JavaScript コードからランタイム時にアクセスできるプロパティを指定します。

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

デフォルト:	なし
要否:	省略可
型:	文字列

属性

属性	説明	デフォルト	要否
name	プロパティの名前を指定します。	なし	必須

例

サンプルセクションの例をご覧ください。

<ResourceURL> 要素

API フローで実行するメインの JavaScript ファイルを指定します。このファイルは、API プロキシスコープ（API プロキシバンドルの /apiproxy/resources/jsc または API プロキシエディタの [Navigator] ペインの [Scripts] セクション）に保存できます。または、リソースの管理の説明に従って、組織または環境スコープに保存して、複数の API プロキシ間で再利用することもできます。コードでは、JavaScript オブジェクトモデルのオブジェクト、メソッド、プロパティを使用できます。

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

デフォルト:	なし
要否:	`<ResourceURL>` または `<Source>` が必須。`<ResourceURL>` と `<Source>` の両方が存在する場合、ポリシーは `<ResourceURL>` を無視します。
型:	文字列

例

サンプルセクションの例をご覧ください。

<Source> 要素

ポリシーの XML 構成に直接 JavaScript を挿入できます。挿入された JavaScript コードは、ポリシーが API フローで実行された際に実行されます。

デフォルト:	なし
要否:	`<ResourceURL>` または `<Source>` が必須。`<ResourceURL>` と `<Source>` の両方が存在する場合、ポリシーは `<ResourceURL>` を無視します。
型:	文字列

例

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

JavaScript ポリシーにより作成されたすべての HTTP クライアントインスタンスに TLS を構成するために使用するプロパティを指定します。

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

デフォルト:	なし
要否:	省略可
型:	文字列

HTTP クライアントに TLS を構成するプロセスは、TargetEndpoint/TargetServer に TLS を構成するプロセスと同じです。詳細については、TLS の構成オプションをご覧ください。

使用上の注意