خط مشی جاوا اسکریپت

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

چی

این خط مشی به شما امکان می دهد کد جاوا اسکریپت سفارشی را اضافه کنید که در چارچوب یک جریان پراکسی API اجرا می شود. در کد جاوا اسکریپت سفارشی خود، می توانید از اشیاء، روش ها و ویژگی های مدل شی جاوا اسکریپت Apigee Edge استفاده کنید. مدل شی به شما امکان می دهد متغیرها را در زمینه جریان پروکسی دریافت، تنظیم و حذف کنید. همچنین می‌توانید از توابع رمزنگاری اولیه که با مدل شی ارائه شده‌اند استفاده کنید.

درباره

موارد استفاده زیادی برای خط مشی جاوا اسکریپت وجود دارد. به عنوان مثال، می‌توانید متغیرهای جریان را دریافت و تنظیم کنید، منطق سفارشی را اجرا کنید و مدیریت خطا را انجام دهید، داده‌ها را از درخواست‌ها یا پاسخ‌ها استخراج کنید، URL هدف باطن را به‌صورت پویا ویرایش کنید، و موارد دیگر. این خط‌مشی به شما امکان می‌دهد رفتار سفارشی را پیاده‌سازی کنید که توسط سایر خط‌مشی‌های استاندارد Edge پوشش داده نمی‌شود. در واقع، می‌توانید از یک خط‌مشی جاوا اسکریپت برای دستیابی به بسیاری از رفتارهای مشابهی که توسط سیاست‌های دیگر مانند AssignMessage و ExtractVariable پیاده‌سازی شده‌اند، استفاده کنید.

یکی از موارد استفاده ای که ما برای خط مشی جاوا اسکریپت توصیه نمی کنیم، ورود به سیستم است. خط‌مشی Message Logging برای ورود به سیستم عامل‌های ثبت شخص ثالث مانند Splunk، Sumo و Loggly بسیار مناسب‌تر است و با اجرای سیاست ثبت پیام در PostClientFlow، عملکرد پروکسی API را بهبود می‌بخشید، که پس از ارسال پاسخ اجرا می‌شود. به مشتری.

خط مشی جاوا اسکریپت به شما امکان می دهد یک فایل منبع جاوا اسکریپت را برای اجرا مشخص کنید یا می توانید کد جاوا اسکریپت را مستقیماً با عنصر <Source> در پیکربندی خط مشی وارد کنید. در هر صورت، کد جاوا اسکریپت زمانی اجرا می شود که مرحله ای که خط مشی به آن متصل شده است اجرا می شود. برای گزینه فایل منبع، کد منبع همیشه در یک مکان استاندارد در بسته پروکسی ذخیره می‌شود: apiproxy/resources/jsc . یا می‌توانید کد منبع را در یک فایل منبع در سطح محیط یا سازمان ذخیره کنید. برای دستورالعمل‌ها، فایل‌های منابع را ببینید. همچنین می توانید جاوا اسکریپت خود را از طریق ویرایشگر پروکسی Apigee UI آپلود کنید.

فایل های منبع جاوا اسکریپت همیشه باید دارای پسوند .js باشند.

نرم افزارهای پشتیبانی شده و نسخه های پشتیبانی شده را برای نسخه پشتیبانی شده فعلی جاوا اسکریپت ببینید.

ویدئو

برای یادگیری نحوه ایجاد یک برنامه افزودنی خط مشی سفارشی با استفاده از خط مشی جاوا اسکریپت، ویدیوی کوتاهی را تماشا کنید.

نمونه ها

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>

مرجع عنصر

مرجع عنصر عناصر و ویژگی های خط مشی جاوا اسکریپت را توصیف می کند.

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

ویژگی های زیر مختص این سیاست است.

The following table describes attributes that are common to all policy parent elements:

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>

عنصر <IncludeURL>

یک فایل کتابخانه جاوا اسکریپت را مشخص می کند که به عنوان وابستگی به فایل جاوا اسکریپت اصلی مشخص شده با عنصر <ResourceURL> یا <Source> بارگذاری شود. اسکریپت ها به ترتیبی که در خط مشی فهرست شده اند ارزیابی می شوند. کد شما می تواند از اشیاء، روش ها و ویژگی های مدل شی جاوا اسکریپت استفاده کند.

