Express路由解析

1.簡(jiǎn)介

Expres是基于Node.js平臺(tái)蕾总,快速、開放粟焊、極簡(jiǎn)的web開發(fā)框架冤狡。(Expres中文官網(wǎng)首頁(yè)原話)。之所以引用這句話项棠,是因?yàn)檫@句話簡(jiǎn)單明了的告知了大家悲雳,它到底是什么∠阕罚基于Node的一個(gè)開發(fā)框架合瓢,目的是給web開發(fā)提供了方便。今天我們就用測(cè)試用例開發(fā)的模式透典,一步步追蹤Express路由系統(tǒng)源碼是怎么實(shí)現(xiàn)的晴楔。

整體代碼感知

本次實(shí)踐項(xiàng)目顿苇,完整目錄結(jié)構(gòu)如下(以下會(huì)直接說某個(gè)文件的內(nèi)容):

Express
  |--lib
  |   |-express.js(主文件)
  |   |-application.js(相當(dāng)于中轉(zhuǎn)站直接訪問路由信息)
  |   |-Router(路由,中間件)
  |       |-index.js
  |       |-layer.js
  |       |-route.js
  |
  |--test
  |   |-getTest.js
  |   |-routerTest.js
  |   |-middleTest.js

測(cè)試用例一(簡(jiǎn)單服務(wù))

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官網(wǎng)入門的一個(gè)最簡(jiǎn)單的實(shí)例税弃,簡(jiǎn)單的搭建了一個(gè)服務(wù)纪岁,并且訪問根目錄的時(shí)候,會(huì)返回Hello World则果!我們可以看到app是引用后的express執(zhí)行得到的一個(gè)對(duì)象(說明express是一個(gè)函數(shù))幔翰,并且在該對(duì)象上有g(shù)et和listen兩個(gè)方法。主文件express.js西壮,結(jié)構(gòu)如下:

const app = require('./application');
function createApplication(){
   return app;
}
module.exports = createApplication;

application.js中應(yīng)該具有一個(gè)對(duì)象遗增,并且該對(duì)象上面有兩個(gè)方法.首先有一個(gè)存放路由的數(shù)組,默認(rèn)有一個(gè)對(duì)象款青,我定義為兜底對(duì)象做修,就是當(dāng)輸入的路由信息并不存在的時(shí)候,執(zhí)行該對(duì)象的handler抡草。到此缓待,兩個(gè)文件執(zhí)行完畢,我們就實(shí)現(xiàn)最簡(jiǎn)單的服務(wù)搭建以及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;

測(cè)試用例二(路由)

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);

此測(cè)試用例,包含的信息薛薇有點(diǎn)廣泛了步悠,在此用例實(shí)現(xiàn)中签杈,我們開啟了express中完整路由的實(shí)現(xiàn)之路。下圖為路由系統(tǒng)的實(shí)現(xiàn)鼎兽。

1111.jpg

Router是一個(gè)大的路由系統(tǒng)答姥,存放在stack數(shù)組中,stack中的每一項(xiàng)稱之為每一個(gè)層(layer)谚咬,每一層中又存放了一個(gè)route信息鹦付,同樣的,在每一個(gè)route中择卦,也有一個(gè)stack敲长,stack中存放的也是一個(gè)個(gè)的層。外層的Router只是辨別路徑秉继,如果路徑匹配直接進(jìn)來祈噪,內(nèi)層的route辨別方法,執(zhí)行相對(duì)應(yīng)的handler尚辑。這么設(shè)計(jì)是因?yàn)榧穑械臅r(shí)候一個(gè)路由有多個(gè)請(qǐng)求方法,比如/person,可以get杠茬,也可以post,那么在外層月褥,我們直接匹配路徑就行了弛随,等進(jìn)入里面的route再尋找具體的handler。為了方便擴(kuò)展宁赤,我們把a(bǔ)pplication.js中返回的對(duì)象舀透,定義為一個(gè)類,同時(shí)引入methods這個(gè)包礁击,支持多種請(qǐng)求方式盐杂。

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

