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

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

เกริ่นนำ

ใช้โมดูล 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: สามารถเป็นตัวเลข สตริง บูลีน Null หรือไม่ระบุ

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

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: พารามิเตอร์ค่าต้องเป็นสตริงหรือตัวเลข

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

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');