測試用例驅動閱讀Express原始碼

張淼發表於2018-03-17
Express原始碼

1.簡介

Expres是基於Node.js平臺，快速、開放、極簡的web開發框架。（Expres中文官網首頁原話）。之所以引用這句話，是因為這句話簡單明瞭的告知了大家，它到底是什麼。基於Node的一個開發框架，目的是給web開發提供了方便。今天我們就用測試用例開發的模式，一步步追蹤Express路由系統原始碼是怎麼實現的。

整體程式碼感知

本次實踐專案，完整目錄結構如下(以下會直接說某個檔案的內容)：

Express
  |--lib
  |   |-express.js（主檔案）
  |   |-application.js（相當於中轉站直接訪問路由資訊）
  |   |-Router（路由，中介軟體）
  |       |-index.js
  |       |-layer.js
  |       |-route.js
  |
  |--test
  |   |-getTest.js
  |   |-routerTest.js
  |   |-middleTest.js
複製程式碼

測試用例一（簡單服務）

var express = require('express');
var app = express();

app.get('/', function (req, res) {
  res.send('Hello World!');
});

var server = app.listen(3000, function () {
  console.log('server started on port 3000');
});
複製程式碼

以上程式碼是Express官網入門的一個最簡單的例項，簡單的搭建了一個服務，並且訪問根目錄的時候，會返回Hello World！我們可以看到app是引用後的express執行得到的一個物件（說明express是一個函式），並且在該物件上有get和listen兩個方法。主檔案express.js，結構如下:

const app = require('./application');
function createApplication(){
   return app;
}
module.exports = createApplication;
複製程式碼

application.js中應該具有一個物件，並且該物件上面有兩個方法.首先有一個存放路由的陣列，預設有一個物件，我定義為兜底物件，就是當輸入的路由資訊並不存在的時候，執行該物件的handler。到此，兩個檔案執行完畢，我們就實現最簡單的服務搭建以及get路由功能。

let router = [
    {
        path:'*',
        method:'*',
        handler(req,res){
            res.end('Not Found');
        }
    }

];
let http = require('http');
const app = {
    get(path,handler){
        router.push({
            method:'get',
            path,
            handler
        });
    },
    listen(){
        const server = http.createServer(function(req,res){
            for(let i=0;i<router.length;i++){
                let {path,method,handler} = router[i];
                if(path == req.url && method == req.method.toLowerCase()){
                    return handler(req,res);
                }
            }
            router[0].handler(req,res);
        });
        server.listen.apply(server,arguments);
    }
}
module.exports  = app;
複製程式碼

測試用例二（路由）

app.get('/',function(req,res,next){
    console.log(1);
    next();
},function(req,res,next){
    console.log(11);
    next();
}).get('/',function(req,res,next){
    console.log(2);
    next();
}).get('/',function(req,res,next){
    console.log(3);
    res.end('ok');
}).get('/',function(err,req,res,next){
    res.end('catch: '+err);
});
app.listen(3000);
複製程式碼

此測試用例，包含的資訊薛薇有點廣泛了，在此用例實現中，我們開啟了express中完整路由的實現之路。下圖為路由系統的實現。

測試用例驅動閱讀Express原始碼
Router是一個大的路由系統，存放在stack陣列中，stack中的每一項稱之為每一個層（layer），每一層中又存放了一個route資訊，同樣的，在每一個route中，也有一個stack，stack中存放的也是一個個的層。外層的Router只是辨別路徑，如果路徑匹配直接進來，內層的route辨別方法，執行相對應的handler。這麼設計是因為，有的時候一個路由有多個請求方法，比如/person,可以get，也可以post,那麼在外層，我們直接匹配路徑就行了，等進入裡面的route再尋找具體的handler。為了方便擴充套件，我們把application.js中返回的物件，定義為一個類，同時引入methods這個包，支援多種請求方式。

methods.forEach(function(method){
    Application.prototype[method] = function(){
       this.lazyrouter();
       this._router[method].apply(this._router,slice.call(arguments));
       return this;
    }
});
複製程式碼

