詳解Node.js中介軟體是怎樣工作的
什麼是 Express 中介軟體?
- 中介軟體在字面上的意思是你在軟體的一層和另一層中間放置的任何東西。
- Express 中介軟體是在對 Express 伺服器請求的生命週期內所執行的函式。
- 每個中介軟體都可以訪問其被附加到的所有路由的 HTTP 請求和響應。
- 另外,中介軟體可以終止 HTTP 請求,也可以用 next 將其傳遞給另一箇中間件函式。中介軟體的這種“鏈”使你可以對程式碼進行劃分並建立可重用的中介軟體。
編寫 Express 中介軟體的要求
你需要安裝一些東西來建立、使用和測試 Express 中介軟體。首先需要 Node 和npm。為確保已經安裝,可以執行:
npm -v && node -v
你應該看到已安裝的 Node 和 NPM 版本。如果出現錯誤,則需要安裝Node。所有例子都應在 Node ver 8+ 和NPM ver 5+ 下使用。
本文使用了 Express 4.x 版。這很重要,因為從 3.x 版到 4.x 版有重大的更改。
Express中介軟體:基礎
首先我們使用 Express 最基本的內建中介軟體。建立一個新專案並 npm 初始化它…
npm init npm install express --save Create server.js and paste the following code: const express = require('express'); const app = express(); app.get('/',(req,res,next) => { res.send('Welcome Home'); }); app.listen(3000);
中介軟體解決什麼問題?為什麼要用它?
假設你在 web 網路伺服器上正在使用 Node.js和 Express執行Web應用程式。在此應用中,你需要登入的某些頁面。
當 Web 伺服器收到資料請求時,Express 將為你提供一個請求物件,其中包含有關使用者及其所請求資料的資訊。 Express 還使你可以訪問響應物件,可以在Web伺服器響應使用者之前對其進行修改。這些物件通常縮短為req,res。
中介軟體函式是使用相關資訊修改req和res物件的理想場所。例如使用者登入後,你可以從資料庫中獲取其使用者詳細資訊,然後將這些詳細資訊儲存在res.user中。
中介軟體函式是什麼樣的?
async function userMiddleware (req,next) { try { const userData = await getUserData(req.params.id); //see app.get below if(userData) { req.user = userData; next(); } } catch(error) { res.status(500).send(error.message); //replace with proper error handling } }
如果出現錯誤,並且你不想執行其他程式碼,則不要呼叫該函式。請記住在這種情況下要傳送響應,否則客戶端將會等待響應直到超時。
var app = express(); //your normal route Handlers app.get('/user/:id',userMiddleware,userController);
中介軟體鏈
你可以在中介軟體陣列中或著通過使用多個app.use呼叫來連結中介軟體:
app.use(middlewareA); app.use(middlewareB); app.get('/',[middlewareC,middlewareD],handler);
Express 收到請求後,與請求相匹配的每個中介軟體都將會按照初始化的順序執行,直到有終止操程式設計客棧作為止。
因此,如果發生錯誤,則將按順序呼叫所有用於處理錯誤的中介軟體,直到其中一個不再呼叫next()函式呼叫為止。
Express中介軟體的型別
- 路由器級中介軟體,例如:router.use
- 內建中介軟體,例如:express.static,express.json,express.urlencoded
- 錯誤處理中介軟體,例如:app.use(err,req,res,next)
- 第三方中介軟體,例如:bodyparser、cookieparser
- 路由器級中介軟體
- express.Router 使用 express.Router 類建立模組化的、可安裝的路由處理。路由例項是一個完整的中介軟體和路由系統。 你可以用中介軟體進行日誌記錄、身份驗證等操作。如下所示,以記錄使用者的最新活動並解析身份驗證標頭,用它確定當前登入的使用者並將其新增到 Request 物件。該函式在程式每次收到請求時執行。如果有錯誤,它會僅結束響應,而不會呼叫後續的中介軟體或路由處理。
var router = express.Router() Load router-level middleware by using the router.use() and router.METHOD() functions. The following example creates a router as a module,loads a middleware function in it,defines some routes,and mounts the router module on a path in the main app. var express = reqhttp://www.cppcns.comuire(‘express'); var r程式設計客棧outer = express.Router(); // a middleware function with no mount path. This code is executed for every request to the router // logging async function logMiddleware (req,next) { try { console.log(req.user.id,new Date()); next(); } catch() { res.status(500).send(error.message); } } // authentication async function checkAuthentication(req,next) => { // check header or url parameters or post parameters for token const token = req.body.token || req.query.token || req.headers['x-access-token'] || req.headers['authorization']; if (token) { try { // verifies secret req.decoded = await jwt.verify(token,config.secret) let checkUser = await authenticateTokenHelper.getUserDetail(req); // if everything is good,save to request for use in other routes if (checkUser) { req.user = req.decoded next() } else { return res.status(403).json({ message: responseMessage.noAuthorized }) } } catch (err) { return res.status(401).json({ message: responseMessage.invalidToken }) } } else { // if there is no token return res.status(400).json({ message: responseMessage.invalidRequest }) } } router.use(logMiddleware); router.get('/user,checkAuthentication,handler);
內建中介軟體
Express 有以下內建的中介軟體功能:
- express.static提供靜態資源,例如html檔案,影象等。
- express.json負載解析用 JSON 傳入的請求。
- express.urlencoded解析傳入的用 URL 編碼的有效載荷請求。
錯誤處理中介軟體
錯誤處理中介軟體始終採用四個引數(err,req,res,next)。你必須通過提供四個引數來將其標識為錯誤處理中介軟體函式。即使你不需要使用 next 物件,也必須指定。否則 next 物件將被解釋為常規中介軟體,並將會無法處理錯誤。基本簽名如下所示:
app.use(function (err,req,next) { console.error(err.stack) res.status(500).send('Something broke!') })
例1:
app.get('/users',next) => { next(new Error('I am passing you an error!')); }); app.use((err,next) => { console.log(err); if(!res.headersSent){ res.status(500).send(err.message); } });
在這種情況下,管道末端的錯誤處理中介軟體將會處理該錯誤。你可能還會注意到,我檢查了res.headersSent屬性。這只是檢查響應是否已經將標頭髮送到客戶端。如果還沒有,它將向客戶端傳送 HTTP 500 狀態和錯誤訊息。
例2:
你還可以連結錯誤處理中介軟體。通常以不同的方式處理不同型別的錯誤:
app.get('/users,next) => { let err = new Error('I couldn\'t find it.'); err.httpStatusCode = 404; next(err); }); app.get('/user,next) => { let err = new Error('I\'m sorry,you can\'t do that,Dave.'); err.httpStatusCode = 30erKmDNU4; next(err); }); app.use((err,next) => { // handles not found errors if (err.httpStatusCode === 404) { res.status(400).render('NotFound'); } // handles unauthorized errors else if(err.httpStatusCode === 304){ res.status(304).render('Unauthorized'); } // catch all else if (!res.headersSent) { res.status(err.httpStatusCode || 500).render('UnknownError'); } next(err); });
- 在這種情況下,中介軟體檢查是否丟擲了 404(not found)錯誤。如果是,它將渲染 “NotFound” 模板頁面,然後將錯程式設計客棧誤傳遞到中介軟體中的下一項。
- 下一個中介軟體檢查是否丟擲了 304(unauthorized)錯誤。如果是,它將渲染“Unauthorized”頁面,並將錯誤傳遞到管道中的下一個中介軟體。
- 最後,“catch all” 錯誤處理僅記錄錯誤,如果未傳送響應,它將傳送錯誤的 httpStatusCode(如果未提供則傳送 HTTP 500 狀態)並渲染 “UnknownError” 模板。
第三方級別的中介軟體
在某些情況下,我們將向後端新增一些額外的功能。先安裝 Node.js 模組獲取所需的功能,然後在應用級別或路由器級別將其載入到你的應用中。
示例:當 body-parser 處理 Content-Type 請求標頭時,所有中介軟體都將使用解析的正文填充req.body屬性。
const express = require('express'); const bodyParser = require('body-parser'); const app = express(); app.use(bodyParser.urlencoded({extended:false})) app.use(bodyParser.json()) app.post('/save',res)=>{ res.json({ "status":true,"payload":req.body }) } app.listen(3000,res)=>{ console.log('server running on port') })
總結
中介軟體功能是一種非常好的方式,可以對每個請求或針對特定路由的每個請求執行程式碼,並對請求或響應資料採取措施。中介軟體是現代 Web 伺服器的重要組成部分,並且非常有用。
以上就是詳解Node.js中介軟體是怎樣工作的的詳細內容,更多關於Node.js中介軟體的資料請關注我們其它相關文章!