การเข้าถึงตัวแปรโฟลว์ใน Node.js

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

บทนำ

ใช้โมดูล apigee-access เพื่อเข้าถึงตัวแปรของ Apigee Edge ในแอปพลิเคชัน Node.js โมดูลมีเมธอดสําหรับการเรียก การตั้งค่า และการลบตัวแปร นอกจากนี้ยังมีเมธอดที่สะดวกสําหรับการตั้งค่าตัวแปรจำนวนเต็มด้วย

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

ดูข้อมูลเบื้องต้นเกี่ยวกับข้อบังคับ apigee-access และฟีเจอร์อื่นๆ ได้ที่การใช้ข้อบังคับ apigee-access

ตัวอย่างที่ใช้งานได้

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

var http = require('http');
var apigee = require('apigee-access');

http.createServer(function (request, response) {
  // The request parameter must be a request object that came from the http module
  var userId = apigee.getVariable(request, 'AuthenticatedUserId');
  apigee.setVariable(request, "custom.foo", "Bar");
  console.log('Authenticated Apigee User ID is %s', userId);
  response.writeHead(200, {'Content-Type': 'text/plain'});
  response.end('Hello World\n');
}).listen(8124);

console.log('Server running at http://127.0.0.1:8124/');

คุณสามารถคัดลอกโค้ดนี้ลงในไฟล์ JavaScript, ติดตั้งใช้งานใน Edge และลองใช้ได้ เรียกไฟล์ server.js หากต้องการทำให้ใช้งานได้ ให้ใช้

apigeetool deploynodeapp -u username -p password -o myorg -e test -n access -d . -m server.js -b /access

หลังจากติดตั้งใช้งานแอปพลิเคชันไปยัง Edge แล้ว ให้เพิ่มนโยบาย AssignMessage ที่มีการกำหนดค่าต่อไปนี้ลงในขั้นตอนการส่งคำขอของ ProxyEndpoint

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="AddUserId">
    <DisplayName>AddUserId</DisplayName>
    <FaultRules/>
    <Properties/>  
    <AssignVariable>
        <Name>AuthenticatedUserId</Name>
        <Value>ntesla</Value>
        <Ref/>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

จากนั้น แนบนโยบาย AssignMessage อีกรายการไปยังขั้นตอนการตอบสนองล่วงหน้าของ TargetEndpoint:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="SetHeader">
    <DisplayName>SetHeader</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="MySpecialHeader">{custom.foo}</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

คุณเรียกใช้พร็อกซีได้ดังนี้

curl -i http://myorg-test.apigee.net/access

จากนั้นให้ไปที่หน้าของพร็อกซีการเข้าถึงใน UI การจัดการ แล้วเปิดมุมมองพัฒนาขึ้นมา คลิกบันทึก Node.js เพื่อดูเอาต์พุตบันทึกจากพร็อกซี หากกําหนดค่าพร็อกซีอย่างถูกต้อง คุณจะเห็นการตั้งค่าตัวแปร userId นอกจากนี้ คุณจะเห็นการตั้งค่าส่วนหัวในเอาต์พุต cURL ในหน้าต่างเทอร์มินัลด้วย

HTTP/1.1 200 OK

Content-Type: text/plain
Date: Tue, 27 05 2014 23:20:52 GMT
MySpecialHeader: Bar
Content-Length: 12
Connection: keep-alive

เมธอด

getVariable

var result = getVariable(httpRequest, name);

รับตัวแปรที่มีชื่อ

พารามิเตอร์:

  • httpRequest: ออบเจ็กต์คำขอที่มาจากโมดูล http
  • name: (สตริง) ชื่อของตัวแปรที่จะดึงข้อมูล

การคืนสินค้า:

สตริงหรือตัวเลขโดยขึ้นอยู่กับประเภทที่ตั้งค่าไว้โดยใช้ setVariable() เมื่อใดที่คุณสร้างขึ้นที่อื่น หรือเวลาที่นโยบายสร้างขึ้นมา หากคุณกำลังเข้าถึงตัวแปร Edge ที่พร้อมใช้งานแบบสำเร็จรูป คุณสามารถดูรายการประเภทต่างๆ ได้ในข้อมูลอ้างอิงตัวแปร สำหรับประเภทตัวแปรที่นโยบายสร้างขึ้น โปรดดูหัวข้ออ้างอิงนโยบายที่เจาะจง

ตัวอย่างเช่น

var apigee = require('apigee-access');
    // "httpRequest" must be a request object that came from the http module
    var val1 = apigee.getVariable(request, 'TestVariable');
    var val2 = apigee.getVariable(request, 'request.client.ip');

setVariable

setVariable(httpRequest, name, value);

ตั้งค่าตัวแปร ตัวแปรบางรายการเป็นแบบอ่านอย่างเดียว และเมธอด setVariable() จะแสดงข้อยกเว้นหากคุณพยายามตั้งค่าตัวแปรดังกล่าว หากต้องการทราบว่าตัวแปรใดเป็นแบบอ่านอย่างเดียว โปรดดูการอ้างอิงตัวแปร

พารามิเตอร์:

  • httpRequest: ออบเจ็กต์คำขอที่มาจากโมดูล http
  • name: (สตริง) ชื่อของตัวแปรที่จะดึงข้อมูล
  • value: อาจเป็นตัวเลข สตริง บูลีน ว่าง หรือไม่มีการกำหนด

ตัวอย่างเช่น

var apigee = require('apigee-access');
    apigee.setVariable(request, 'TestVariable', 'bar');
    // This will throw an exception because client.ip is read-only.
    apigee.setVariable(request, 'client.ip');

setIntVariable

setIntVariable(httpRequest, name, value);

เมธอด setIntVariable() เป็นเมธอดที่สะดวกซึ่งจะบังคับให้พารามิเตอร์ค่าเป็นจำนวนเต็มก่อน แล้วจึงตั้งค่า

พารามิเตอร์

  • httpRequest: ออบเจ็กต์คำขอที่มาจากโมดูล http
  • name: (สตริง) ชื่อของตัวแปรที่จะตั้งค่า
  • value: พารามิเตอร์ value ต้องเป็นสตริงหรือตัวเลข

ตัวอย่างเช่น

var apigee = require('apigee-access');
// Convert "123" to an integer and set it
apigee.setIntVariable(request, 'TestVariable', '123');
// Use something that's already a number
apigee.setIntVariable(request, 'TestVariable2', 42);

deleteVariable

ลบตัวแปรที่มีชื่อ การลบตัวแปรที่อ่านอย่างเดียวเป็นข้อผิดพลาด ดูรายการตัวแปรที่อ่านอย่างเดียวทั้งหมดได้ที่ข้อมูลอ้างอิงเกี่ยวกับตัวแปร

deleteVariable(httpRequest, name);

พารามิเตอร์:

  • httpRequest: ออบเจ็กต์คำขอที่มาจากโมดูล http
  • name: (สตริง) ชื่อของตัวแปรที่จะลบ

ตัวอย่างเช่น

  apigee.deleteVariable(request, 'TestVariable');
    // This will throw an exception because client.ip is a read-only variable.
    apigee.deleteVariable(request, 'client.ip');