请求路由模块journey的源码解读和学习心得(一)
发布于 13 年前 作者 yixuan 6761 次浏览 最后一次编辑是 8 年前

journey由cloudhead编写,模块下载地址<a href=“https://github.com/cloudhead/journey”>https://github.com/cloudhead/journey</a> <br/> <br/>这几天在看别人的一个web service的实现,看到journey这个模块,感觉这个模块挺实用的,就拿过来仔细学习一下。 <br/>这个模块的功能虽然不是很复杂,但却完全按照事件驱动的思想来实现,作为nodejs的学习代码,感觉还是很有帮助的。如果你是在学习事件驱动的设计思想或者对nodejs还不是很熟的话,可以和我一起来了解这个模块。 <br/> <br/>一个使用journey模块的示例程序<a href=“https://github.com/indexzero/nodejs-intro/tree/master/lib/01routing”>https://github.com/indexzero/nodejs-intro/tree/master/lib/01routing</a> <br/> <br/>journey模块是一个主要用来路由请求的模块。通过自定义自己的请求路由规则,可以将发往服务器的请求进行不同的处理。 <br/>路由的功能我们自己也能实现,为什么要使用journey这个模块呢? <br/>这是因为journey封装了许多路由的细节,只暴露一些对设置规则的接口,所以使用journey模块只需要把注意力集中在路由规则上就可以了。其次,journey还提供了过滤器(filter),可以在服务器路由请求前拦截请求进行处理。 <br/> <br/><strong><h2>使用:</h2></strong> <br/>下面先简单介绍一下journey是如何使用的,代码来源为<a href=“https://github.com/indexzero/nodejs-intro/tree/master/lib/03authentication”>https://github.com/indexzero/nodejs-intro/tree/master/lib/03authentication</a> <br/>因为只是简单说明使用方式,我删去了细节实现,留下框架 <br/><pre escaped=“true” lang=“javascript” line=“1”>/* <br/> * service.js: Defines the web service for the Pinpoint module. <br/> * <br/> * © 2011 Charlie Robbins <br/> * MIT LICENSE <br/> * <br/> / <br/> <br/>var journey = require(‘journey’), <br/> <br/>//创建一个新的请求路由 <br/>exports.createRouter = function (resource) { <br/> var router = new (journey.Router)({ <br/> strict: false, <br/> strictUrls: false, <br/> api: ‘basic’, <br/> filter: helpers.auth.basicAuth <br/> }); <br/> <br/>//说明请求上的公共路径 <br/> router.path(//bookmarks/, function () { <br/> <br/>//设置过滤器 <br/> this.filter(function () { <br/> <br/>//把GET请求绑定到相应函数上 <br/> this.get().bind(function (res) {}); <br/> <br/>//满足正则表达式的GET请求绑定在相应函数上 <br/> this.get(//([\w|\d|-|_]+)/).bind(function (res, id) { }); <br/> <br/>//绑定POST请求 <br/> this.post().bind(function (res, bookmark) { }); <br/> <br/>//绑定PUT请求 <br/> this.put(//([\w|\d|-|_]+)/).bind(function (res, id, bookmark) {}); <br/> <br/>//绑定DEL请求 <br/> this.del(//([\w|\d|-|_]+)/).bind(function (res, id) { }); <br/> }); <br/> }); <br/> <br/> return router; <br/>};</pre> <br/>如同上面的代码和注释,journey提供了Router类,只需要实例化Router类并且把各种请求按照代码中的样子和指定函数绑定起来,就可以实现路由的功能了。需要注意的是,Router支持用正则表达式来区分不同的请求,这使得不同请求的处理变得容易。 <br/>代码中的filter就是过滤器,过滤器的设置在创建Router对象时设置(有个filter属性,这个属性对应的就是过滤的方法。这个方法的实现需要满足参数要求) <br/> <br/>这只是创建请求路由对象和设置路由规则,那如何使用这个路由对象呢,如下面代码: <br/><pre escaped=“true” lang=“javascript” line=“1”>exports.createServer = function (port, database) { <br/> router = service.createRouter(resource); <br/> <br/> var server = http.createServer(function (request, response) { <br/> var body = ‘’; <br/> <br/>… <br/> <br/> var emitter = router.handle(request, body, function (route) { <br/> response.writeHead(route.status, route.headers); <br/> response.end(route.body); <br/> }); <br/> <br/>… <br/> <br/> }) <br/> }); <br/> <br/> if (port) { <br/> server.listen(port); <br/> } <br/> <br/> return server; <br/>};</pre> <br/>我们可以看到,代码第9行的router.handle方法,这个方法就是让路由器来处理请求,根据路由规则转发请求的地方。 <br/> <br/><strong><h2>实现:</h2></strong> <br/>知道了如何使用journey模块后,我们将注意力转移到journey是如何实现的。 <br/>下面我们来看一下journey.js中核心的几块代码的实现(journey.js的源代码在本文开始第一行提供了下载地址): <br/><pre escaped=“true” lang=“javascript” line=“1”>journey.Router = function Router(options) { <br/> var that = this; <br/> <br/> this.routes = []; <br/> this.options = mixin({}, journey.options, options || {}); <br/> <br/> if (this.options.extension) { <br/> this.options.extension = this.options.extension.replace(’.’, ‘\.’); <br/> } <br/>}; <br/> <br/>function mixin(target) { <br/> var args = Array.prototype.slice.call(arguments, 1); <br/> <br/> args.forEach(function (a) { <br/> var keys = Object.keys(a); <br/> for (var i = 0; i < keys.length; i++) { <br/> target[keys[i]] = a[keys[i]]; <br/> } <br/> }); <br/> return target; <br/>}</pre> <br/>这段代码的作用是在实例化router时候根据传入的参数为router设置各种属性。 <br/>其中mixin方法就是用来将用户自定义的参数和router的默认参数结合,将原来默认的属性覆盖,并且加上新的属性 <br/> <br/>上面是对某个具体的router对象的属性设置,下面着重介绍的是Router的原型,也就是所有Router最共同的部分也是最核心的部分,所以下面讲的所有方法都是Router原型中定义的方法,用于所有的Router类型的对象。 <br/>先讲设置路由规则的一些重要函数,代码如下: <br/><pre escaped=“true” lang=“javascript” line=“1”>journey.Router.prototype = { <br/> // <br/> // Define the routing table <br/> // <br/> map: function (routes) { <br/> // Calls the function in the context of this instance, <br/> // so it can be used to define routes on this. <br/> routes.call(this, this); <br/> }, <br/> paths: [], <br/> required: [], <br/> <br/> filter: function (/ variable arguments /) { <br/> var args = Array.prototype.slice.call(arguments), <br/> map = (typeof(args[args.length - 1]) === ‘function’) && args.pop(), <br/> filter = args.pop() || this.options.filter; <br/> <br/> this.required.push(filter); <br/> map.call(this, this); <br/> this.required.pop(); <br/> }, <br/> <br/> get: function (pattern, opts) { return this.route(‘GET’, pattern, opts) }, <br/> put: function (pattern, opts) { return this.route(‘PUT’, pattern, opts) }, <br/> post: function (pattern, opts) { return this.route(‘POST’, pattern, opts) }, <br/> del: function (pattern, opts) { return this.route(‘DELETE’, pattern, opts) }, <br/> <br/> route: function (/ variable arguments /) { <br/> if (arguments[0].headers) { throw new(Error)(“Router#route method renamed to ‘handle’”) } <br/> <br/> var that = this, route, <br/> args = Array.prototype.slice.call(arguments).filter(function (a) { return a }), <br/> // Defaults <br/> pattern = this.paths.length ? ‘’ : /./, <br/> ignoreCase = false, <br/> method = journey.Router.methods.slice(0), <br/> constraints = [], <br/> extension = this.options.extension ? ‘(?:’ + this.options.extension + ‘)?’ : ‘’; <br/> <br/> Array.prototype.push.apply(constraints, this.required); <br/> <br/> args.forEach(function (arg) { <br/> if (journey.Router.methods.indexOf(arg) !== -1 || Array.isArray(arg)) { <br/> method = arg; <br/> } else if (typeof(arg) === “string” || arg.exec) { <br/> pattern = arg; <br/> } else { <br/> throw new(Error)(“cannot understand route.”); <br/> } <br/> }); <br/> <br/> if (typeof(pattern) === “string”) { <br/> pattern = escapeRe(pattern); <br/> } else { <br/> // If we’re in a nested path, ‘/i’ doesn’t mean much, <br/> // as we concatinate strings and regexps. <br/> ignoreCase = this.paths.length || pattern.ignoreCase; <br/> pattern = pattern.source; <br/> } <br/> // Trim trailing and duplicate slashes and add ^$ markers <br/> pattern = ‘^’ + this.paths.concat(pattern ? [pattern] : []) <br/> .join(’/’) <br/> .match(/^^?(.*?)$?$/)[1] // Strip ^ and $ <br/> .replace(/^(/|\/)(?!$)/, ‘’) // Strip root / if pattern != ‘/’ <br/> .replace(/(/|\/)+/g, ‘/’) + // Squeeze slashes <br/> extension; <br/> pattern += this.options.strictUrls ? ‘$’ : ‘\/?$’; // Add optional trailing slash if requested <br/> pattern = new(RegExp)(pattern, ignoreCase ? ‘i’ : ‘’); <br/> <br/> this.routes.push(route = { <br/> pattern: pattern, <br/> method: Array.isArray(method) ? method : [method], <br/> constraints: constraints <br/> }); <br/> <br/> return { <br/> bind: function (handler) { <br/> route.handler = handler; <br/> return route; <br/> }, <br/> ensure: function (handler) { <br/> route.constraints.push(handler); <br/> return this; <br/> }, <br/> filter: function (handler) { <br/> return this.ensure(handler || that.options.filter); <br/> } <br/> }; <br/> } <br/> }</pre> <br/>1.第5行的map函数的作用是运行路由规则函数(routes),将路由规则设置进路由对象中,值得注意的是第8行的call函数,由于现在是在原型内定义函数,但函数的运行要依托于具体的router对象,所以用call函数将函数routes在this(指向运行时对象)所指对象中运行。将设定路由规则的函数放在指定的对象内运行是map函数唯一的作用。 <br/> <br/>2.filter方法主要是设置router的过滤函数,在第18,19,20行,18行将过滤器压入栈中,然后运行map方法,map方法运行时就会运行下面的route方法,这个方法是用来生成路由规则对象的,在下面会介绍。这里之所以压入过滤器是因为每个路由规则对象里都有一个数组是用来记录限制条件的,压入过滤器后,在设置生成路由规则对象时就能将栈中包括过滤器等限制条件设置到其限制条件数组中(这个栈可以看作是一个由限制条件组成的数组),这样在得到请求时,检查某个路由规则时,能够通过查看限制数组检查请求是否符合限制条件。 <br/> <br/>3.get,put,post,del方法传入正则表达式参数,然后调用route方法来设置路由规则。 <br/> <br/>4.route方法中根据参数定义了一个规则中必须的几个属性,例如40行设置了constraints,61行设置了这个路由规则的符合条件(字符串匹配模式),然后在71行处新建一个路由规则对象,将上述的属性设置给这个对象,然后将这个路由规则对象压到路由对象的路由规则数组中,76行开始的return函数返回了这个规则可以操作的一些方法,比如绑定这个规则到某个处理函数上(bind函数)等等。 <br/> <br/>综上,路由对象的设置主要是设置各个路由规则,而各个路由规则的设置主要是设置其中的限制数组,路由条件等。然后用路由规则对象提供的bind函数绑定这个路由规则对应的处理函数。 <br/> <br/>这篇文章介绍的主要就是journey的使用和源码中如何设置路由规则的部分,由于篇幅过长,将journey.js中如何根据路由规则处理请求的部分放在下一篇文章中介绍。

2 回复

看来我这个水平看这个还真有点困难呢

回到顶部