Node.js：常用工具路由

Posted 2020-11-04 goloving

一、常用工具util

　　util 是一个Node.js 核心模块，提供常用函数的集合，用于弥补核心javascript 的功能 过于精简的不足。

1、util.inherits

　　util.inherits(constructor, superConstructor)是一个实现对象间原型继承的函数。

　　JavaScript 的面向对象特性是基于原型的，与常见的基于类的不同。JavaScript 没有 提供对象继承的语言级别特性，而是通过原型复制来实现的。在这里我们只介绍util.inherits 的用法，示例如下：

var util = require(‘util‘); 
function Base() { 
    this.name = ‘base‘; 
    this.base = 1991; 
    this.sayHello = function() { 
    console.log(‘Hello ‘ + this.name); 
    }; 
} 
Base.prototype.showName = function() { 
    console.log(this.name);
}; 
function Sub() { 
    this.name = ‘sub‘; 
} 
util.inherits(Sub, Base); 
var objBase = new Base(); 
objBase.showName(); 
objBase.sayHello(); 
console.log(objBase); 
var objSub = new Sub(); 
objSub.showName(); 
//objSub.sayHello(); 
console.log(objSub); 

　　我们定义了一个基础对象Base 和一个继承自Base 的Sub，Base 有三个在构造函数 内定义的属性和一个原型中定义的函数，通过util.inherits 实现继承。

base 
Hello base 
{ name: ‘base‘, base: 1991, sayHello: [Function] } 
sub 
{ name: ‘sub‘ }

　　注意：Sub 仅仅继承了Base 在原型中定义的函数，而构造函数内部创造的 base 属 性和 sayHello 函数都没有被 Sub 继承。同时，在原型中定义的属性不会被console.log 作为对象的属性输出。

　　如果我们去掉 objSub.sayHello(); 这行的注释，将会看到：报错，没有该方法。

node.js:201 
throw e; // process.nextTick error, or ‘error‘ event on first tick 
^ 
TypeError: Object #<Sub> has no method ‘sayHello‘ 
at Object.<anonymous> (/home/byvoid/utilinherits.js:29:8) 
at Module._compile (module.js:441:26) 
at Object..js (module.js:459:10) 
at Module.load (module.js:348:31) 
at Function._load (module.js:308:12) 
at Array.0 (module.js:479:10) 
at EventEmitter._tickCallback (node.js:192:40) 

2、util.inspect

　　util.inspect(object,[showHidden],[depth],[colors])是一个将任意对象转换 为字符串的方法，通常用于调试和错误输出。它至少接受一个参数 object，即要转换的对象。

　　showHidden 是一个可选参数，如果值为 true，将会输出更多隐藏信息。

　　depth 表示最大递归的层数，如果对象很复杂，你可以指定层数以控制输出信息的多 少。如果不指定depth，默认会递归2层，指定为 null 表示将不限递归层数完整遍历对象。

　　如果color 值为 true，输出格式将会以ANSI 颜色编码，通常用于在终端显示更漂亮 的效果。

　　特别要指出的是，util.inspect 并不会简单地直接把对象转换为字符串，即使该对 象定义了toString 方法也不会调用。

var util = require(‘util‘); 
function Person() { 
    this.name = ‘byvoid‘; 
    this.toString = function() { 
    return this.name; 
    }; 
} 
var obj = new Person(); 
console.log(util.inspect(obj)); 
console.log(util.inspect(obj, true)); 

//运行结果是：

Person { name: ‘byvoid‘, toString: [Function] }
Person {
  name: ‘byvoid‘,
  toString: 
   { [Function]
     [length]: 0,
     [name]: ‘‘,
     [arguments]: null,
     [caller]: null,
     [prototype]: { [constructor]: [Circular] } } }

3、util.isArray(object)

　　如果给定的参数 "object" 是一个数组返回true，否则返回false。

4、util.isRegExp(object)

　　如果给定的参数 "object" 是一个正则表达式返回true，否则返回false。

5、util.isDate(object)

