專案需要對網頁元素做截圖驗證。我先前寫過一篇做法:先用 WebDriver 全螢幕截圖,再依目標元素所在的位置裁切,保留需要的那塊區域。
那段程式一直運作良好,直到遇上了 iframe。iframe(普通 frame 同理,只是現在少見)裡的內容被視為一個獨立網頁,連 window 物件都與父頁分離。WebDriver 的 WebElement.getLocation() 只能回傳元素相對於「它所在的 window」的位置——這個實作沒問題,但全螢幕截圖裡同時包含了 iframe 與父頁的內容,裁切時必須知道目標元素在「整張圖」中的位置。問題於此產生:如何計算一個元素相對於截圖的位置?
Chrome 的截圖是「當前可視範圍(viewport)」的內容。當網頁實際尺寸超過視窗時,捲動條位置不同、看到的內容就不同,截圖截的就是畫面上呈現出來的那部分。因此我們要算的是元素相對於當前可視內容的位置。
Firefox 則能截下整個網頁的內容,無視視窗大小。因此對 Firefox 我們要算的是元素的絕對位置(absolute position)。
取得元素位置會用到 Element.getBoundingClientRect(),它回傳元素相對於所處 window、在當前可視範圍中的位置,以 top、left、right、bottom 四個值表示。我們只關心 top 與 left,裁切尺寸用元素自身的寬高即可,不需另外計算。
要得到元素相對於最頂層 window 的位置,只需沿著 frameElement 鏈條,把每一層父 window 所對應 iframe 的 top 與 left 累加起來:
function calcViewportLocation(element) {
var currentWindow = window;
var rect = element.getBoundingClientRect();
var top = rect.top;
var left = rect.left;
while (currentWindow.frameElement != null) {
// 往上處理父級 window
element = currentWindow.frameElement;
currentWindow = currentWindow.parent;
rect = element.getBoundingClientRect();
if (rect.top > 0) { top += rect.top; }
if (rect.left > 0) { left += rect.left; }
}
return [Math.round(top), Math.round(left)];
}
這段程式適用於 Chrome。在 Firefox 中還要再加上捲動量:
window.pageXOffset(別名 scrollX)代表當前 window 橫向捲動條捲動的距離,把它與上述 left 相加,就得到橫向的絕對位置。iframe 也能沿同一條鏈條處理:
function calcAbsoluteLocation(element) {
var top = 0;
var left = 0;
var currentWindow = window;
while (element != null) {
var rect = element.getBoundingClientRect();
var pageYOffset = currentWindow.pageYOffset;
var pageXOffset = currentWindow.pageXOffset;
if (typeof pageYOffset === 'undefined') {
// IE8 不支援 pageXOffset/pageYOffset,需層層往下找
var currentDocument = currentWindow.document;
var bodyElement = (currentDocument.documentElement
|| currentDocument.body.parentNode
|| currentDocument.body);
pageYOffset = bodyElement.scrollTop;
pageXOffset = bodyElement.scrollLeft;
}
top += rect.top + pageYOffset;
left += rect.left + pageXOffset;
element = currentWindow.frameElement;
currentWindow = currentWindow.parent;
if (element != null) {
// iframe 自身有 border,會佔掉可視區域,需補回來
var style = window.getComputedStyle(element);
top += parseInt(style.borderTopWidth, 10);
left += parseInt(style.borderLeftWidth, 10);
}
}
return [Math.round(top), Math.round(left)];
}
有兩個細節值得說明。第一,IE8 不支援 pageXOffset 與 scrollX,所以程式碼中有一段層層向下尋找可捲動元素的處理,這是為舊瀏覽器留下的相容分支。第二,跨出 iframe 邊界時要加上該 iframe 的 border 寬度,否則一旦 iframe 有框線,計算結果就會整段偏移幾個像素。
把這兩段程式取代原本使用的 WebElement.getLocation(),即可在含 iframe 的頁面上正確裁切特定元素的截圖。
反過來想,這個問題的根源是「 WebDriver 回報的是局部座標,而截圖是全域座標」。理解這一點之後,任何同類型的座標換算都能用同一套「沿著 window 鏈條累加」的思路解決。