跳到主要內容

[分享] 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)

留言

這個網誌中的熱門文章

[分享] 腳踏車環島注意事項

很多人都期望自己能夠做點什麼,做些什麼,而退伍之後的第二個星期,就展開了環島之旅。 對很多人來說這不算什麼,甚至有人展開了走路、跑步、溜滑板、單輪車等方式環島一周,充分展現對台灣的愛與關懷。 這篇主要讓不知道怎麼準備環島的人,作一個完善的解說,首先隨身的東西要有: 證件現金類 : 身份證 健保卡 學生證 現金 提款卡 悠遊卡

直播錄影設備大公開 - 從線下轉線上到底要哪些裝備

直播錄影設備分享 蠻多朋友都在敲碗詢問,到底一場直播需要準備哪些設備,這邊聽筆者娓娓道來, 網路 好的網路上天堂,壞的網路會讓你掉落到不知道什麼地方。 會建議大家至少是一個獨立的 4G 訊號,意味著當下至少要有 30MB/s 的上傳下載,這樣在透過 Google Meet / Zoom 視訊會議的時候是比較不會卡頓的狀態。 Google Meet 輔助文件 有提到關於頻寬的最低需求, 對位於 8.8.8.8. 的 Google 公用 DNS 伺服器執行連線偵測 (ping) 測試時,延遲時間應低於 50 毫秒。 參與者的上傳訊號 (無論通訊人數多寡) 應符合 3.2 mbps 的頻寬需求。 抓在這樣的標準之上會是比較穩定的, 如果你的需求是要透過 OBS 同時播出到 youtube live / Facebook live 和多個頻道的時候,會建議需要更高頻寬,最好是連接有線網路的狀況下尤佳。 總之,網路越快越好,直接光纖肯定沒錯!(可惜我家無法 …T_T 麥克風 直接說答案,這邊採用的是   Rode Wireless go 購買網址: https://24h.pchome.com.tw/prod/DGCF07-A900B6O2U 沒有考慮類似圓剛 av310 或者 BlueYite 之類的,主要是因為可能當初規劃會有起身轉場可能,且可以支援一對多的方式進行訪談式收音。 但很可惜的是,沒有朋友!(威 Rode Wireless go 的優勢在於內建獨立麥克風,可直接夾在領夾上,或者連接更好的收音麥克風,當作訊號源來處理,可變化性蠻大的,但對於聲音細緻度,可能就沒辦法要求到這麼多,總之是不同面向考量下的選擇。 燈光 首先燈光會比攝影機要重要許多許多許多,一個好的麥克風,加上好的燈光,基本上背景只要稍微設置一下,就可以美美搭。 6 寸桌上型 LED 網美燈 購買網址: https://24h.pchome.com.tw/prod/DGCF2O-A900AFG98?fq=/S/DGCF2O 道蝦皮找應該可以找到許多更便宜的,以目前來說 6 寸網美 LED 環形燈來說算是堪用,為什麼會說堪用,如果場景允許,實際上再加上左右補光會讓畫面呈現效果更佳。 目前上述的需求,都是以大頭照拍攝,或者半身的需求為主。 如果說要拍到全身的話,基本上就是直上攝影用補光燈,這就不在此範圍內

[教學] 快快樂樂刪除CodeIgniter index.php

預設的CI網址預設都設定為index.php同一層級,因此所有的程式都必須指定index.php導向才能開始,例如 http://localhost/ci/index.php/welcome/test http://localhost/ci/welcome/test 本文將說明如何將惱人的index.php消除,還你一個漂亮的URL。 設定開始: 接下來說明如何使用rewrite方式將惱人的index.php去除。 rewrite不清楚的人,煩請先自行google 首先要先確定Apache的 mod_rewrite 有 開啟 ,如果沒有開啟請設定好之後重新啟動apache。 接著,在根目錄底下建立一個新檔案,檔名為 .htaccess ,裡面程式碼如下: <IfModule mod_rewrite.c> RewriteEngine On RewriteBase / RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d RewriteRule ^(.*)$ index.php/$1 [L] </IfModule> 接著到 application/config/config.php ,開啟檔案修改 $config['index_page'] = ""; 注意: /index.php/$1 要根據你目錄,例如 http://localhost/index.php ,網站根目錄為 /ci/index.php 則要寫成 /ci/index.php/$1 接著至CI目錄下,尋找 config\config.php , 修改一下裡面的檔案,修改如下: $config['index_page'] = ""; 存檔後,如此一來大功告成。 參考資料 官方網站說明