玩转Koa之koa-router原理解析

一、前言

Koa为了保持自身的简洁，并没有捆绑中间件。但是在实际的开发中，我们需要和形形色色的中间件打交道，本文将要分析的是经常用到的路由中间件 -- koa-router。

如果你对Koa的原理还不了解的话，可以先查看Koa原理解析。

二、koa-router概述

koa-router的源码只有两个文件：router.js和layer.js，分别对应Router对象和Layer对象。

Layer对象是对单个路由的管理，其中包含的信息有路由路径(path)、路由请求方法(method)和路由执行函数(middleware)，并且提供路由的验证以及params参数解析的方法。

相比较Layer对象，Router对象则是对所有注册路由的统一处理，并且它的API是面向开发者的。

接下来从以下几个方面全面解析koa-router的实现原理：

三、Layer

Layer对象主要是对单个路由的管理，是整个koa-router中最小的处理单元，后续模块的处理都离不开Layer中的方法，这正是首先介绍Layer的重要原因。

function Layer(path, methods, middleware, opts) { this.opts = opts || {}; // 支持路由别名 this.name = this.opts.name || null; this.methods = []; this.paramNames = []; // 将路由执行函数保存在stack中，支持输入多个处理函数 this.stack = Array.isArray(middleware) ? middleware : [middleware]; methods.forEach(function(method) {  var l = this.methods.push(method.toUpperCase());  // HEAD请求头部信息与GET一致，这里就一起处理了。  if (this.methods[l-1] === 'GET') {   this.methods.unshift('HEAD');  } }, this); // 确保类型正确 this.stack.forEach(function(fn) {  var type = (typeof fn);  if (type !== 'function') {   throw new Error(    methods.toString() + " `" + (this.opts.name || path) +"`: `middleware` "    + "must be a function, not `" + type + "`"   );  } }, this); this.path = path; // 1、根据路由路径生成路由正则表达式 // 2、将params参数信息保存在paramNames数组中 this.regexp = pathToRegExp(path, this.paramNames, this.opts);};

Layer构造函数主要用来初始化路由路径、路由请求方法数组、路由处理函数数组、路由正则表达式以及params参数信息数组，其中主要采用path-to-regexp方法根据路径字符串生成正则表达式，通过该正则表达式，可以实现路由的匹配以及params参数的捕获：

// 验证路由Layer.prototype.match = function (path) { return this.regexp.test(path);}// 捕获params参数Layer.prototype.captures = function (path) { // 后续会提到 对于路由级别中间件 无需捕获params if (this.opts.ignoreCaptures) return []; return path.match(this.regexp).slice(1);}

根据paramNames中的参数信息以及captrues方法，可以获取到当前路由params参数的键值对：