這裡有一篇很好的Node.js 介紹文章great nodejs intro ,它將給你一個非常方便的介紹Node.js 和CouchDB,並給出一個實例實現REST 的服務用於執行書籤的CRUD 操作,使用CouchDB 作為資料庫。
本文將介紹在 Mac OS X 下安裝並開始使用 Node.js ,這個過程大概需要 30 分鐘左右的時間,其中我們還將安裝 CouchDB,並實作基於 CouchDB 的 REST API。
本文假設你機器上已經裝有Git,如果還沒有,請參考此文進行安裝。
安裝 node.js 和 npm
最簡單的方法是在node.js 的官網上通過the nodejs download section 頁面並選擇Mac 下的安裝程序,它將在你的機器上安裝Node.js 和npm (node package manager).
安裝成功後你就可以使用 node 和 npm 指令了。
安裝 CouchDB
因為本文需要使用 CouchDB 來儲存對象,因此也需要安裝 CouchDB.
安裝 CouchDB 稍微麻煩一些,因為我們需要下載原始碼然後編譯I,在此之前需要先安裝 Homebrew ,請執行以下命令:
git clone https://github.com/mxcl/homebrew.git cd homebrew/bin brew install autoconf automake libtool brew install couchdb
重要的提示:CouchDB 之前報出一個問題可能會阻止你安裝,要修復這個問題需要手工編輯 ~/couch/homebrew/Library/Formula/couchdb.rb 文件,編輯內容如下:
請注意需要將 url 中的 source 刪除,最終修改結果如下:
如果安裝過程被掛起了,你需要 CTRL-C 終止並執行下面命令重試:
更多關於 Mac OS X 上安裝 CouchDB 的資訊請閱讀 "Installing CouchDB on OSX".
一旦 CouchDB 編譯完成,我們可以手動執行 ./couchdb 來啟動它,你可以在瀏覽器中開啟 http://127.0.0.1:5984/_utils 這個位址以驗證 CouchDB 安裝是否成功。
下載教學
現在所需的軟體都已經安裝完成,我們接下來繼續 Node.js 的介紹實例。
首先我們使用 Git 來取得實例原始碼
git clone https://github.com/indexzero/nodejs-intro.git
建立 CouchDB 資料庫
在開始教學之前我們需要建立一個 CouchDB 資料庫,先確保 CouchDB 已經啟動,然後使用以下指令建立資料庫:
$ curl -X PUT http://127.0.0.1:5984/pinpoint-dev10
{"ok":true}
你可以在瀏覽器中造訪 http://127.0.0.1:5984/_utils 就可以看到新建立的資料庫。
這裡還有一個非常棒的 CouchDB 的指南。
開始教學
node js 實例使用模組化的方式構建,lib 目錄包含很多模組,而伺服器腳本在 bin 目錄下。
例如,我們要啟動 CouchDB 教程,可以在 bin 目錄下執行下面命令:
./server -t 02couchdb -s
其中 -t 參數可讓你指定要執行的 lib 目錄下的模組,-s 參數用以設定我們剛建立的 pinpoint-dev 資料庫。
sys - util 變化
根據 Node.js 的版本不同,你可能會看到如下的錯誤或是警告:
為了避免這個問題,你需要將所有呼叫 `require("sys")` 替換成 `require("util")`
Node v0.6.14 不會拋出錯誤訊息,但會提示警告:
運行教學
當你執行某個教學時,會提示一些錯誤:
该教程包含很多依赖,我们需要使用 npm 来下载这些依赖的包。
安装 node 包
Node packages (dependencies) 可通过 npm 命令来安装,例如:
$ npm install optimist npm http GET https://registry.npmjs.org/optimist npm http 200 https://registry.npmjs.org/optimist npm http GET https://registry.npmjs.org/optimist/-/optimist-0.2.8.tgz npm http 200 https://registry.npmjs.org/optimist/-/optimist-0.2.8.tgz npm http GET https://registry.npmjs.org/wordwrap npm http 200 https://registry.npmjs.org/wordwrap npm http GET https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.2.tgz npm http 200 https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.2.tgz optimist@0.2.8 ../node_modules/optimist └── wordwrap@0.0.2
这些包将被安装到 node_modules 文件夹中:
$ ls -l ../node_modules/ total 0 drwxr-xr-x 10 ddewaele staff 340 Apr 1 18:54 optimist
本文需要安装如下的 node 包:
npm install winston npm install cradle npm install journey npm install optimist
运行教程
进入 bin 目录,通过下面命令来运行教程:
$ ./server -t 02couchdb -s The "sys" module is now called "util". It should have a similar interface. Pinpoint demo server listening for 02couchdb on http://127.0.0.1:8000
然后打开浏览器访问 http://127.0.0.1:8000/bookmarks ,将会看到如下的结果:
这表示服务已经启动并运行,为了在 CouchDB 中添加点测试数据,我们可以使用 http-console 控制台来访问 CouchDB 的 REST 服务。
安装 http-console
有一个非常棒的工具可以帮助你调试服务,该工具名为 http-console ,你可使用 npm 来安装:
sudo npm install -g http-console
然后就可以在命令行中执行该工具,不幸的是当我们执行该命令时报错了:
$ http-console node.js:201 throw e; // process.nextTick error, or 'error' event on first tick ^ Error: require.paths is removed. Use node_modules folders, or the NODE_PATH environment variable instead. at Function. (module.js:378:11) at Object. (/usr/local/lib/node_modules/http-console/bin/http-console:6:8) at Module._compile (module.js:441:26) at Object..js (module.js:459:10) at Module.load (module.js:348:31) at Function._load (module.js:308:12) at Array.0 (module.js:479:10) at EventEmitter._tickCallback (node.js:192:40)
很麻烦,我们还需要手工编辑 /usr/local/lib/node_modules/http-console/bin/http-console 文件,然后删除下面这一行:
现在 http-console 就可以启动了,无需任何参数,它将连接到 http://localhost:8080 ,如果你需要指定服务器和端口,把它作为第一个参数传递给 http-console 即可。
请注意我们这里使用了 \json 命令用来设置正确的 content-type:
$ http-console http://127.0.0.1:8000 The "sys" module is now called "util". It should have a similar interface. > http-console 0.6.1 > Welcome, enter .help if you're lost. > Connecting to 127.0.0.1 on port 8000. http://127.0.0.1:8000/> \json http://127.0.0.1:8000/>
在 http-console 中,要执行 GET 请求只需要输入 GET /bookmarks 即可:
http://127.0.0.1:8000/> GET /bookmarks HTTP/1.1 200 OK Date: Sun, 01 Apr 2012 17:23:27 GMT Server: journey/0.4.0 Content-Type: application/json;charset=utf-8 Content-Length: 16 Connection: keep-alive { bookmarks: [] }
你也可以使用 JSON 的片段来执行 POST 请求:
http://127.0.0.1:8000/> POST /bookmarks ... { "url": "http://nodejs.org" } HTTP/1.1 200 OK Date: Thu, 05 Apr 2012 11:45:55 GMT Server: journey/0.4.0 Content-Type: application/json;charset=utf-8 Content-Length: 91 Connection: keep-alive { bookmark: { _id: 'WD-G-1', resource: 'Bookmark', url: 'http://nodejs.org' } }
然后再次执行 GET 请求,你就可以看到新插入的数据了:
http://127.0.0.1:8000/> GET /bookmarks HTTP/1.1 200 OK Date: Sun, 01 Apr 2012 17:23:27 GMT Server: journey/0.4.0 Content-Type: application/json;charset=utf-8 Content-Length: 16 Connection: keep-alive { bookmarks: [ { _rev: '1-cfced13a45a068e95daa04beff562360', _id: 'WD-G-1', resource: 'Bookmark', url: 'http://nodejs.org' } ] }