Chính sách JavaScript

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Nội dung

Chính sách này cho phép bạn thêm mã JavaScript tuỳ chỉnh thực thi trong ngữ cảnh của một API luồng proxy. Trong mã JavaScript tuỳ chỉnh, bạn có thể sử dụng các đối tượng, phương thức và thuộc tính của mô hình đối tượng JavaScript của Apigee Edge. Mô hình đối tượng cho phép bạn thu thập, thiết lập và xoá biến trong ngữ cảnh luồng proxy. Bạn cũng có thể sử dụng các hàm mật mã cơ bản được cung cấp cùng với mô hình đối tượng.

Giới thiệu

Có nhiều trường hợp sử dụng chính sách JavaScript. Ví dụ: bạn có thể lấy và thiết lập flow biến, thực thi logic tuỳ chỉnh và xử lý lỗi, trích xuất dữ liệu từ các yêu cầu hoặc phản hồi, chỉnh sửa động URL mục tiêu phụ trợ và nhiều chức năng khác. Chính sách này cho phép bạn triển khai hành vi tuỳ chỉnh không thuộc phạm vi điều chỉnh của bất kỳ chính sách tiêu chuẩn nào khác của Edge. Trên thực tế, bạn có thể sử dụng chính sách JavaScript để đạt được nhiều hành vi tương tự được triển khai bởi các chính sách khác, chẳng hạn như AttributionMessage và ExtractVariable.

Ghi nhật ký là một trường hợp sử dụng mà bạn không nên áp dụng cho chính sách JavaScript. Chính sách Ghi nhật ký thư phù hợp hơn với việc ghi nhật ký vào các nền tảng ghi nhật ký của bên thứ ba như Splunk, Sumo và Loggly, và bạn cải thiện hiệu suất của proxy API bằng cách thực thi chính sách Ghi nhật ký tin nhắn trong PostClientFlow, lệnh này sẽ thực thi sau khi phản hồi được gửi lại cho ứng dụng.

Chính sách JavaScript cho phép bạn chỉ định tệp nguồn JavaScript để thực thi hoặc bạn có thể trực tiếp đưa mã JavaScript vào cấu hình của chính sách bằng mã <Source> . Dù bằng cách nào, mã JavaScript cũng sẽ thực thi khi bước đính kèm chính sách. Đối với tuỳ chọn tệp nguồn, mã nguồn luôn được lưu trữ trong một vị trí chuẩn trong gói proxy: apiproxy/resources/jsc. Hoặc bạn cũng có thể lưu trữ mã nguồn trong tệp tài nguyên ở cấp môi trường hoặc tổ chức. Cho hướng dẫn, xem phần Tệp tài nguyên. Bạn có thể bạn cũng có thể tải JavaScript của mình lên thông qua trình chỉnh sửa proxy giao diện người dùng Apigee.

Các tệp nguồn JavaScript phải luôn có đuôi .js.

Xem Phần mềm được hỗ trợ và các phiên bản được hỗ trợ cho phiên bản JavaScript hiện được hỗ trợ.

Video

Xem video ngắn để tìm hiểu cách tạo tiện ích chính sách tuỳ chỉnh bằng JavaScript .

Mẫu

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>

Tham chiếu phần tử

Tài liệu tham khảo phần tử mô tả các phần tử và thuộc tính của chính sách 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> Thuộc tính

<Javascript name="Javascript-1" enabled="true" continueOnError="false" async="false" timeLimit="200">

Sau đây là các thuộc tính dành riêng cho chính sách này.

Bảng sau đây mô tả những thuộc tính chung cho tất cả phần tử mẹ của chính sách:

<DisplayName> phần tử

Hãy sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong phần trình chỉnh sửa proxy giao diện người dùng quản lý có tên ngôn ngữ tự nhiên khác.

<DisplayName>Policy Display Name</DisplayName>

<IncludeURL> phần tử

Chỉ định một tệp thư viện JavaScript sẽ được tải dưới dạng phần phụ thuộc vào tệp JavaScript chính được chỉ định bằng phần tử <ResourceURL> hoặc <Source>. Các tập lệnh sẽ được đánh giá trong theo thứ tự liệt kê trong chính sách. Mã của bạn có thể sử dụng các đối tượng, phương thức và các thuộc tính của mô hình đối tượng JavaScript.

Đưa vào nhiều tài nguyên phần phụ thuộc JavaScript cùng với thông tin bổ sung Phần tử <IncludeURL>.

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

Ví dụ:

Xem Ví dụ cơ bản trong phần Mẫu.

<Property> phần tử

Chỉ định một thuộc tính mà bạn có thể truy cập qua mã JavaScript trong thời gian chạy.

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

Thuộc tính

Ví dụ:

Xem ví dụ trong phần Mẫu.

