用C/C 實作 Node.js 的模組（一）_node.js

　N久之前的一個坑－用 Node.js 來重建 NBUT 的 Online Judge，包括評測端也要重構一遍。 （至於何時完成大家就不要關心了，(／‵Д′)／~ ╧╧

　　總之我們現在要做的其實簡而言之就是－用C/C 來實作 Node.js 的模組。

準備工作

　　工欲善其事，必先~~耍流氓~~利其器。

node-gyp

　　首先你需要一個 node-gyp 模組。

　　在任何角落，執行：

複製程式碼 程式碼如下:

$ npm install node-gyp -g

 　　在進行一系列的 blahblah 之後，你就安裝好了。

Python

　　然後你需要有個 python 環境。

　　自己去官網搞一個來。

注意： 根據 node-gyp 的GitHub顯示，請務必確保你的 python 版本介於 2.5.0 和 3.0.0 之間。
 
編譯環境

　　嘛嘛，我就偷懶點不細寫了，還請自己移步到 node-gyp 去看編譯器的需求。並且倒騰好。

入門

　　我就拿官網的入門 Hello World說事兒了。

Hello World

　　請準備一個 C 文件，例如就叫 ~~sb.cc~~ hello.cc。

　　然後我們一步步來，先往裡面搞出頭文件和定義好命名空間：

複製程式碼 程式碼如下:

#include
#include
using namespace v8;

 主要函數

　　接下去我們寫一個函數，其回傳值是 Handle。

複製程式碼 程式碼如下:

Handle Hello(const Arguments& args)
{
    //... 嗷嗷待寫
}

 　　然後我來粗粗解析一下這些東西：

Handle

　　做人要有節操，我事先申明我是從這裡(@fool)參考的。

V8 裡使用Handle 類型來託管JavaScript 對象，與C 的std::sharedpointer 類似，Handle 類型間的賦值都是直接傳遞對象引用，但不同的是，V8 使用自己的GC 來管理對像生命週期，而不是智能指標常用的引用計數。

JavaScript 類型在 C 中都有對應的自訂類型，如 String 、 Integer 、 Object 、 Date 、 Array 等，嚴格遵守在 JavaScript 中的繼承關係。 C 中使用這些類型時，必須使用 Handle 託管，以使用 GC 來管理它們的生命週期，而不使用原生堆疊和堆疊。
 
　　而這個所謂的 Value ，從 V8 引擎的頭檔 v8.h 中的各種繼承關係中可以看出來，其實就是 JavaScript 中各種物件的基底類別。

　　在了解了這件事之後，我們大致能明白上面那段函數的申明的意思就是說，我們寫一個 Hello 函數，其返回的是一個不定類型的值。

注意： 我們只能傳回特定的類型，也就是在 Handle 託管下的 String 啊 Integer 啊等等等等。
 
Arguments

　　這個就是傳入這個函數的參數了。我們都知道在 Node.js 中，參數個數是亂來的。而這些參數傳進去到 C 的時候，就轉變成了這個 Arguments 類型的物件了。

　　具體的用法我們在後面再說，在這裡只需要明白這個是個什麼東西就好。 （為毛要賣關子？因為 Node.js 官方文件中的例子就是分開來講的，我現在只是講第一個 Hello World 的例子而已( ´థ౪థ）σ

添磚加瓦

　　接下去我們就開始添磚加瓦了。就最簡單的兩句話：

複製程式碼 程式碼如下:

Handle Hello(const Arguments& args)
{
    HandleScope scope;
    return scope.Close(String::New("world"));
}

 　　這兩句話是什麼意思呢？大致的意思就是回傳一個 Node.js 中的字串 "world"。

HandleScope

　　同參考自這裡。

Handle 的生命週期和 C 智慧指標不同，並不是在 C 語意的 scope 內生存（即{} 包圍的部分），而需要透過 HandleScope 手動指定。 HandleScope 只能分配在堆疊上，HandleScope 物件宣告後，其後建立的 Handle 都由 HandleScope 來管理生命週期，HandleScope 物件析構後，其管理的 Handle 將由 GC 判斷是否回收。
 
　　所以呢，我們得在需要管理他的生命週期的時候申明這個 Scope 。好的，那為什麼我們的程式碼不這麼寫呢？

複製程式碼 程式碼如下:

Handle Hello(const Arguments& args)
{
    HandleScope scope;
    return String::New("world");
}

 　　因為當函數回傳時，scope 會被析構，其管理的Handle也都會被回收，所以這個 String 就會變得沒有意義。

　　所以呢 V8 就想出了個神奇的點子－HandleScope::Close(Handle Value) 函數！這個函數的用處就是關閉這個 Scope 並且把裡面的參數轉交給上一個 Scope 管理，也就是進入這個函數前面的 Scope。

　　於是就有了我們之前的程式碼 scope.Close(String::New("world"));。

String::New

　　這個 String 類別所對應的就是 Node.js 中原生的字串類別。繼承自 Value 類別。與此類似，還有：

 •Array
•Integer
•Boolean
•Object
•Date
•Number
•Function
•...
 
　　這些東西有些是繼承自 Value，有些是二次繼承。我們這裡就不多做研究，自己可以看看 V8 的程式碼（至少是頭檔）研究研究或看看這本手冊。

　　而這個 New 呢？這裡可以看的。就是新建一個 String 物件。

　　至此，這個主要函數我們就解析完畢了。

導出物件

　　我們來溫習一下，如果是在 Node.js 裡面寫的話，我們要怎麼導出函數或物件什麼的呢？

複製程式碼 程式碼如下:

exports.hello = function() {}

 　　那麼，在 C 中我們該如何做到這一步呢？

初始化函數

　　首先，我們寫個初始化函數：

複製程式碼 程式碼如下:

void init(Handle

 　　這是龜腚！函數名稱什麼的無所謂，但是傳入的參數一定是一個 Handle

　　然後，我們就在這裡面寫上導出的東西了：

複製程式碼 程式碼如下:

void init(Handle

 　　大致的意思是說，為這個 exports 物件添加一個字段叫 hello，所對應的東西是一個函數，而這個函數就是我們親愛的 Hello 函數了。

　　用偽代碼寫直白點就是：

複製程式碼 程式碼如下:

void init(Handle

 　　大功告成！

　　（大功告成你妹啊！閉嘴( ‘д‘⊂彡☆))Д´)

真·導出

　　這才是最後一步，我們最後要申明，這個就是導出的入口，所以我們在程式碼的末尾加上這一行：
NODE_MODULE(hello, init)

 　　納了個尼？ ！這又是什麼東西？

　　別著急，這個 NODE_MODULE 是一個宏，它的意思呢就是說我們採用 init 這個初始化函數來把要導出的東西導出到 hello 中。那麼這個 hello 哪來呢？

　　它來自檔案名稱！對，沒錯，它來自檔案名稱。你並不需要事先申明它，你也不必擔心不能用，總之你的這個最終編譯好的二進位檔案名叫什麼，這裡的 hello 你就填什麼，當然要除去後綴名了。

　　詳見官方文件。

Note that all Node addons must export an initialization function:

複製程式碼 程式碼如下:

void Initialize (Handle

 There is no semi-colon after NODE_MODULE as it's not a function (see node.h).

The module_name needs to match the filename of the final binary (minus the .node suffix).
 
編譯 (๑•́ ₃ •̀๑)

　　來吧，讓我們一起編譯吧！

　　我們再新建一個類似 Makefile 的歸檔檔案吧－binding.gyp。

　　並且在裡面加入這樣的程式碼：

複製程式碼 程式碼如下:

{
  "targets": [
    {
      "target_name": "hello",
      "sources": [ "hello.cc" ]
    }
  ]
}

 　　為什麼這麼寫呢？可以參考 node-gyp 的官方文件。

configure

　　在檔案搞好之後，我們要在這個目錄下面執行這個指令了：

複製程式碼 程式碼如下:

$ node-gyp configure

 　　如果一切正常的話，應該會產生一個 build 的目錄，然後裡面有相關文件，也許是 M$ Visual Studio 的 vcxproj 文件等，也許是 Makefile ，視平台而定。

build

　　Makefile 也產生好之後，我們就開始構造編譯了：
$ node-gyp build

 　　等到一切編譯完成，才算是真正的大功告成了！不信你去看看 build/Release 目錄，下面是不是有一個 hello.node 檔案了？沒錯，這是 C 等下要給 Node.js 撿的肥皂！

搞基吧！ Node ヽ(✿ﾟ▽ﾟ)ノ C

　　我們在剛才那個目錄下新建一個檔案 jianfeizao.js：

複製程式碼 程式碼如下:

var addon = require("./build/Release/hello");
console.log(addon.hello());

 　　看到沒！看到沒！出來了出來了！ Node.js 和 C 搞基的結果！這個 addon.hello() 就是我們之前在 C 程式碼中寫的 Handle Hello(const Arguments& args) 了，我們現在就已經把它回傳的值給輸出了。

洗洗睡吧，下節更深入

　　時間不早了，今天就寫到這裡了，至此為止大家都能搞出最基礎的 Hello world 的 C 擴展了吧。下一次寫的應該會更深入一點，至於下一次是什麼時候，我也不知道啦其實。
 　　（餵餵餵，擼主怎麼可以這麼不負責！(ｏﾟﾛﾟ)┌┛Σ(ﾉ´ω`)ﾉ