可視化埋點平臺元素曝光采集intersectionObserver思路實踐

更新時間：2023年01月04日 17:07:39 作者：芋仔

這篇文章主要為大家介紹了可視化埋點平臺元素曝光采集的思路—intersectionObserver的實戰(zhàn)經驗詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

正文

最近一直在開發(fā)可視化埋點系統(tǒng)，其中元素的曝光埋點，就是借助了 intersectionObserver 這個原生 api。也是網上推薦度比較高的方案，同時 2022 年，該 api 兼容性也已經很高，同時也有 polyfill，基本上使用無虞。

intersectionObserver 本身 api 非常簡單，但是在實際使用的過程中，由于可視化埋點的一些特殊性以及對埋點準確性的要求，還是遇到了一些 dom 變更后的邊緣場景，本文便是對這些邊緣場景的一個記錄及實現(xiàn)背后的一些考慮。

通常來講，元素的埋點是開發(fā)者主動在元素中直接埋點，而筆者正在開發(fā)的可視化埋點，在數(shù)據收集側的工作，是異步從后臺獲取用戶需要的元素 xpath，然后再通過 xpath 尋找到元素，調用 intersectionObserver 的 observe 方法進行監(jiān)聽元素的曝光。所以在進行監(jiān)聽的時機上，都是在元素掛載到 dom 后進行元素的監(jiān)聽，那么初次監(jiān)聽，是否會觸發(fā)其回調，便關系到曝光埋點的準確性。

同時，可視化埋點也監(jiān)聽頁面 dom 的變更，當變更后，需要解除舊元素的監(jiān)聽，同時增加對新元素的監(jiān)聽。那么如果多次監(jiān)聽同一元素，是否會多次觸發(fā)回調，也影響到曝光的準確性。

設計方案

為了快速上線第一版，筆者最初的設計方案為：

根據服務端返回的 xpath，尋找到對應的 dom 元素，對元素進行 observe
監(jiān)聽 dom 變更事件，當 dom 發(fā)生改變后，重新根據 xpath 尋找 dom 元素，對元素進行再次 observe

在該方案中，存在幾個觸發(fā)時機可能導致的問題：

當監(jiān)聽發(fā)生在元素渲染到頁面后，首次監(jiān)聽的同時，是否會觸發(fā)回調（影響到初次曝光的準確性）
多次監(jiān)聽同一 dom 元素，是否會多次觸發(fā)回調（影響到 dom 變更，多次監(jiān)聽同一元素后，曝光的準確性）

測驗結論

當初次監(jiān)聽元素時，會立即觸發(fā)一次回調
多次監(jiān)聽同一元素，并不會多次觸發(fā)回調

在上述邏輯成立的情況下，筆者最初的方案其實是可以正常工作，對于初次曝光，雖然發(fā)生在元素渲染到 dom 之后，但是由于會立即觸發(fā)一次，故初次曝光能夠正常上報。而當 dom 發(fā)生變更后，消失的元素，雖然沒有調用 unobserve，但是由于該元素消失了，并不會影響后續(xù)曝光埋點的上報，所以并沒有帶來大的問題，而 dom 變更后，元素如果依然存在，雖然再次進行了監(jiān)聽，但是多次監(jiān)聽并不影響同一元素，所以其實也沒有問題。

對于第一版，上線后也確實能夠正常工作，但是對于沒有 unobserve 這一點，由于 js 的垃圾回收機制，必須是沒有引用后才會銷毀，而沒有 unobserve，那么內部必然會維護一份監(jiān)聽的元素的列表，保留了已經從 dom 中移除的元素的引用，從而造成內存泄漏。

故需要做一些策略來避免該問題（不然代碼也會被吐槽），思路如下：

維護一份 xpath -> 元素的映射，當 dom 發(fā)生變更時，遍歷所有 xpath 尋找對應的元素，

如果元素同映射中一致，那么表示該元素沒有發(fā)生變更，此時可以直接忽略，什么都不做。