其中this.lazyrouter()即生成router物件，本質就是呼叫router物件裡面的方法。在有請求進來的時候，直接呼叫self._router.handle(req,res,done)，即router的handle方法。在router裡面，引入layer和route。

Router.prototype.route = function(path){
    const route = new Route(path);
    const layer = new Layer(path,route.dispatch.bind(route));
    layer.route = route;
    this.stack.push(layer);
    return route;
}
複製程式碼

path就是請求的路徑，在這一層的layer中比較重要的就是隻匹配路徑，具體執行就交給了route物件的dispatch方法。router中的handle方法，就是一層層的匹配路徑，如下：

Router.prototype.handle = function(req,res,out){
    let idx=0,self=this;
    let {pathname} = url.parse(req.url,true);
    function next(err){
        if(idx >= self.stack.length){
            return out(err);
        }
        let layer = self.stack[idx++];
        if(layer.match(pathname) && layer.route&&layer.route._handles_method(req.method.toLowerCase())){
            if(err){
                layer.handle_error(err,req,res,next);
            }else{
                layer.handle_request(req,res,next);
            }
        }else{
            next();
        }
    }
    next();
}

複製程式碼

當所有的都未匹配到，就走out，即我們定義的404。 設計很不錯的地方，我覺得在於route的dispatch方法，也是最終執行的方法。

Route.prototype.dispatch = function(req,res,out){
    let idx = 0,self=this;
    function next(err){
        if(err){
            return out(err);
        }
        if(idx >= self.stack.length){
            return out(err);
        }
        let layer = self.stack[idx++];
        if(layer.method == req.method.toLowerCase()){
            layer.handle_request(req,res,next);
        }else{
            next();
        }
    }
    next();
}
複製程式碼

該方法中，不斷執行next，如果執行完了直接走out，此時的next其實代表的就是router種的下一個路由匹配。二者剛好無縫銜接。設計很精妙。

測試用例三（中介軟體）

app.use(function(req,res,next){
    console.log(11111);
    next('wrong');
});
app.get('/',function(req,res,next){
    res.end('1');
});
const person = express.Router();
person.use(function(req,res,next){
    console.log(22222);
    next();
});
person.use('/2',function(req,res,next){
    res.end('2');
});
app.use('/person',person);
app.use(function(err,req,res,next){
    res.end('catch '+err);
});
app.listen(3000,function(){
    console.log('server started at port 3000');
});
複製程式碼

對於中介軟體，其實跟路由資訊是存放於相同的位置的，但是不同的是，中介軟體可以沒有path，這裡又出現了二級路由的概念。即我們可以通過上述程式碼直接訪問/person/2.

proto.use = function(handler){
  let path = '/',router= this._router;
  if(typeof handler != 'function'){
      path = handler;
      handler = arguments[1];
  }
  let layer = new Layer(path,handler);
  layer.route = undefined;
  this.stack.push(layer);
  return this;
}

複製程式碼

跟路由的區別是layer的route是undefined，並且在handle的時候我們需要根據中介軟體的路徑新增或刪除資訊，拼成路徑尋找相應的handler。

  if(!layer.route){
    let removed = layer.path;
    req.url = req.url.slice(0,removed.length);
    if(req.url == ''){
        req.url = '/';
        slashAdded = true;
    }
    layer.handle_request(req,res,next)
}else if(layer.route._handles_method(req.method)){
    layer.handle_request(req,res,next);
}else{
    next(err);
}
複製程式碼

其中的錯誤，也很好處理。在呼叫next的時候，傳入錯誤資訊，檢測到錯誤資訊，就直接跳到含有四個引數的處理函式即可，因為只有錯誤處理中介軟體才有四個引數。

Layer.prototype.handle_error = function (err,req,res,next) {
    if(this.handler.length !=4){
        return next(err);
    }
    this.handler(err,req,res,next);
}
複製程式碼

參考

  1. 從express原始碼中探析其路由機制
  2. express官網

相關文章