　　如果给定的参数 "object" 是一个日期返回true，否则返回false。

6、util.isError(object)

　　如果给定的参数 "object" 是一个错误对象返回true，否则返回false。

var util = require(‘util‘);
util.isError(new Error())// true
util.isError(new TypeError()) // true
util.isError({ name: ‘Error‘, message: ‘an error occurred‘ }) // false

二、路由

　　我们要为路由提供请求的 URL 和其他需要的 GET 及 POST 参数，随后路由需要根据这些数据来执行相应的代码。

　　因此，我们需要查看 HTTP 请求，从中提取出请求的 URL 以及 GET/POST 参数。这一功能应当属于路由还是服务器（甚至作为一个模块自身的功能）确实值得探讨，但这里暂定其为我们的HTTP服务器的功能。

　　我们需要的所有数据都会包含在 request 对象中，该对象作为 onRequest() 回调函数的第一个参数传递。但是为了解析这些数据，我们需要额外的 Node.JS 模块，它们分别是 url 和 querystring 模块。

url.parse(string).query
                                           |
           url.parse(string).pathname      |
                       |                   |
http://localhost:8888/start?foo=bar&hello=world
                                 |          |
              querystring.parse(queryString)["foo"]    |
                                            |
                         querystring.parse(queryString)["hello"]

　　当然我们也可以用 querystring 模块来解析 POST 请求体中的参数。

　　现在我们来给 onRequest() 函数加上一些逻辑，用来找出浏览器请求的 URL 路径：

　　server.js代码：

var http = require("http");
var url = require("url");
 
function start() {
  function onRequest(request, response) {
    var pathname = url.parse(request.url).pathname;
    console.log("Request for " + pathname + " received.");
    response.writeHead(200, {"Content-Type": "text/plain"});
    response.write("Hello World");
    response.end();
  }
 
  http.createServer(onRequest).listen(8888);
  console.log("Server has started.");
}
 
exports.start = start;

　　好了，我们的应用现在可以通过请求的 URL 路径来区别不同请求了，这使我们得以使用路由（还未完成）来将请求以 URL 路径为基准映射到处理程序上。

　　在我们所要构建的应用中，这意味着来自 /start 和 /upload 的请求可以使用不同的代码来处理。稍后我们将看到这些内容是如何整合到一起的。

　　现在我们可以来编写路由了，建立一个名为 router.js 的文件，添加以下内容：

function route(pathname) {
  console.log("About to route a request for " + pathname);
}
exports.route = route;

　　如你所见，这段代码什么也没干，不过对于现在来说这是应该的。在添加更多的逻辑以前，我们先来看看如何把路由和服务器整合起来。

　　我们的服务器应当知道路由的存在并加以有效利用。我们当然可以通过硬编码的方式将这一依赖项绑定到服务器上，但是其它语言的编程经验告诉我们这会是一件非常痛苦的事，因此我们将使用依赖注入的方式较松散地添加路由模块。

　　首先，我们来扩展一下服务器的 start() 函数，以便将路由函数作为参数传递过去，server.js 文件代码如下

var http = require("http");
var url = require("url");
 
function start(route) {
  function onRequest(request, response) {
    var pathname = url.parse(request.url).pathname;
    console.log("Request for " + pathname + " received.");
 
    route(pathname);
 
    response.writeHead(200, {"Content-Type": "text/plain"});
    response.write("Hello World");
    response.end();
  }
 
  http.createServer(onRequest).listen(8888);
  console.log("Server has started.");
}
 
exports.start = start;

　　同时，我们会相应扩展 index.js，使得路由函数可以被注入到服务器中：

var server = require("./server");
var router = require("./router");
 
server.start(router.route);

　　在这里，我们传递的函数依旧什么也没做。

　　如果现在启动应用（node index.js，始终记得这个命令行），随后请求一个URL，你将会看到应用输出相应的信息，这表明我们的HTTP服务器已经在使用路由模块了，并会将请求的路径传递给路由：

$ node index.js
Server has started.