使用Node.js原生API寫一個Web服務器
Node.js是JavaScript基礎上發展起來的語言,所以前端開發者應該天生就會一點。一般我們會用它來做CLI工具或者Web服務器,做Web服務器也有很多成熟的框架,比如Express和Koa。但是Express和Koa都是對Node.js原生API的封裝,所以其實不借助任何框架,只用原生API我們也能寫一個Web服務器出來。本文要講的就是不借助框架,只用原生API怎么寫一個Web服務器。因為在我的計劃中,后面會寫Express和Koa的源碼解析,他們都是使用原生API來實現的。所以本文其實是這兩個源碼解析的前置知識,可以幫我們更好的理解Express和Koa這種框架的意義和源碼。本文僅為說明原生API的使用方法,代碼較丑,請不要在實際工作中模仿!
本文可運行代碼示例已經上傳GitHub,大家可以拿下來玩玩:https://github.com/dennis-jiang/Front-End-Knowledges/tree/master/Examples/Node.js/HttpServer
Hello World
要搭建一個簡單的Web服務器,使用原生的http模塊就夠了,一個簡單的Hello World程序幾行代碼就夠了:
- const http = require('http')
- const port = 3000
- const server = http.createServer((req, res) => {
- res.statusCode = 200
- res.setHeader('Content-Type', 'text/plain')
- res.end('Hello World')
- })
- server.listen(port, () => {
- console.log(`Server is running on http://127.0.0.1:${port}/`)
- })
這個例子就很簡單,直接用http.createServer創建了一個服務器,這個服務器也沒啥邏輯,只是在訪問的時候返回Hello World。服務器創建后,使用server.listen運行在3000端口就行。
這個例子確實簡單,但是他貌似除了輸出一個Hello World之外,啥也干不了,離我們一般使用的Web服務器還差了很遠,主要是差了這幾塊:
- 不支持HTTP動詞,比如GET,POST等
- 不支持路由
- 沒有靜態資源托管
- 不能持久化數據
前面三點是一個Web服務器必備的基礎功能,第四點是否需要要看情況,畢竟目前很多Node的Web服務器只是作為一個中間層,真正跟數據庫打交道做持久化的還是各種微服務,但是我們也應該知道持久化怎么做。
所以下面我們來寫一個真正能用的Web服務器,也就是說把前面缺的幾點都補上。
處理路由和HTTP動詞
前面我們的那個Hello World也不是完全不能用,因為代碼位置還是得在http.createServer里面,我們就在里面添加路由的功能。為了跟后面的靜態資源做區分,我們的API請求都以/api開頭。要做路由匹配也不難,最簡單的就是直接用if條件判斷就行。為了能拿到請求地址,我們需要使用url模塊來解析傳過來的地址。而Http動詞直接可以用req.method拿到。所以http.createServer改造如下:
- const url = require('url');
- const server = http.createServer((req, res) => {
- // 獲取url的各個部分
- // url.parse可以將req.url解析成一個對象
- // 里面包含有pathname和querystring等
- const urlurlObject = url.parse(req.url);
- const { pathname } = urlObject;
- // api開頭的是API請求
- if (pathname.startsWith('/api')) {
- // 再判斷路由
- if (pathname === '/api/users') {
- // 獲取HTTP動詞
- const method = req.method;
- if (method === 'GET') {
- // 寫一個假數據
- const resData = [
- {
- id: 1,
- name: '小明',
- age: 18
- },
- {
- id: 2,
- name: '小紅',
- age: 19
- }
- ];
- res.setHeader('Content-Type', 'application/json')
- res.end(JSON.stringify(resData));
- return;
- }
- }
- }
- });
現在我們訪問/api/users就可以拿到用戶列表了:
支持靜態文件
上面說了API請求是以/api開頭,也就是說不是以這個開頭的可以認為都是靜態文件,不同文件有不同的Content-Type,我們這個例子里面暫時只支持一種.jpg吧。其實就是給我們的if (pathname.startsWith('/api'))加一個else就行。返回靜態文件需要:
- 使用fs模塊讀取文件。
- 返回文件的時候根據不同的文件類型設置不同的Content-Type。
所以我們這個else就長這個樣子:
- // ... 省略前后代碼 ...
- else {
- // 使用path模塊獲取文件后綴名
- const extName = path.extname(pathname);
- if (extName === '.jpg') {
- // 使用fs模塊讀取文件
- fs.readFile(pathname, (err, data) => {
- res.setHeader('Content-Type', 'image/jpeg');
- res.write(data);
- res.end();
- })
- }
- }
然后我們在同級目錄下放一個圖片試一下:
數據持久化
數據持久化的方式有好幾種,一般都是存數據庫,少數情況下也有存文件的。存數據庫比較麻煩,還需要創建和連接數據庫,我們這里不好demo,我們這里演示一個存文件的例子。一般POST請求是用來存新數據的,我們在前面的基礎上再添加一個POST /api/users來新增一條數據,只需要在前面的if (method === 'GET')后面加一個POST的判斷就行:
- // ... 省略其他代碼 ...
- else if (method === 'POST') {
- // 注意數據傳過來可能有多個chunk
- // 我們需要拼接這些chunk
- let postData = '';
- req.on('data', chunk => {
- postDatapostData = postData + chunk;
- })
- req.on('end', () => {
- // 數據傳完后往db.txt插入內容
- fs.appendFile(path.join(__dirname, 'db.txt'), postData, () => {
- res.end(postData); // 數據寫完后將數據再次返回
- });
- })
- }
然后我們測試一下這個API:
再去看看文件里面寫進去沒有:
總結
到這里我們就完成了一個具有基本功能的web服務器,代碼不復雜,但是對于幫我們理解Node web服務器的原理很有幫助。但是上述代碼還有個很大的問題就是:代碼很丑!所有代碼都寫在一堆,而且HTTP動詞和路由匹配全部是使用if條件判斷,如果有幾百個API,再配合十來個動詞,那代碼簡直就是個災難!所以我們應該將路由處理,HTTP動詞,靜態文件,數據持久化這些功能全部抽離出來,讓整個應用變得更優雅,更好擴展。這就是Express和Koa這些框架存在的意義,下一篇文章我們就去Express的源碼看看他是怎么解決這個問題的,點個關注不迷路~