Edge Security Acceleration：Fetch API

Fetch API方法定義

Fetch是完全非同步線程，只要您不使用await，Fetch就不會阻塞指令碼執行。目前每次可以發起4個子請求。由於底層採用的是長串連，您無需擔心效能，也不用主動處理串連池。

Fetch可以進行HTTP或HTTPS請求，每一次redirect都算一次請求。每一個Fetch最多可以支援12次redirect。

• 方法定義

  fetch(arg, init)，Fetch的詳細定義請參見MDN官方文檔WorkerOrGlobalScope.fetch()。

• 方法限制

  • 目前Fetch API只支援網域名稱，不支援IP地址。HTTP請求對應的連接埠為80，HTTPS請求對應的連接埠為443。

  • init參數內部的credentials、referrer、 referrerPolicy、cache和integrity無任何意義。

  • redirect預設值為follow，即fetch時如果來源站點返回3xx會直接跟隨。如果不需要跟隨3xx，需將redirect設定為manual。

  說明

  • 對瀏覽器內部的多種Fetch模式不做區分，例如CROS fetch，在CDN/DCDN/ESA上您可以Fetch任何來源站點。

  • 如果需要4個及以上的子請求時，請提交工單申請配額。

  • 請求URL的總長度不超過4 KB。

  • 函數通過Fetch擷取的gzip壓縮資源預設解壓。如不希望預設解壓內容，請參見下方Decompress章節添加manual參數。

• 設定逾時時間

  • Timeout函數

    /**
     * 請求逾時控制實現
     *
     * @param {Number} timeout 逾時等待時間，單位ms
     * @param {Object} config 逾時配置
     *   - @param {Object|Funtion} handler 逾時返回
     * @returns
     */
    const RequestTimeout = (timeout, config) => {
      return new Promise((resolve) => {
        const { handler = null } = config;
        let timer = setTimeout(() => {
          clearTimeout(timer);
          timer = null;
    
          const defaultRes = (typeof handler === 'function' ? handler() : handler) || {};
          resolve(defaultRes);
        }, timeout);
      });
    };

  • 調用樣本

    const KV_TIMEOUT = 1000;
    let edgekv = new EdgeKV({
      namespace: KV_NS,
    });
    
    let kvRequest = edgekv.get(key, getType);
    let timeoutPromise = RequestTimeout(KV_TIMEOUT, {
      handler: {
        res: {},
        errorMessage: `kv request timeout (${KV_TIMEOUT}ms)`,
      }
    });
    
    let resp = await Promise.race([
      kvRequest,
      timeoutPromise,
    ]);
    
    if (resp === undefined) {
      return "kv not found, key = " + key;
    } else {
      return resp;
    }

Redirect

Decompress

content-length

Headers

• 定義

  Headers的定義，請參見MDN官方文檔Headers。

• 限制

  header內部會記錄記憶體消耗，header對象可以儲存的最大header是8 KB。如果單個header對象超用，會觸發JS exception。

• 黑名單

  header有黑名單，無法讀寫以下頭，如果您讀取會造成exception。

  • expect

  • te

  • trailer

  • upgrade

  • proxy-connection

  • connection

  • keep-alive

  • dnt

  • host

  • 其他內部頭

Request

• 定義

  Request的定義，請參見MDN官方文檔Request。

• 限制

  Request對象的以下屬性沒有實現，在CDN/DCDN/ESA上下文中沒有意義。

  • context

  • credentials

  • destination

  • integrity

  • mode

  • referrer

  • referrerPolicy

  • cache

• 常見使用

  • 獲得要求方法：request.method。

  • 獲得請求url：request.url。

  • 獲得要求標頭：request.headers。

  • 獲得請求負載：request.body，body是一個ReadableStream對象。

  • 獲得JSON：await request.json()。

  • 獲得表單資料：await request.formData()。

  • 獲得UTF8字串：await request.text()。

  Request介面是標準的擴充，既可以忽略body，又確保body可以讀完，且不會將記憶體讀入JavaScript虛擬機器，從而避免了GC造成的延時，確保請求流的body從底層的socket中全部讀出。對於await request.ignore()，如果您不需要讀取Fetch的body或者不感興趣，建議所有的Fetch請求都調用request.ignore，可以有效提高效能，因為運行時會自動把讀取完body的請求發送至串連池中供下次複用。

Response

• 定義

  Response的定義，請參見MDN官方文檔Response。

• 限制

  Response對象的useFinalURLS和error屬性沒有實現，在CDN/DCDN/ESA上下文中沒有意義。

• 常見使用

  • 獲得回複碼：response.status。

  • 獲得回複reason phrase：response.statusText。

  • 獲得回複頭：response.headers。

  • 獲得回複URL：response.url，表示該回複是對應的URL發送的。

  • 獲得所有redirect的URL list，屬於非標準：response.urlList，類似Request對象實現了body mixin，使用類似方法您可以獲得body對象。

FormData

• 定義

  FormData的定義，請參見MDN官方文檔FormData。

• 限制

  FormData類似Header，有內部大小限制，如果過大FormData會出現異常。如果把FormData當作HTTP body發送，預設的content-type是form-data/multipart。

URLSearchParams

• 定義

  URLSearchParams的定義，請參見MDN官方文檔URLSearchParams()。

• 限制

  如果把URLSearchParams當作HTTPbody發送，預設的content-type是application/x-www-form-urlencode，最大限制為1000位元組。

Blob和File

• 定義

  • Blob的定義，請參見MDN官方文檔Blob。

  • File的定義，請參見MDN官方文檔File。

• 限制

  為了與標準保持一致，ER提供了Blob和File這兩個類。由於ER不支援讀寫檔案，為了滿足標準，您可以使用這兩個類，如果使用這兩個類提供給回複的body，content-type是Blob和File設定的mime type，和標準一致。