سياسة JavaScript

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

المزايا

تتيح لك هذه السياسة إضافة رمز JavaScript مخصّص يتم تنفيذه في سياق واجهة برمجة التطبيقات. مسار الخادم الوكيل. في رمز JavaScript المخصّص، يمكنك استخدام كائنات وأساليب وخصائص نموذج كائن JavaScript في Apigee Edge. يتيح لك نموذج الكائن الحصول على البيانات وتعيينها وإزالتها المتغيرات في سياق تدفق الخادم الوكيل. إِنْتَ أيضًا استخدام وظائف التشفير الأساسية المتوفرة مع نموذج الكائن.

لمحة

هناك العديد من حالات استخدام سياسة JavaScript. على سبيل المثال، يمكنك الحصول على تدفق وتنفيذ المنطق المخصص وتنفيذ معالجة الأخطاء واستخراج البيانات من الطلبات أو والردود، وتعديل عنوان URL المستهدف في الخلفية ديناميكيًا، والمزيد. تسمح لك هذه السياسة بما يلي: تنفيذ سلوك مخصص لا يشمله أي من سياسات Edge العادية الأخرى. في الواقع، استخدام سياسة JavaScript لتحقيق العديد من السلوكيات نفسها التي تنفذها سياسات أخرى، مثل assignMessage واستخراج متغيّر.

إنّ إحدى حالات الاستخدام التي لا ننصح بها بشأن سياسة JavaScript هي التسجيل. تتناول سياسة تسجيل الرسائل أكثر ملاءمةً للتسجيل إلى منصات التسجيل التابعة لجهات خارجية، مثل Splunk وSumo وLoggly تحسين أداء الخادم الوكيل لواجهة برمجة التطبيقات من خلال تنفيذ سياسة تسجيل الرسائل في PostClientFlow، والذي يتم تنفيذه بعد إرسال الرد إلى العميل.

تتيح لك سياسة JavaScript تحديد ملف مصدر JavaScript لتنفيذه أو يمكنك تضمين رمز JavaScript مباشرةً في إعدادات السياسة باستخدام السمة <Source> العنصر. وفي كلتا الحالتين، يتم تنفيذ رمز JavaScript عند تنفيذ الخطوة المرتبطة بالسياسة. بالنسبة لخيار الملف المصدر، يتم تخزين شفرة المصدر دائمًا في الموقع العادي داخل حزمة الخادم الوكيل: apiproxy/resources/jsc. أو يمكنك أيضًا تخزين رمز المصدر في ملف مورد على مستوى البيئة أو المؤسسة. بالنسبة يُرجى الاطّلاع على ملفات الموارد. يمكنك أيضًا تحميل JavaScript من خلال محرِّر الخادم الوكيل لواجهة مستخدم Apigee.

يجب أن تحتوي ملفات المصدر 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>

مثال

اطّلِع على المثال الأساسي في القسم عيّنات.

<Property> عنصر

تحدِّد هذه السياسة موقعًا يمكنك الوصول إليه من رمز JavaScript في وقت التشغيل.

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

السمات

مثال

اطّلِع على المثال في القسم عيّنات.

<ResourceURL> عنصر

تحدِّد هذه السياسة ملف JavaScript الرئيسي الذي سيتم تنفيذه في مسار واجهة برمجة التطبيقات. يمكنك تخزين هذا الملف. في نطاق الخادم الوكيل لواجهة برمجة التطبيقات (ضمن /apiproxy/resources/jsc في حزمة الخادم الوكيل لواجهة برمجة التطبيقات أو في قسم النصوص البرمجية في جزء المستكشف في محرر خادم وكيل واجهة برمجة التطبيقات)، أو في المؤسسة أو نطاقات أخرى لإعادة استخدامها على عدة خوادم وكيلة لواجهة برمجة التطبيقات، كما هو موضَّح في ملفات الموارد. يمكن لتعليمتك البرمجية استخدام الكائنات، وخصائص نموذج كائن JavaScript.

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

مثال

اطّلِع على المثال الأساسي في القسم عيّنات.

<Source> عنصر

تسمح لك هذه السياسة بإدراج JavaScript مباشرةً في إعدادات XML الخاصة بالسياسة. تم إدراج يتم تنفيذ رمز JavaScript عند تنفيذ السياسة في مسار واجهة برمجة التطبيقات.

مثال

<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 وتحدد الخطوة في مسار واجهة برمجة التطبيقات حيث يتم تنفيذ JavaScript. يمكنك تحميل النص البرمجي من خلال محرر الخادم الوكيل لواجهة مستخدم الإدارة، أو يمكنك تضمينه في دليل /resources/jsc في الخوادم الوكيلة لواجهة برمجة التطبيقات التي تطوّرها محليًا

تصحيح أخطاء رمز سياسة 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). يمكنك الرجوع إلى مخططات السياسات المتوفرة على جيت هب.

مواضيع ذات صلة

• نموذج عنصر JavaScript
• للحصول على التعليمات وعيّنات السياسات وعيّنات JavaScript، يُرجى الاطّلاع على Programming API. خوادم وكيلة باستخدام JavaScript.

مقالات في منتدى Apigee

يمكنك العثور على هذه المقالات ذات الصلة في Apigee المنتدى:

• كيف يمكن التعامل مع الرؤوس المتعدّدة القيم في JavaScript؟