而如果元素發(fā)生變化，那么調用 unobserve 取消舊元素的監(jiān)聽，同時對新元素進行監(jiān)聽即可。

完整的偽代碼

// 工具函數(shù)命名很清晰，含義不贅述
import { getEleByXpath, getXpathByEle, debounce } from 'utils'; 
class track {
    constructor() {
        /* 
        {
            xpath: '',
            id: ''id
        }
        */
        this.config = {} // 存儲遠程服務端返回的埋點 xpath 信息
        /*
            [xpath]: el,
        */
        this.map = {} // 維護的 xpath -> el 映射
        this.observer = null; // intersectionObserver 實例
    }
    // 遠端獲取需要曝光點的元素
    getConfig() {
        return fetch('xxx').then(res => {
            this.config = res;
            this.config.forEach(item => {
                // 初始化 xpath -> el 映射
                this.map[item.xpath] = null;
            })
        });
    }
    // 監(jiān)聽 dom 變更
    addDomtreeMutatorObserver() {
        // 不關心屬性變化
        const config = { attributes: false, childList: true, subtree: true };
        // 監(jiān)聽dom變更，消個抖
        const observer = new MutationObserver(debounce(this.observe.bind(this), 200));
        observer.observe(document.body, config);
    }
    // 監(jiān)聽元素曝光
    observe() {
        // 此處可以加個 requestIdleCallback 來增強性能
        this.config.forEach((item) => {
            const targetEl = getEleByXpath(item.xpath);
            // 新舊元素不一致才需要取消舊元素監(jiān)聽，增加新元素監(jiān)聽
            if (targetEl !== this.map[item.xpath]) {
                // 元素存在，就監(jiān)聽
                if (targetEl) {
                    this.observer.observe(targetEl);
                }
                // 取消舊元素的監(jiān)聽
                if (this.map[shadow.xpath]) {
                    this.observer.unobserve(this.map[shadow.xpath]);
                }
                // 更新map中的el
                this.map[shadow.xpath] = targetEl;
            }
            // 一致，則什么都不做
        });
    }
    // 創(chuàng)建 intersectionObserver
    initObserver() {
        const callback = (entries) => {
            entries.forEach((entry) => {
                if (entry.intersectionRatio > 0.2) {
                    const targetXpath = getXpath(entry.target);
                    for (let i = 0; i < this.config.length; i++) {
                        if (this.config[i].xpath === targetXpath) {
                            // xpath一致
                            // 發(fā)送曝光埋點
                        }
                    }
                }
            });
        };
        const observer = new IntersectionObserver(callback, {
            threshold: 0.2,
        });
        this.observer = observer;
    }
    init() {
        this.getConfig().then(() => {
            // 初始化 intersectionObserver
            this.initObserver();
            // 監(jiān)聽元素
            this.observe();
            // 監(jiān)聽 dom 元素變更
            this.addDomtreeMutatorObserver();
        });
    }
}

以上便是精簡后的偽代碼，其核心的優(yōu)化點便是維護 xpath -> el 的 map（說實話，一開始筆者其實就想到了 map，但是當時想的是拿 dom 引用作為 key，拿對象做 key 顯然是行不通的，就短暫放棄，先上線再說。后來想到用 xpath 做key，才有了這篇文章）。

其實本文的初衷是記錄一下 intersectionObserver 的一些邊緣情況及結論（其實還對 intersectionObserver 做了其他一些比較傻的測試），但是在文章編寫的過程中發(fā)現(xiàn)干巴巴的分析，顯得實在是無趣，故夾雜了實際的可視化埋點曝光采集的業(yè)務場景，希望沒有寫的很亂。

同時，當筆者徹底理清思路后，發(fā)現(xiàn)這優(yōu)化其實不值一提，只是筆者最初在設計可視化埋點方案時，由于對這些 api 的不熟悉，導致的一些迷迷糊糊的摸爬滾打經驗，還望懂的同學別笑。

以上就是可視化埋點平臺元素曝光采集intersectionObserver思路實踐的詳細內容，更多關于intersectionObserver元素曝光采集的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: