您好,登錄后才能下訂單哦!
零基礎之Node.js搭建API服務器
這篇文章寫給那些Node.js零基礎,但希望自己動手實現服務器API的前端開發者,嘗試幫大家打開一扇門。
HTTP服務器實現原理
HTTP服務器之所以能提供前端使用的API,其實現原理是服務器保持監聽計算機的某個端口(通常是80),等待客戶端請求,當請求到達并經過一系列處理后,服務器發送響應數據給到前端。
平時大家通過Ajax調用API,即是發起一次請求,經過服務器處理后,得到結果,然后再進行前端處理。如今使用高級編程語言,要實現服務器那部分功能已經變得非常簡單,接下來我們了解一下使用Node.js如何實現。
什么是Node.js?它可以做什么?
Node.js是一個JavaScript的運行時(runtime),它提供了大量用JS與操作系統打交道的API,通過這些API,我們可以調用本地程序、讀寫磁盤、監聽端口、發起網絡請求等,這足以開發出一個功能完善的Server。
前期準備
簡單介紹完Node.js,開始寫代碼之前,我們需要安裝Node.js,安裝詳細過程就不說明了,請大家Google或者百度。不同系統安裝過程不一樣,如果是Linux、Mac,會相對順利且遇到問題的可能性較低。
判斷安裝成功與否,windows下,在cmd中執行node -v,Linux、Mac下,在shell中執行node -v,正常輸出版本號說明安裝成功。
tips:
windows如果提示命令未找到,可能是未配置環境變量
實現簡單的Server
Node.js安裝成功,我們找個地方新建目錄my-server作為我們的存放代碼的地方,接下來所有的代碼都在該目錄下。首先,在my-server的目錄下新建文件index.js,用如下代碼實現一個簡單的Server:
// index.js // 通過require獲取兩個node內置模塊 const http = require('http'); const nUrl = require('url'); // '127.0.0.1'表明只有本機可訪問,'0.0.0.0'表示所有人可訪問 const hostname = '127.0.0.1'; const port = 3000; // 通過http.createServer獲取一個server實例 // 其中(req, res) => {},在服務器每次接收到請求時都會被執行 const server = http.createServer((req, res) => { let method = req.method; // 客戶端請求方法 let url = nUrl.parse(req.url); // 將請求url字符串轉換為node的url對象 // 如果客戶端GET請求'/',會執行這個分支里面的邏輯 if (method === 'GET' && url.pathname === '/') { res.statusCode = 200; res.setHeader('Content-Type', 'text/plain'); res.end('Hello World'); return; } // 如果客戶端GET請求'/api/user',會執行這個分支里面的邏輯 if (method === 'GET' && url.pathname === '/api/user') { res.statusCode = 200; res.setHeader('Content-Type', 'application/json'); res.end(JSON.stringify({ code: 0, msg: '', result: { username: 'shasharoman' } })); return; } // 沒有匹配其他分支的話,執行以下邏輯 res.statusCode = 404; res.setHeader('Content-Type', 'text/plain'); res.end('Not Found'); }); // server開始監聽,等待請求到來 server.listen(port, hostname, () => { console.log(`Server running at http://${hostname}:${port}/`); });
文件內容編輯保存后,在my-server目錄下通過命令node index.js啟動服務,然后在瀏覽器中訪問http://127.0.0.1:300/、http://127.0.0.1:300/api/user、http://127.0.0.1:300/xxx觀察不同結果。
這是官方Guides經過小小修改得到的代碼,添加部分注釋以及額外邏輯。主要為了更清晰傳達以下幾個知識點:
往前優化一步
通過上面的代碼,實現了一個簡單Server,但真實場景下我們會這樣去實現嗎?答案是肯定不會,所以我們還需要一步步完善,做以下幾個修改:
代碼不多,一共五個文件:
// config.js exports = module.exports = { hostname: '127.0.0.1', port: '3000' };
// route.js exports = module.exports = [{ method: 'GET', path: '/api/user', impl: 'account.userById' }, { method: 'POST', path: '/api/user', impl: 'account.createUser' }];
// controller/account.js exports.userById = userById; exports.createUser = createUser; function userById(req, res) { res.end('waiting for impl.'); } function createUser(req, res) { res.end('waiting for impl.'); }
// controller/index.js exports.account = require('./account');
// index.js const http = require('http'); const nUrl = require('url'); const config = require('./config'); const controller = require('./controller'); const route = require('./route').map(item => { console.log(`route ${item.method}:${item.path}`); let tuple = item.impl.split('.'); item.impl = controller[tuple[0]][tuple[1]]; return item; }); const server = http.createServer((req, res) => { let method = req.method; let url = nUrl.parse(req.url); let matchRoute = route.find(item => { return item.method === method && item.path === url.pathname; }); if (matchRoute) { matchRoute.impl(req, res); return; } res.statusCode = 404; res.setHeader('Content-Type', 'text/plain'); res.end('Not Found'); }); server.listen(config.port, config.hostname, () => { console.log(`Server running at http://${config.hostname}:${config.port}/`); });
依舊是用node index.js啟動Server,如果要在現有模式下開發一個API,主要就兩步:
做這個程度的優化,只是為了向大家傳達一些比較寬泛的概念,還不是真正用來寫API服務,只是為了大伙練練手。
這個程度還達不到真實場景需求,還需要經過幾輪改造,包括模塊、層、common、lib、query解析,body解析、更靈活的route等一系列事情,限于篇幅,有機會在一一講述。
經過我的描述以及代碼示例,如果大家有興趣學習Node.js,建議多搜搜相關知識,保持關注,然后在逐步去熟悉Node.js流行的Web框架如:Express、Koa等,不過框架只是更高層面的封裝,基礎的概念以及知識還是需要花時間才能掌握。
如果前端想嘗試后端編程,請一定先學習HTTP協議,推薦《HTTP權威指南》從頭到尾認真看一遍。
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,謝謝大家對億速云的支持。如果你想了解更多相關內容請查看下面相關鏈接
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。