بیش از یک منبع وابستگی جاوا اسکریپت را با عناصر <IncludeURL> اضافه کنید.

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

مثال

به مثال پایه در بخش نمونه ها مراجعه کنید.

عنصر <Property>

خصوصیتی را مشخص می کند که می توانید از کد جاوا اسکریپت در زمان اجرا به آن دسترسی داشته باشید.

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

صفات

مثال

نمونه را در بخش نمونه ها ببینید.

عنصر <ResourceURL>

فایل اصلی جاوا اسکریپت را که در جریان API اجرا می شود را مشخص می کند. می‌توانید این فایل را در محدوده پروکسی API (در زیر /apiproxy/resources/jsc در بسته پروکسی API یا در بخش اسکریپت‌ها در پنجره ناوبر ویرایشگر پراکسی API)، یا در محدوده سازمان یا محیط برای استفاده مجدد در چندین پراکسی API ذخیره کنید. همانطور که در فایل های منابع توضیح داده شده است. کد شما می تواند از اشیاء، روش ها و ویژگی های مدل شی جاوا اسکریپت استفاده کند.

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

مثال

به مثال پایه در بخش نمونه ها مراجعه کنید.

عنصر <منبع>

به شما امکان می دهد جاوا اسکریپت را مستقیماً در پیکربندی XML خط مشی وارد کنید. کد جاوا اسکریپت درج شده زمانی اجرا می شود که خط مشی در جریان 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>

عنصر <SSLIinfo>

خصوصیات مورد استفاده برای پیکربندی TLS برای تمام نمونه های سرویس گیرنده HTTP ایجاد شده توسط خط مشی جاوا اسکریپت را مشخص می کند.

    <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 به Backend مراجعه کنید.

نکات استفاده

خط مشی جاوا اسکریپت حاوی هیچ کد واقعی نیست. در عوض، یک خط‌مشی جاوا اسکریپت به یک «منبع» جاوا اسکریپت ارجاع می‌دهد و مرحله را در جریان API که جاوا اسکریپت اجرا می‌کند، تعریف می‌کند. می‌توانید اسکریپت خود را از طریق ویرایشگر پروکسی مدیریت رابط کاربری آپلود کنید، یا می‌توانید آن را در فهرست /resources/jsc در پراکسی‌های API که به صورت محلی توسعه می‌دهید قرار دهید.

اشکال زدایی کد خط مشی جاوا اسکریپت

از تابع print() برای خروجی اطلاعات اشکال زدایی به پانل خروجی تراکنش در ابزار Trace استفاده کنید. برای جزئیات و مثال‌ها، عبارات Debug with JavaScript print() را ببینید.

برای مشاهده بیانیه های چاپی در Trace:

1. ابزار Trace را باز کنید و یک جلسه ردیابی برای پروکسی که حاوی خط مشی جاوا اسکریپت شما است را شروع کنید.
2. با پروکسی تماس بگیرید
3. در ابزار Trace، روی Output from all Transactions کلیک کنید تا پانل خروجی باز شود.

   

4. بیانیه های چاپی شما در این پانل ظاهر می شود.

می توانید از تابع print() برای خروجی اطلاعات اشکال زدایی به ابزار Trace استفاده کنید. این تابع مستقیماً از طریق مدل شی جاوا اسکریپت در دسترس است. برای جزئیات، به " Debug JavaScript with print() " مراجعه کنید.

متغیرهای جریان

این سیاست به طور پیش فرض هیچ متغیری را پر نمی کند. با این حال، می توانید متغیرهای جریان را در کد جاوا اسکریپت خود با فراخوانی متدها بر روی شی متن تنظیم کنید (و دریافت کنید). یک الگوی معمولی به این صورت است:

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

شی متن بخشی از مدل شی جاوا اسکریپت 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 در دسترس هستند.

موضوعات مرتبط

• مدل شی جاوا اسکریپت
• برای دستورالعمل‌ها، نمونه‌های خط‌مشی و نمونه‌های جاوا اسکریپت، برنامه‌نویسی پراکسی‌های API با جاوا اسکریپت را ببینید.

مقالات انجمن Apigee

می توانید این مقالات مرتبط را در انجمن Apigee بیابید:

• چگونه هدرهای چند ارزشی را در جاوا اسکریپت مدیریت کنیم ؟