Node 第二彈:Node 服務端應用路由解析
大家好,我是山月。在上篇文章介紹了 HTTP 報文及簡單的服務端框架要素,如如何接受請求參數等。這篇文章介紹另一個常見的主題:路由。
簡單路由
最簡單的路由可使用 req.url 進行路由分發不同的邏輯,代碼如下所示。
但是對于一個非Demo式的頁面,業務邏輯都堆在一起,這顯得太為簡陋。
- const http = require('http')
- const server = http.createServer((req, res) => {
- console.log(req.url)
- let data = ''
- if (req.url === '/') {
- data = 'hello, world'
- res.end(data)
- } else if (req.url === '/json') {
- res.setHeader('Content-Type', 'application/json; charset=utf-8');
- data = JSON.stringify({ username: '山月' })
- res.end(data)
- } else if (req.url === '/input') {
- let body = ''
- req.on('data', chunk => body += chunk)
- req.on('end', () => {
- data = body
- res.end(data)
- })
- }
- })
- server.listen(3000)
復雜路由
作為一個能夠在生產環境使用,較為復雜的路由至少能夠解析以下路由,并為單獨路由配置單獨的業務邏輯處理函數
- Method: app.post('/', handler)
- Param Path: app.post('/users/:userId', handler)
基于正則路由
目前,絕大部分服務端框架的路由都是基于正則進行匹配,如 koa、express 等。另外,前端框架的路由 vue-router 與 react-router 也是基于正則匹配。
而這些框架基于正則匹配的路由,都離不開一個庫: path-to-regexp,它將把一個路由如 /user/:name 轉化為正則表達式。
https://github.com/pillarjs/path-to-regexp
標題:path-to-regexp
它的 API 十分簡單:
- pathToRegexp: 可將路由轉化為正則表達式
- match: 可匹配參數
- const { pathToRegexp, match, parse, compile } = require('path-to-regexp')
- pathToRegexp('/api/users/:userId')
- //=> /^\/api\/users(?:\/([^\/#\?]+?))[\/#\?]?$/i
- const toParams = match('/api/users/:userId')
- toParams('/api/users/10')
- //=> {
- // index: 0
- // params: {userId: "12"}
- // path: "/api/users/12"
- // }
那這些 Node 服務器框架基于正則路由的原理是什么?
- 注冊路由。每一個路由都作為一個 Layer (在 express、koa 中),并使用 path-to-regexp 把路由路徑轉化為正則,作為 Layer 的屬性。
- 匹配路由。當一次請求來臨時,對比路由表中每一條路由,找到匹配正則的多條路由,執行多條路由所對應的業務處理邏輯。
從上可以看出它沒進行一次路由匹配的時間復雜度為: 「O(n) X 正則匹配復雜度」
基于正則路由的一些問題
性能問題先不談,先看一個問題:
「當我們請求 /api/users/10086,有兩條路由可供選擇: /api/users/10086 與 /api/users/:userId,此時將會匹配哪一條路由?」
以下是由 koa/koa-router 書寫, 「由于是正則匹配,此時極易出現路由沖突問題,匹配路由時與順序極為相關。」
- const Koa = require("koa");
- const Router = require("@koa/router");
- const app = new Koa();
- const router = new Router();
- router.get("/api/users/10086", (ctx, next) => {
- console.log(ctx.router);
- ctx.body = {
- userId: 10086,
- direct: true
- };
- });
- router.get("/api/users/:userId", (ctx, next) => {
- console.log(ctx.router);
- ctx.body = {
- userId: ctx.params.userId
- };
- });
基于前綴樹路由 (Trie、Radix Tree、Prefix Tree)
相對于正則匹配路由而言,基于前綴樹匹配更加高效,且無上述路由沖突問題。
- find-my-way
https://github.com/delvedor/find-my-way
標題:find-my-way
- const http = require('http')
- const router = require('find-my-way')()
- const server = http.createServer((req, res) => {
- router.lookup(req, res)
- })
- router.on('GET', '/api', () => {})
- router.on('GET', '/api/users/:id', (req, res) => { res.end('id') })
- router.on('GET', '/api/users/10086', (req, res) => { res.end('10086') })
- router.on('GET', '/api/users-friends', () => {})
- console.log(router.prettyPrint())
- server.listen(3000)
在上述代碼中,將把所有路由路徑構成前綴樹。前綴樹,顧名思義,將會把字符串的公共前綴提取出來。
- └── /api (GET)
- └── /users
- ├── /
- │ ├── 10086 (GET)
- │ └── :id (GET)
- └── -friends (GET)
可以看出,前綴樹路由的匹配時間復雜度明顯小于 O(n),且每次不會有正則路由進行正則匹配的復雜度。這決定了它相比正則路由更高的性能。
Node 中最快的框架 fastify,便是內置了基于前綴樹的路由。
- const fastify = require('fastify')()
- fastify.get('/api/users/10086', async (request, reply) => {
- return { userId: 10086, direct: true }
- })
- fastify.get('/api/users/:id', async (request, reply) => {
- const id = request.params.id
- return { userId: id }
- })
- fastify.listen(3000)
405
在 HTTP 狀態碼中,與路由相關的狀態碼為 404、405,作為一個專業的路由庫,實現一個 405 也是分內之事。
- 301
- 302
- 307
- 308
- 404: Not Found
- 405: Method Not Allowed