2011年9月24日 星期六

[分享] livereload 設定及原理分析, livereload project analysis

之前介紹過livereload ,深深覺得他是個好東西,用過之後開發網站就不能缺少他,我真的回不去了。可是就會想要探討到底livereload 是怎麼做到修改檔案之後,就即時做頁面重新讀取呢?

分析
livereload 當程式執行之後就會開啟一個websocket server,如果檔案有任何變動,會發送訊息給瀏覽器,瀏覽器就會依據檔案不同執行不同程序。

Server端其實做的事情就是監聽檔案變化,發送訊息給client!

而預設的網站port號會採用35729,如果想要變更port號,在自己的家目錄底下有一個.livereload 檔案,去底下修改這個檔案,例如35729 修改為 88887。

~/.livereload
config.port = 88887



如此就可以將預設的port號修改,那到底還有哪些config 可以使用呢?還有哪些不為人知的秘密呢?接下來直接https://github.com/mockko/livereload一探究竟。

伺服器端檔案
livereload / server / lib / livereload.rb
host, 
:port, 
:exts, 
:exts_overwrite, 
:exclusions, 
:debug, 
:apply_js_live, 
:apply_css_live, 
:apply_images_live, 
:grace_period

原來可以使用的設定有這麼多種,至於每一個變數的功能為何,就不一一闡述,但是要置換的話,其實可以直接修改~/.livereload 這個檔案就可以了。

同時可以從原始碼中得知是採用em-dir-watcher(也是同一個作者),做IO 監控只要檔案有變動,立即就會得知同時做檔名比對發送資料到前端。

在linux 環境底下,底層檔案變更監控是採用Inotify機制,如此一來檔案變更的時候就可以即時知道哪些檔案變更了。

接著看到example 裡面有兩個檔案xbrowser.html, xbrowser.css,看到這個檔名應該跟跨瀏覽器有關係,讓我們來看一下。

    <script src="../src/content.js"></script>
    <script src="../src/background.js"></script>
    <script src="../src/xbrowser/livereload.js"></script>
    <script>
    window.onload = function(){
        livereload.run();
    };
    </script>

xbrowser.html就是直接使用livereload client 的連接,直接載入javascript,因此不需要加載任何外掛,測試一下也的確可以正常使用。

設定ip, port
/src/background.js
host: ('ip'),
port: 35729,

直接在這個檔案修改即可。

既然都有前端source code ,那就來找一下到底是怎麼換至javascript, css, img是不需要整頁重載,而只有載入局部資料的呢?整個頁面怎麼處理呢?
/src/content.js

html 重新載入
handleHTML: function(path) {

                this.document.location.reload();
}

頁面變動的部份其實很簡單,只要頁面檔案有變動,就直接reload page。


javascript 載入
handleJS: function(path, options) {
// 省略
            if (script.src && this.equals(script.src, path)) {
                this.reloadScript(script);
                reloaded++;
            }
// 省略

        return reloaded;
    }

css 載入
handleCSS: function(path, options) {

        var links = this.document.querySelectorAll('link[rel="stylesheet"]');

            if (this.equals(link.href, path)) {
                reloaded += this.reattachStylesheetLink(link);
            } 
}

可以看到是讀取script, style 節點,取得src 資料之後進行比對,在做重新載入的動作,可以得知只要任何一個.js 檔案變動之後,就會直接將script 的資料重新載入執行。

另外比較值得一提,css部份,為了重新載入不要有畫面一閃的問題出現,因此會先clone style 節點,在真正得到新的資料之後,再將利用reattachStylesheetLink這個方法將檔案重新載入,如此解決掉畫面閃爍的問題。

Image 載入
    handleImages: function(path, options) {
        var reloaded = 0;


        var stylesheets = this.document.styleSheets;
        var imgs = this.document.images;
        var expando = this.generateExpando();
        for (var i = 0; i < imgs.length; i++) {
            var img = imgs[i];
            if (this.equals(img.src, path)) {
                img.src = this.generateNextUrl(img.src, expando);
                reloaded++;
            }
        }
        var src;
        imgs = this.document.querySelectorAll('[style*=background]');
        for (i = 0; i < imgs.length; i++) {
            img = imgs[i];
            if (!img.style.backgroundImage) {
                continue;
            }
            src = this.extractURL(img.style.backgroundImage);
            if (src && this.equals(src, path)) {
                img.style.backgroundImage = 'url(' + this.generateNextUrl(src, expando) + ')';
                reloaded++;
            }
        }

        imgs = this.document.querySelectorAll('[style*=border]');
        for (i = 0; i < imgs.length; i++) {
            img = imgs[i];
            if (!img.style.borderImage) {
                continue;
            }
            src = this.extractURL(img.style.borderImage);
            if (src && this.equals(src, path)) {
                img.style.borderImage = 'url(' + this.generateNextUrl(src, expando) + ')';
                reloaded++;
            }
        }

        for (i = 0; i < stylesheets.length; i++) {
            reloaded += this.reloadStylesheetImages(stylesheets[i], path, expando).length;
        }

        return reloaded;
    },

Image 就分成幾個部份來實做重新載入

  • css重新載入之後,會讀取相關css image
  • img 節點,路徑比對之後,重新載入影像


結語
事實上其他瀏覽器外掛,也是載入javascript 的方式來執行。如果直接自行載入javascript ,就可以免除掉各個瀏覽器安裝外掛的問題發生。只要瀏覽器支援websocket 就可以直接執行。

從原始碼來看,其實livereload 在前端(javascript )做了許多小地方調整,例如為了保證載入的檔案不會有cache 問題,因此加載的uri 都會加上一組亂數,在頁面重新讀取也考慮到css, javascript 的問題等。

目前比較可惜的是IE無法支援websocket,似乎可以使用socket.io 替換掉  websocket,如此就可以直接跨瀏覽器支援了,但是目前沒有這個版本!殘念(有人想要一起寫嗎?livereload rewrite)

沒有留言:

張貼留言

Facebook