AMP 快取網址格式與要求處理
重要事項:本文件不適用於您目前選取的格式「電子郵件」!
在本文中,您將瞭解 AMP 快取網址格式及其處理要求的方式。
網址格式
Google AMP 快取會為每個 AMP 文件的網域建立子網域,方法是先將網域從 IDN (Punycode) 轉換為 UTF-8。快取會將每個 -
(連字號) 取代為 --
(兩個連字號),並將每個 .
(點) 取代為 -
(連字號)。舉例來說,pub.com
會對應到 pub-com.cdn.ampproject.org
。
您可以使用這個網址計算工具,將網址轉換成 AMP 快取版本
本文說明
- AMP 快取上的網址結構。
- 如何預測您的網址在 AMP 快取上的顯示方式。
- 如何反轉 AMP 快取 Origin 標頭,以判斷其發布者網域為何。
網域名稱協定
所有文件在 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
) 稱為「網域前綴」。如需執行此轉換的演算法,請參閱下方說明。
這個前綴不會使用多個點狀元件 (例如 example.com.cdn.ampproject.org
),這是因為 https (TLS) 憑證受到 RFC 2818 的限制
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 個字元,而每個網域前綴的長度上限為 63 個字元,如 RFC 2181 所述,內容如下:
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).
所有發布者網域皆會對應至獨特的網域前綴。執行對應的演算法會盡力讓對應結果容易理解。不過,如果發布者網域過長,或發生下列情況,對應作業就會改為使用安全雜湊:
基本演算法
將發布者網域轉換為網域前綴的基本演算法如下:
- Punycode 解碼發布者網域。請參閱 RFC 3492
- 將步驟 1 輸出中的所有「
-
」(連字號) 字元取代為「--
」(兩個連字號)。 - 將步驟 2 輸出中的所有「
.
」(點) 字元取代為「-
」(連字號)。 - 如果步驟 3 的輸出在第 3 個和第 4 個位置都有「
-
」(連字號),請在步驟 3 的輸出中新增「0-
」前綴和「-0
」後綴。如需背景資訊,請參閱 #26205。 - 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 標籤
備用演算法
將發布者網域轉換為網域前綴的備用演算法如下:
- 使用 SHA256 雜湊發布者的網域。
- Base32 跳脫步驟 1 的輸出。
- 從步驟 2 的輸出中移除最後 4 個字元,這些字元一律為「
=
」(等於) 字元。
備用演算法會產生一個 52 個字元的字串,例如以下不含「-
」(連字號) 的字串:v2c4ucasgcskftbjt4c7phpkbqedcdcqo23tkamleapoa5o6fygq
。
合併演算法
合併演算法如下:
- 執行基本演算法。如果輸出是有效的 DNS 標籤,請附加快取網域後綴並傳回,例如
example-com.cdn.ampproject.org
。否則,請繼續執行步驟 2。 - 執行備用演算法。附加快取網域後綴並傳回,例如:
v2c4ucasgcskftbjt4c7phpkbqedcdcqo23tkamleapoa5o6fygq.cdn.ampproject.org
網址路徑
AMP 快取上網址的「路徑」一律由一或多個前綴目錄組成 (例如 /c
),後面接著 /s
中綴 (僅在發布者網址為 http s
時),最後則是發布者文件的網址 (不含協定)。
前綴目錄 (例如 /c
) 對應至 AMP 快取可能執行的不同服務類型。不同的 AMP 快取可能支援不同的服務類型,而且這並非詳盡的清單
/c
- 內容:這是以獨立網頁形式提供的 AMP 文件,可在某些介面中直接連結。/v
- 檢視器:這也是 AMP 文件,但會在 AMP 檢視器中提供,AMP 檢視器是一種框架環境,可在搜尋結果頁面或其他介面的情境中顯示 AMP 文件。/wp
- Web Package:這是以 Signed Exchange (一種 Web Package 技術) 形式提供的 AMP 文件。這些網址會做為重新導向至發布者自有原始伺服器的重新導向。/cert
- 憑證:這是搭配 Signed Exchange 使用的公開憑證。/i
- 圖片:這是由 AMP 快取提供的圖片,通常是文件子資源。/ii
- 圖片:這也是由 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 快取來源集。接著,您可以根據固定集進行驗證。
演算法的其餘部分假設「網域前綴」至少包含一個「-
」(連字號)。
- 如果網域前綴開頭為
xn--
,請 Punycode 解碼「網域前綴」。例如,xn---com-p33b41770a
會變成⚡😊-com
。如需 Punycode,請參閱 RFC 3492。 - 如果網域前綴開頭為「
0-
」且結尾為「-0
」,請移除「0-
」前綴和「-0
」後綴。 - 依序疊代步驟 2 輸出的字元,並在遇到字元時發出字元。當您遇到「
-
」(連字號) 時,請查看後續字元。如果後續字元也是「-
」(連字號),請略過輸入中的兩個字元,並發出單一個「-
」(連字號)。如果後續字元是任何其他字元,請僅略過目前的單一個「-
」(連字號),並發出「.
」(點)。舉例來說,a--b-example-com
會變成a-b.example.com
。 - Punycode 編碼步驟 3 的結果。如需 Punycode,請參閱 RFC 3492。
步驟 4 的結果將是發布者網域。協定無法從網域本身取得,但會是 http
或 https
。通訊埠一律為協定的預設通訊埠。
重新導向與錯誤處理
以下是一些 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 快取會針對原始網址傳回已解析的重新導向內容。
找不到
當在 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
-
作者: @Gregable
貢獻者: @sebastianbenz