นโยบาย JavaScript

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล

อะไร

นโยบายนี้ให้คุณเพิ่มโค้ด JavaScript ที่กำหนดเองซึ่งทำงานภายในบริบทของ API ได้ โฟลว์พร็อกซี ในโค้ด JavaScript ที่กำหนดเอง คุณสามารถใช้ออบเจ็กต์ เมธอด และคุณสมบัติของ โมเดลออบเจ็กต์ JavaScript ของ Apigee Edge โมเดลออบเจ็กต์ช่วยให้คุณรับ ตั้งค่า และนำออกได้ ในบริบทโฟลว์พร็อกซีได้ คุณ นอกจากนี้ยังใช้ฟังก์ชันวิทยาการเข้ารหัสพื้นฐานที่มีให้กับโมเดลออบเจ็กต์ได้ด้วย

เกี่ยวกับ

นโยบาย JavaScript มีกรณีการใช้งานมากมาย เช่น คุณสามารถรับและตั้งค่าขั้นตอน ดำเนินการตรรกะที่กำหนดเองและดำเนินการจัดการความผิดพลาด ดึงข้อมูลจากคำขอ หรือ การตอบกลับ แก้ไข URL เป้าหมายแบ็กเอนด์แบบไดนามิก และอีกมากมาย นโยบายนี้ช่วยให้คุณดำเนินการต่อไปนี้ได้ ใช้ลักษณะการทำงานที่กำหนดเองซึ่งไม่อยู่ภายใต้นโยบาย Edge มาตรฐานอื่นๆ จริงๆ แล้ว คุณ สามารถใช้นโยบาย JavaScript เพื่อบรรลุลักษณะการทำงานที่เหมือนกันหลายอย่างซึ่งนโยบายอื่นใช้ เช่น AssignMessage และ ExtractVariable

Use Case หนึ่งที่เราไม่แนะนําสําหรับนโยบาย JavaScript คือการบันทึก นโยบายการบันทึกข้อความมีประโยชน์มาก เหมาะกับการบันทึกเข้าสู่แพลตฟอร์มการบันทึกข้อมูลของบุคคลที่สาม เช่น Splunk, Sumo และ Loggly และ คุณสามารถปรับปรุงประสิทธิภาพของพร็อกซี API ด้วยการบังคับใช้นโยบายการบันทึกข้อความใน PostClientFlow ซึ่งทำงานหลังจากส่งการตอบกลับไปยังไคลเอ็นต์แล้ว

นโยบาย JavaScript ให้คุณระบุไฟล์ต้นฉบับ JavaScript ที่จะดำเนินการหรือ คุณจะรวมโค้ด JavaScript ได้โดยตรงในการกำหนดค่าของนโยบายด้วย <Source> ไม่ว่าจะใช้วิธีใด โค้ด JavaScript จะทำงานเมื่อขั้นตอนที่แนบนโยบายทำงาน สำหรับตัวเลือกไฟล์ต้นฉบับ ซอร์สโค้ดจะเก็บอยู่ใน ตำแหน่งมาตรฐานภายในแพ็กเกจพร็อกซี: apiproxy/resources/jsc หรือคุณสามารถ จัดเก็บซอร์สโค้ดในไฟล์ทรัพยากรที่ระดับสภาพแวดล้อมหรือองค์กร สำหรับ โปรดดูวิธีการที่หัวข้อไฟล์ทรัพยากร คุณสามารถ ให้อัปโหลด JavaScript ผ่านตัวแก้ไขพร็อกซี UI ของ 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 เพื่อติดป้ายกำกับนโยบายใน เครื่องมือแก้ไขพร็อกซี UI การจัดการด้วยชื่อที่เป็นภาษาธรรมชาติต่างกัน

<DisplayName>Policy Display Name</DisplayName>

<IncludeURL> องค์ประกอบ

ระบุไฟล์ไลบรารี JavaScript ที่จะโหลดเป็นทรัพยากร Dependency สำหรับไฟล์ JavaScript หลัก ที่ระบุด้วยองค์ประกอบ <ResourceURL> หรือ <Source> สคริปต์จะได้รับการประเมินใน เพื่อเรียงลำดับในการระบุไว้ในนโยบาย โค้ดสามารถใช้ออบเจ็กต์ วิธีการ และ ของโมเดลออบเจ็กต์ JavaScript

รวมทรัพยากร Dependency ของ JavaScript มากกว่า 1 รายการพร้อมด้วยข้อมูลเพิ่มเติม องค์ประกอบ <IncludeURL>

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

ตัวอย่าง

ดูตัวอย่างพื้นฐานในส่วนตัวอย่าง

<Property> องค์ประกอบ

ระบุพร็อพเพอร์ตี้ที่คุณเข้าถึงได้จากโค้ด JavaScript ขณะรันไทม์

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

Attributes

ตัวอย่าง

ดูตัวอย่างในส่วนตัวอย่าง

<ResourceURL> องค์ประกอบ

ระบุไฟล์ JavaScript หลักที่จะทำงานในโฟลว์ API คุณจัดเก็บไฟล์นี้ได้ ที่ขอบเขตพร็อกซี API (ภายใต้ /apiproxy/resources/jsc ในแพ็กเกจพร็อกซี API หรือใน ส่วนสคริปต์ในบานหน้าต่างนำทางของเครื่องมือแก้ไขพร็อกซี API) หรือที่องค์กร หรือ ขอบเขตของสภาพแวดล้อมสำหรับการใช้งานซ้ำในพร็อกซี API หลายรายการ ตามที่อธิบายไว้ในไฟล์ทรัพยากร โค้ดสามารถใช้ออบเจ็กต์ และพร็อพเพอร์ตี้ของโมเดลออบเจ็กต์ JavaScript

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

ตัวอย่าง

ดูตัวอย่างพื้นฐานในส่วนตัวอย่าง

<Source> องค์ประกอบ

อนุญาตให้คุณแทรก 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 อ้างอิง "resource" ของ JavaScript และกำหนดขั้นตอนในโฟลว์ API ที่ JavaScript ประมวลผล คุณสามารถ อัปโหลดสคริปต์ของคุณผ่านตัวแก้ไขพร็อกซี UI การจัดการ หรือคุณสามารถรวมสคริปต์นั้นไว้ใน ไดเรกทอรี /resources/jsc ในพร็อกซี API ที่คุณพัฒนาในเครื่อง

การแก้ไขข้อบกพร่องของโค้ดนโยบาย JavaScript

ใช้ฟังก์ชัน print() เพื่อแสดงข้อมูลการแก้ไขข้อบกพร่องไปยังธุรกรรม แผงเอาต์พุตในเครื่องมือติดตาม ดูรายละเอียดและตัวอย่างได้ที่ "แก้ไขข้อบกพร่องด้วย JavaScript" print()

วิธีดูใบแจ้งยอดการพิมพ์ในการติดตาม

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) สคีมานโยบายสำหรับใช้อ้างอิง ที่มีอยู่ใน GitHub

หัวข้อที่เกี่ยวข้อง

• โมเดลออบเจ็กต์ JavaScript
• ดูวิธีการ ตัวอย่างนโยบาย และตัวอย่าง JavaScript ได้ที่ Programming API พร็อกซีด้วย JavaScript

บทความเกี่ยวกับชุมชน Apigee

คุณสามารถค้นหาบทความที่เกี่ยวข้องเหล่านี้ได้ใน Apigee ชุมชน:

• วิธีจัดการส่วนหัวหลายค่าใน JavaScript