說說 nginx 剛發布的 JavaScript 能力 nginScript

說說 nginx 剛發布的 JavaScript 能力 nginScript

背景

2015年9月，nginx宣布支援類JavaScript語言。這意味著開發人員可以更輕鬆、自由的控制全球最優秀的HTTP及反向 Proxy伺服器，並在此之上可以衍生出更多有用、好玩的創意。Nginx也更開發的走向了動態配置化的下一個階段。大家可以點擊查看 官方介紹連結。

先簡單說說nginx

Nginx [engine x]是全球最受歡迎，也是最優秀的web伺服器、反向 Proxy伺服器。通過第三方公司的統計，目前全球至少有23%的伺服器採用了nginx，當然這個數字還在不斷的擴大。目前也是國內BAT首選，所以這也是為什麼我們第一時間關注到它的原因。 Nginx主要可以做以下幾點：

• 1、工作在TCP第七層，可以對HTTP協議的所有內容進行分析和處理。

• 2、支援lua，perl，JavaScript動態語言

• 3、支援第三方外掛程式

再說說nginScript

1、nginScript是JavaScript/ECMAscript的子集。它實現了大部分的JavaScript語言的能力，沒有完全遵從ECMAScript標準，同時拋棄了JavaScript比較難懂的部分。

2、nginScript不是通過V8引擎實現的。而是通過一個更小、能耗更低、更符合nginx應用情境的小虛擬機器VM）來實現。可以理解為nginx為其實現了一套自己的詞法解析。

3、nginScript是跑在nginx的設定檔裡。 比如：nginx.conf檔案裡。所以nginScript可以完成傳統設定檔所能處理的所有事情，同時可以讓組態管理動態化。這也是nginScript出現的最重要的原因。

4、nginScript是以nginx外掛程式的方式存在。 外掛程式名叫：njs 。和其他nginx外掛程式一樣，我們需要重新編譯nginx來完成安裝。

5、nginScript目前是早期研髮狀態。大家可以通過郵件nginx-devel@nginx.org等方式和nginx團隊進行溝通和提出你的訴求。

如何安裝nginScript

這裡直接按照官方給出的步驟來就好：

// 1、下載最新nginx包，地址可見： http://nginx.org/en/download.html wget http://nginx.org/download/nginx-1.9.4.tar.gz //2、 解壓 tar -xzvf nginx-1.9.4.tar.gz //3、通過mercurial擷取nginScript模組，這裡如果沒有安裝mercurial，需要先運行 yum install mercurial hg clone http://hg.nginx.org/njs

//4、編譯nginx，這裡只具體了njs模組，其他需要的模組自己要記得一起裝哦。如果你沒編譯過nginx，有些相依模組需要yum安裝，請自行搜尋。 cd nginx-1.9.4 ./configure --add-module=../njs/nginx --prefix=/usr/local make make install ok，這就安裝完了，我們可以開始玩啦。

具體如何使用nginScript

nginScript的使用主要是在nginx的配置體系裡增加了2個指令。具體指令分別為：

• js_set，設定配置裡的變數值

• js_run ，直接執行配置規則

1、先看看js_set 在nginx.conf裡怎麼啟動並執行。

http {
    js_set $msg"
            var str = 'hello,imweb';
            // JavaScript str;
    ";

    server {
        ...
        location /{
            return 200 $msg;
        }
    }
}


結果：

上面例子裡，可以看出，我們可以通過JS隨意地給nginx設定變數值。而這些變數是可以用在nginx配置的各個地方。比如：proxy_pass,limit_req_zone, and sub_filter。這裡相對之前配置已經大大的提高了靈活性。

2、js_run的運行規則和情境

• js_run是運行在location指令裡，匹配指定location的路徑就會執行對應的JavaScript

• js_run是直接通過JavaScript來產生HTTP返回的內容

下面舉個具體的例子：

location /imwebteam {
    js_run "
        var res;
        res = $r.response;
        res.status = 200;
        res.send('hello,imweb!');
        res.finish();
    ";
}


這個結果和第一個結果是一樣的。這裡就不贅述。

3、處理兩個指令以外，還有個重要的變數$r

通過js_set和js_run可以對HTTP request請求有完整的控制權，控制的方式就是變數$r的使用。 $r裡有什麼可以通過以下簡單例子看到。

http {     js_set $summary "     var a, s, h;      s = 'JS summary\n\n';      s += 'Method: ' + $r.method + '\n';     s += 'HTTP version: ' + $r.httpVersion + '\n';     s += 'Host: ' + $r.headers.host + '\n';     s += 'Remote Address: ' + $r.remoteAddress + '\n';     s += 'URI: ' + $r.uri + '\n';      s += 'Headers:\n';     for (h in $r.headers) {         s += '  header \"' + h + '\" is \"' + $r.headers[h] + '\"\n';     }      s += 'Args:\n';     for (a in $r.args) {         s += '  arg \"' + a + '\" is \"' + $r.args[a] + '\"\n';     }      s;     ";      server {     listen 8000;      location /imwebteam{         return 200 $summary;     } } 

結果

nginScript目前還存在的問題

經過上面的介紹，相信大家對nginScript已經有了基本的認識。那麼我們在看看這個新生兒有哪些問題吧。

• 首先，調試方法弱。目前還是比較原始，通過log的方式來展示，且錯誤記錄檔的詳細程度很不如人意。
• 其次，控制力度弱。目前nginScript的處理力度還僅限於http request的處理和返回response的層面，還無法做到動態處理nginx請求之外的一些內容，比如動態使用者資料或轉寄配置表動態更新等。
• 最後，整體實現弱。整體結構還是比較簡單，js_run和js_set的運行環境是不太一致的，js_set執行ok的程式碼片段在js_run上會出現一些異常。

綜合來說，nginScript還是一個願望和前景很美好的新生兒。需要一定時間打磨和最佳化。也希望大家多多的提供意見和反饋，甚至是提交自己的外掛程式。從而使得它有更好的成長。

對於我們的實踐情境

這個之前和黎小騰君，donald討論過的2個主要情境，realLog系統和nohost2.0系統。 nginScript對這裡兩個情境來講都無疑是很大的好訊息，這裡在規則響應上，在現有的體系下就可以有很靈活的處理方法。 但在使用者配置動態載入方面，我們仍需要通過其他方式來實現，這個部分我們先提issue給到nginxTeam Dev，看下具體情況再和大家進一步討論和同步。