其中this.lazyrouter()即生成router對(duì)象,本質(zhì)就是調(diào)用router對(duì)象里面的方法哆窿。在有請(qǐng)求進(jìn)來的時(shí)候链烈,直接調(diào)用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就是請(qǐng)求的路徑码荔,在這一層的layer中比較重要的就是只匹配路徑漩勤,具體執(zhí)行就交給了route對(duì)象的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();
}

當(dāng)所有的都未匹配到,就走out硼瓣,即我們定義的404究飞。
設(shè)計(jì)很不錯(cuò)的地方,我覺得在于route的dispatch方法堂鲤,也是最終執(zhí)行的方法亿傅。

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();
}

該方法中,不斷執(zhí)行next瘟栖,如果執(zhí)行完了直接走out葵擎,此時(shí)的next其實(shí)代表的就是router種的下一個(gè)路由匹配。二者剛好無縫銜接半哟。設(shè)計(jì)很精妙酬滤。

測(cè)試用例三(中間件)

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');
});

對(duì)于中間件,其實(shí)跟路由信息是存放于相同的位置的镜沽,但是不同的是敏晤,中間件可以沒有path,這里又出現(xiàn)了二級(jí)路由的概念缅茉。即我們可以通過上述代碼直接訪問/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;
}

跟路由的區(qū)別是layer的route是undefined嘴脾,并且在handle的時(shí)候我們需要根據(jù)中間件的路徑添加或刪除信息,拼成路徑尋找相應(yīng)的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);
}

其中的錯(cuò)誤译打,也很好處理耗拓。在調(diào)用next的時(shí)候,傳入錯(cuò)誤信息奏司,檢測(cè)到錯(cuò)誤信息乔询,就直接跳到含有四個(gè)參數(shù)的處理函數(shù)即可,因?yàn)橹挥绣e(cuò)誤處理中間件才有四個(gè)參數(shù)韵洋。

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源碼中探析其路由機(jī)制
  2. express官網(wǎng)
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末竿刁,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子搪缨,更是在濱河造成了極大的恐慌食拜,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,265評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件副编,死亡現(xiàn)場(chǎng)離奇詭異负甸,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)痹届,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,078評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門呻待,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人队腐,你說我怎么就攤上這事蚕捉。” “怎么了柴淘?”我有些...
    開封第一講書人閱讀 156,852評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵鱼冀,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我悠就,道長(zhǎng),這世上最難降的妖魔是什么充易? 我笑而不...
    開封第一講書人閱讀 56,408評(píng)論 1 283
  • 正文 為了忘掉前任梗脾,我火速辦了婚禮,結(jié)果婚禮上盹靴,老公的妹妹穿的比我還像新娘炸茧。我一直安慰自己,他們只是感情好稿静,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,445評(píng)論 5 384
  • 文/花漫 我一把揭開白布梭冠。 她就那樣靜靜地躺著,像睡著了一般改备。 火紅的嫁衣襯著肌膚如雪控漠。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,772評(píng)論 1 290
  • 那天,我揣著相機(jī)與錄音盐捷,去河邊找鬼偶翅。 笑死,一個(gè)胖子當(dāng)著我的面吹牛碉渡,可吹牛的內(nèi)容都是我干的聚谁。 我是一名探鬼主播,決...
    沈念sama閱讀 38,921評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼滞诺,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼形导!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起习霹,我...
    開封第一講書人閱讀 37,688評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤朵耕,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后序愚,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體憔披,經(jīng)...
    沈念sama閱讀 44,130評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,467評(píng)論 2 325
  • 正文 我和宋清朗相戀三年爸吮,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了芬膝。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,617評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡形娇,死狀恐怖锰霜,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情桐早,我是刑警寧澤癣缅,帶...
    沈念sama閱讀 34,276評(píng)論 4 329
  • 正文 年R本政府宣布,位于F島的核電站哄酝,受9級(jí)特大地震影響友存,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜陶衅,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,882評(píng)論 3 312
  • 文/蒙蒙 一屡立、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧搀军,春花似錦膨俐、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,740評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至门烂,卻和暖如春乳愉,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,967評(píng)論 1 265
  • 我被黑心中介騙來泰國(guó)打工匾委, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留拖叙,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,315評(píng)論 2 360
  • 正文 我出身青樓赂乐,卻偏偏與公主長(zhǎng)得像薯鳍,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子挨措,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,486評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容