<ResourceURL> phần tử

Chỉ định tệp JavaScript chính sẽ thực thi trong luồng API. Bạn có thể lưu trữ tệp này ở phạm vi proxy API (trong /apiproxy/resources/jsc trong gói proxy API hoặc trong phần Script (Tập lệnh) trong ngăn Navigator (Trình điều hướng) của trình chỉnh sửa proxy API) hoặc tại tổ chức hay để sử dụng lại trên nhiều proxy API, như mô tả trong Tệp tài nguyên. Mã của bạn có thể sử dụng các đối tượng, phương thức và thuộc tính của mô hình đối tượng JavaScript.

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

Ví dụ:

Xem Ví dụ cơ bản trong phần Mẫu.

<Source> phần tử

Cho phép bạn chèn JavaScript trực tiếp vào cấu hình XML của chính sách. Đã chèn Mã JavaScript thực thi khi chính sách này thực thi trong luồng API.

Ví dụ:

<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> phần tử

Chỉ định các thuộc tính dùng để định cấu hình TLS cho tất cả các phiên bản ứng dụng HTTP do Chính sách JavaScript.

    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>

Quy trình định cấu hình TLS cho ứng dụng HTTP cũng giống như quy trình mà bạn dùng để định cấu hình TLS cho TargetEndpoint/TargetServer. Xem bài viết Định cấu hình TLS từ Edge vào phần phụ trợ để biết thêm thông tin.

Lưu ý về cách sử dụng

Chính sách JavaScript không chứa mã thực. Thay vào đó, chính sách JavaScript sẽ tham chiếu đến "Tài nguyên" JavaScript và xác định Bước trong luồng API nơi JavaScript thực thi. Bạn có thể tải tập lệnh của bạn lên thông qua trình chỉnh sửa proxy giao diện người dùng quản lý hoặc bạn có thể đưa tập lệnh đó vào Thư mục /resources/jsc trong các proxy API mà bạn phát triển cục bộ.

Gỡ lỗi mã chính sách JavaScript

Sử dụng hàm print() để xuất thông tin gỡ lỗi cho giao dịch trong công cụ Theo dõi. Để biết thông tin chi tiết và ví dụ, hãy xem mục Gỡ lỗi bằng JavaScript print().

Cách xem câu lệnh in trong Theo dõi:

1. Mở Công cụ theo dõi và bắt đầu phiên theo dõi cho proxy chứa JavaScript của bạn .
2. Gọi proxy.
3. Trong Công cụ theo dõi, hãy nhấp vào Đầu ra từ tất cả giao dịch để mở kết quả bảng điều khiển.

   

4. Bảng sao kê in của bạn sẽ xuất hiện trong bảng điều khiển này.

Bạn có thể sử dụng hàm print() để xuất thông tin gỡ lỗi cho Công cụ theo dõi. Chức năng này có thể dùng trực tiếp thông qua mô hình đối tượng JavaScript. Để biết thông tin chi tiết, hãy xem phần "Gỡ lỗi JavaScript bằng print() tuyên bố".

Biến luồng

Theo mặc định, chính sách này không điền sẵn bất kỳ biến nào; tuy nhiên, bạn có thể thiết lập (và nhận) luồng các biến trong mã JavaScript của bạn bằng cách gọi các phương thức trên đối tượng ngữ cảnh. Mẫu thông thường sẽ có dạng như sau:

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

Đối tượng ngữ cảnh là một phần của mô hình đối tượng JavaScript của Apigee Edge.

Tham chiếu lỗi

Phần này mô tả các mã lỗi và thông báo lỗi được trả về cũng như các biến lỗi do Edge đặt khi chính sách này kích hoạt lỗi. Đây là thông tin quan trọng bạn cần biết nếu bạn đang phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem bài viết Những điều bạn cần biết về lỗi chính sách và Xử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi chính sách này thực thi.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy có chứa chính sách này.

Biến lỗi

Các biến này được đặt khi chính sách này kích hoạt lỗi trong thời gian chạy. Để biết thêm thông tin, xem phần Bạn cần biết về các lỗi chính sách.

Ví dụ về phản hồi khi gặp lỗi

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Ví dụ về quy tắc lỗi

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

Lược đồ

Mỗi loại chính sách được xác định bằng một giản đồ XML (.xsd). Giản đồ chính sách để tham khảo đều có trên GitHub.

Chủ đề có liên quan

• Mô hình đối tượng JavaScript
• Để biết hướng dẫn, mẫu chính sách và mẫu JavaScript, hãy xem phần API Programming proxy với JavaScript.

Bài viết trên thẻ Cộng đồng Apigee

Bạn có thể tìm thấy các bài viết liên quan này trên Apigee Cộng đồng:

• Cách xử lý tiêu đề nhiều giá trị trong JavaScript?