AMP

AMP 快取網址格式與要求處理

在本文中,您將瞭解 AMP 快取網址格式及其處理要求的方式。

網址格式

在可能的情況下,Google AMP 快取會先將每個 AMP 文件的網域從 IDN (Punycode) 轉換為 UTF-8,藉此為每個網域建立子網域。快取會將每個 - (破折號) 取代為 -- (2 個破折號),並將每個 . (點) 取代為 - (破折號)。例如,pub.com 會對應到 pub-com.cdn.ampproject.org

您可以使用此網址計算器將網址轉換為 AMP 快取版本

使用 AMP-Toolbox Cache URL Node.js 模組,將網址從原始網域轉換為 AMP 快取網址格式。

本文件說明

  • AMP 快取上的網址結構。
  • 如何預測您的網址在 AMP 快取上的顯示方式。
  • 如何反轉 AMP 快取來源標頭,以判斷其發布者網域。

網域名稱協定

所有文件在 AMP 快取上皆使用 https 協定。

網域名稱後綴

所有 AMP 快取皆註冊在 JSON 檔案中,該檔案可在 AMPHTML 儲存庫線上找到。此檔案中的快取記錄範例看起來會像這樣

{
  "id": "google",
  "name": "Google AMP Cache",
  "docs": "https://developers.google.com/amp/cache/",
  "cacheDomain": "cdn.ampproject.org",
  "updateCacheApiDomainSuffix": "cdn.ampproject.org",
  "thirdPartyFrameDomainSuffix": "ampproject.net"
},

AMP 快取會在 cacheDomain 指定的網域上提供記錄。在此案例中,網域為 cdn.ampproject.org

本文件使用網址 cdn.ampproject.org 作為範例,但其他快取通常使用類似的網址結構。

網域名稱前綴

AMP 快取會在經過變更的網址上提供文件,例如 example-com.cdn.ampproject.org。範例中原始網域名稱的第一個點分隔的元件 example.com 會變成 example-com。本文件將此非點分隔的字串 example-com 稱為「網域前綴」。如需執行此轉換的演算法,請參閱下文。

由於 https (TLS) 憑證的限制,RFC 2818,因此在此前綴中未使用多個點分隔的元件,例如 example.com.cdn.ampproject.org

Names may contain the wildcard character * which is considered to match any single domain name component or component fragment. E.g., *.a.com matches foo.a.com but not bar.foo.a.com.

發布者網域的長度最多可達 255 個字元,而根據 RFC 2181 的規定,每個網域前綴限制為 63 個字元,內容如下

The length of any one label is limited to between 1 and 63 octets.  A full domain name is limited to 255 octets (including the separators).

所有發布者網域皆會對應到唯一網域前綴。用於執行此操作的演算法嘗試使對應關係易於人為理解。但是,如果發布者網域過長,且在以下所述情況下,對應關係會回復為使用安全雜湊。

基本演算法

將發布者網域轉換為網域前綴的基本演算法如下:

  1. Punycode 解碼發布者網域。請參閱 RFC 3492
  2. 將步驟 1 輸出的結果中任何「-」(連字號) 字元取代為「--」(兩個連字號)。
  3. 將步驟 2 輸出的結果中任何「.」(點) 字元取代為「-」(連字號)。
  4. 如果步驟 3 的輸出在位置 3 和 4 皆有「-」(連字號),則在步驟 3 的輸出中新增「0-」前綴和「-0」後綴。如需背景資訊,請參閱 #26205
  5. Punycode 編碼步驟 3 的輸出。請參閱 RFC 3492

基本演算法的一些範例

發布者網域 網域前綴
example.com example-com
foo.example.com foo-example-com
foo-example.com foo--example-com
xn--57hw060o.com (⚡😊.com) xn---com-p33b41770a (⚡😊-com)
en-us.example.com 0-en--us-example-com-0

執行基本演算法之後,只有在網域前綴不是有效的 DNS 標籤時,我們才會執行下述的回退演算法。

如果網域前綴長度超過 63 個字元,則不是有效的 DNS 標籤

回退演算法

將發布者網域轉換為網域前綴的回退演算法如下:

  1. 使用 SHA256 雜湊發布者的網域。
  2. Base32 跳脫步驟 1 的輸出。
  3. 從步驟 2 的輸出中移除最後 4 個字元,這些字元一律為 = (等於) 字元。

回退演算法會產生 52 個字元的字串,例如以下不含 - (連字號) 的字串:v2c4ucasgcskftbjt4c7phpkbqedcdcqo23tkamleapoa5o6fygq

組合演算法

組合演算法為

  1. 執行基本演算法。如果輸出為有效的 DNS 標籤,請附加快取網域後綴並傳回,例如 example-com.cdn.ampproject.org。否則請繼續執行步驟 2。
  2. 執行回退演算法。附加快取網域後綴並傳回,例如:v2c4ucasgcskftbjt4c7phpkbqedcdcqo23tkamleapoa5o6fygq.cdn.ampproject.org

網址路徑

AMP 快取上網址的「路徑」一律包含一或多個前綴目錄 (例如 /c),後接 /s 中綴 (僅在發布者網址為 http s 時),然後是發布者文件的網址 (不含協定)。

前綴目錄 (例如 /c) 對應於 AMP 快取可能執行的不同服務類型。不同的 AMP 快取可能支援不同的服務類型,且此列表並未詳盡列出

  • /c - Content (內容):這是以獨立頁面形式提供的 AMP 文件,可在某些介面中直接連結。
  • /v - Viewer (檢視器):這也是 AMP 文件,但會在 AMP 檢視器中提供,AMP 檢視器是框架環境,可在搜尋結果頁面或其他介面的情境中顯示 AMP 文件。
  • /wp - Web Package (網路封包):這是以 Signed Exchange (一種網路封包技術) 形式提供的 AMP 文件。這些網址會作為重新導向至發布者自身原始網域的重新導向。
  • /cert - Certificate (憑證):這是用於 Signed Exchange 的公開憑證。
  • /i - Image (圖片):這是由 AMP 快取提供的圖片,通常作為文件子資源。
  • /ii - Image (圖片):這也是由 AMP 快取提供的圖片,但通常可以與其他快取設定參數結合使用,例如 /ii/w800,表示文件要求的最大寬度。快取可以在此處產生不同比例的圖片,以便為瀏覽器節省頻寬。

此外,AMP 快取可能會選擇將特殊的查詢參數附加到文件網址,這些參數不屬於發布者文件查詢的一部分。例如,<amp-live-list> 透過擷取具有參數 amp_latest_update_time< 的文件來發出重新整理要求。這些參數不會在檢索文件時傳遞至原始網域,而是嚴格地用於設定對 AMP 快取的要求。

CORS 來源

許多發布者會使用來自其 AMP 文件的 CORS 要求來擷取額外資料。CORS 要求的運作方式是在要求中傳送 Origin: HTTP 標頭,以指定發出要求的文件的來源。如上所示,文件在 AMP 快取上的來源與在原始文件上的來源不同。在上述網域名稱章節中,您可以找到用於判斷指定發布者網址的 AMP 快取網址來源的演算法。以下我們指定反向演算法,以將 CORS Origin: 要求標頭解碼回原始發布者網域。

從 AMP 快取來源到發布者網域

AMP 快取來源標頭值看起來會像以下範例之一

  • https://www-example-com.cdn.ampproject.org
  • https://v2c4ucasgcskftbjt4c7phpkbqedcdcqo23tkamleapoa5o6fygq.cdn.ampproject.org

首先,移除協定前綴 (https://) 和 AMP 快取網域後綴 (例如 .cdn.ampproject.org)。後綴可能來自 caches.json 中列出的任何一個快取。剩餘的字串將為「網域前綴」。以上兩個範例的「網域前綴」為

  • www-example-com
  • v2c4ucasgcskftbjt4c7phpkbqedcdcqo23tkamleapoa5o6fygq

接下來,檢查「網域前綴」是否包含至少一個「-」(連字號)。包含一或多個連字號是目前最常見的情況。如果「網域前綴」未包含至少一個「-」(連字號),則無法直接反轉 AMP 快取來源。反之,如果您知道可能的發布者網域集,則可以使用本文稍早的網域名稱演算法建立 AMP 快取來源集。然後您可以針對固定的集合進行驗證。

演算法的其餘部分假設「網域前綴」包含至少一個「-」(連字號)。

  1. 如果網域前綴以 xn-- 開頭,請 Punycode 解碼「網域前綴」。例如,xn---com-p33b41770a 變成 ⚡😊-com。如需 Punycode,請參閱 RFC 3492
  2. 如果網域前綴以「0-」開頭並以「-0」結尾,請移除「0-」前綴和「-0」後綴。
  3. 依序迭代步驟 2 輸出的字元,並在遇到時發出這些字元。當您遇到「-」(連字號) 時,請查看後續字元。如果後續字元也是「-」(連字號),請從輸入中略過這兩個字元,並發出單個「-」(連字號)。如果後續字元是任何其他字元,則僅略過目前的單個「-」(連字號) 並發出「.」(點)。例如,a--b-example-com 變成 a-b.example.com
  4. Punycode 編碼步驟 3 的結果。如需 Punycode,請參閱 RFC 3492

步驟 4 的結果將為發布者網域。協定無法從網域本身取得,但為 httphttps。連接埠一律為協定的預設連接埠。

重新導向與錯誤處理

以下是一些範例,說明 AMP 快取如何處理重新導向和錯誤

重新導向

AMP 快取在解析 AMP 網址時會遵循重新導向。例如,如果網址重新導向至另一個 AMP 網址

$ curl -I https://amp.dev.org.tw/documentation/examples/api/redirect?url=https://amp.dev.org.tw/index.amp.html
HTTP/1.1 301 Moved Permanently
Content-Type: text/html; charset=utf-8
Location: https://amp.dev.org.tw/index.amp.html
...

則 AMP 快取會傳回原始網址已解析重新導向的內容。

範例:https://amp-dev.cdn.ampproject.org/amp.dev/documentation/examples/api/redirect?url=https://amp.dev.org.tw/index.amp.html

如果您移動伺服器上 AMP 檔案的位置,請務必設定從舊位置到新位置的重新導向。

找不到

當在 AMP 快取中找不到頁面時,將會顯示錯誤頁面並傳回 404 狀態。

範例:https://amp-dev.cdn.ampproject.org/amp.dev/documentation/examples/api/not-found

無效的 AMP

當頁面為無效的 AMP 時,AMP 快取會重新導向至標準頁面。

範例:https://amp-dev.cdn.ampproject.org/amp.dev/documentation/examples/api/invalid-amp

伺服器錯誤

如果網址傳回 5XX 伺服器錯誤,AMP 快取將會傳回 404 狀態。

範例:https://amp-dev.cdn.ampproject.org/amp.dev/documentation/examples/api/server-error