Express框架
来自《JavaScript 标准参考教程(alpha)》,by 阮一峰
目录
概述
Express是目前最流行的基于Node.js的Web开发框架,可以快速地搭建一个完整功能的网站。
Express上手非常简单,首先新建一个项目目录,假定叫做hello-world。
$ mkdir hello-world
进入该目录,新建一个package.json文件,内容如下。
{
"name": "hello-world",
"description": "hello world test app",
"version": "0.0.1",
"private": true,
"dependencies": {
"express": "4.x"
}
}
上面代码定义了项目的名称、描述、版本等,并且指定需要4.0版本以上的Express。
然后,就可以安装了。
$ npm install
执行上面的命令以后,在项目根目录下,新建一个启动文件,假定叫做index.js。
var express = require(\'express\');
var app = express();
app.use(express.static(__dirname + \'/public\'));
app.listen(8080);
然后,运行上面的启动脚本。
$ node index
现在就可以访问http://localhost:8080
,它会在浏览器中打开当前目录的public子目录(严格来说,是打开public目录的index.html文件)。如果public目录之中有一个图片文件my_image.png
,那么可以用http://localhost:8080/my_image.png
访问该文件。
你也可以在index.js之中,生成动态网页。
// index.js
var express = require(\'express\');
var app = express();
app.get(\'/\', function (req, res) {
res.send(\'Hello world!\');
});
app.listen(3000);
然后,在命令行下运行启动脚本,就可以在浏览器中访问项目网站了。
$ node index
上面代码会在本机的3000端口启动一个网站,网页显示Hello World。
启动脚本index.js的app.get
方法,用于指定不同的访问路径所对应的回调函数,这叫做“路由”(routing)。上面代码只指定了根目录的回调函数,因此只有一个路由记录。实际应用中,可能有多个路由记录。
// index.js
var express = require(\'express\');
var app = express();
app.get(\'/\', function (req, res) {
res.send(\'Hello world!\');
});
app.get(\'/customer\', function(req, res){
res.send(\'customer page\');
});
app.get(\'/admin\', function(req, res){
res.send(\'admin page\');
});
app.listen(3000);
这时,最好就把路由放到一个单独的文件中,比如新建一个routes子目录。
// routes/index.js
module.exports = function (app) {
app.get(\'/\', function (req, res) {
res.send(\'Hello world\');
});
app.get(\'/customer\', function(req, res){
res.send(\'customer page\');
});
app.get(\'/admin\', function(req, res){
res.send(\'admin page\');
});
};
然后,原来的index.js就变成下面这样。
// index.js
var express = require(\'express\');
var app = express();
var routes = require(\'./routes\')(app);
app.listen(3000);
运行原理
底层:http模块
Express框架建立在node.js内置的http模块上。http模块生成服务器的原始代码如下。
var http = require("http");
var app = http.createServer(function(request, response) {
response.writeHead(200, {"Content-Type": "text/plain"});
response.end("Hello world!");
});
app.listen(3000, "localhost");
上面代码的关键是http模块的createServer方法,表示生成一个HTTP服务器实例。该方法接受一个回调函数,该回调函数的参数,分别为代表HTTP请求和HTTP回应的request对象和response对象。
Express框架的核心是对http模块的再包装。上面的代码用Express改写如下。
var express = require(\'express\');
var app = express();
app.get(\'/\', function (req, res) {
res.send(\'Hello world!\');
});
app.listen(3000);
比较两段代码,可以看到它们非常接近。原来是用http.createServer
方法新建一个app实例,现在则是用Express的构造方法,生成一个Epress实例。两者的回调函数都是相同的。Express框架等于在http模块之上,加了一个中间层。
什么是中间件
简单说,中间件(middleware)就是处理HTTP请求的函数。它最大的特点就是,一个中间件处理完,再传递给下一个中间件。App实例在运行过程中,会调用一系列的中间件。
每个中间件可以从App实例,接收三个参数,依次为request对象(代表HTTP请求)、response对象(代表HTTP回应),next回调函数(代表下一个中间件)。每个中间件都可以对HTTP请求(request对象)进行加工,并且决定是否调用next方法,将request对象再传给下一个中间件。
一个不进行任何操作、只传递request对象的中间件,就是下面这样。
function uselessMiddleware(req, res, next) {
next();
}
上面代码的next就是下一个中间件。如果它带有参数,则代表抛出一个错误,参数为错误文本。
function uselessMiddleware(req, res, next) {
next(\'出错了!\');
}
抛出错误以后,后面的中间件将不再执行,直到发现一个错误处理函数为止。
use方法
use是express注册中间件的方法,它返回一个函数。下面是一个连续调用两个中间件的例子。
var express = require("express");
var http = require("http");
var app = express();
app.use(function(request, response, next) {
console.log("In comes a " + request.method + " to " + request.url);
next();
});
app.use(function(request, response) {
response.writeHead(200, { "Content-Type": "text/plain" });
response.end("Hello world!\\n");
});
http.createServer(app).listen(1337);
上面代码使用app.use
方法,注册了两个中间件。收到HTTP请求后,先调用第一个中间件,在控制台输出一行信息,然后通过next
方法,将执行权传给第二个中间件,输出HTTP回应。由于第二个中间件没有调用next
方法,所以request对象就不再向后传递了。
use
方法内部可以对访问路径进行判断,据此就能实现简单的路由,根据不同的请求网址,返回不同的网页内容。
var express = require("express");
var http = require("http");
var app = express();
app.use(function(request, response, next) {
if (request.url == "/") {
response.writeHead(200, { "Content-Type": "text/plain" });
response.end("Welcome to the homepage!\\n");
} else {
next();
}
});
app.use(function(request, response, next) {
if (request.url == "/about") {
response.writeHead(200, { "Content-Type": "text/plain" });
} else {
next();
}
});
app.use(function(request, response) {
response.writeHead(404, { "Content-Type": "text/plain" });
response.end("404 error!\\n");
});
http.createServer(app).listen(1337);
上面代码通过request.url
属性,判断请求的网址,从而返回不同的内容。注意,app.use
方法一共登记了三个中间件,只要请求路径匹配,就不会将执行权交给下一个中间件。因此,最后一个中间件会返回404错误,即前面的中间件都没匹配请求路径,找不到所要请求的资源。
除了在回调函数内部判断请求的网址,use方法也允许将请求网址写在第一个参数。这代表,只有请求路径匹配这个参数,后面的中间件才会生效。无疑,这样写更加清晰和方便。
app.use(\'/path\', someMiddleware);
上面代码表示,只对根目录的请求,调用某个中间件。
因此,上面的代码可以写成下面的样子。
var express = require("express");
var http = require("http");
var app = express();
app.use("/home", function(request, response, next) {
response.writeHead(200, { "Content-Type": "text/plain" });
response.end("Welcome to the homepage!\\n");
});
app.use("/about", function(request, response, next) {
response.writeHead(200, { "Content-Type": "text/plain" });
response.end("Welcome to the about page!\\n");
});
app.use(function(request, response) {
response.writeHead(404, { "Content-Type": "text/plain" });
response.end("404 error!\\n");
});
http.createServer(app).listen(1337);
Express的方法
all方法和HTTP动词方法
针对不同的请求,Express提供了use方法的一些别名。比如,上面代码也可以用别名的形式来写。
var express = require("express");
var http = require("http");
var app = express();
app.all("*", function(request, response, next) {
response.writeHead(200, { "Content-Type": "text/plain" });
next();
});
app.get("/", function(request, response) {
response.end("Welcome to the homepage!");
});
app.get("/about", function(request, response) {
response.end("Welcome to the about page!");
});
app.get("*", function(request, response) {
response.end("404!");
});
http.createServer(app).listen(1337);
上面代码的all方法表示,所有请求都必须通过该中间件,参数中的“*”表示对所有路径有效。get方法则是只有GET动词的HTTP请求通过该中间件,它的第一个参数是请求的路径。由于get方法的回调函数没有调用next方法,所以只要有一个中间件被调用了,后面的中间件就不会再被调用了。
除了get方法以外,Express还提供post、put、delete方法,即HTTP动词都是Express的方法。
这些方法的第一个参数,都是请求的路径。除了绝对匹配以外,Express允许模式匹配。
app.get("/hello/:who", function(req, res) {
res.end("Hello, " + req.params.who + ".");
});
上面代码将匹配“/hello/alice”网址,网址中的alice将被捕获,作为req.params.who属性的值。需要注意的是,捕获后需要对网址进行检查,过滤不安全字符,上面的写法只是为了演示,生产中不应这样直接使用用户提供的值。
如果在模式参数后面加上问号,表示该参数可选。
app.get(\'/hello/:who?\',function(req,res) {
if(req.params.id) {
res.end("Hello, " + req.params.who + ".");
}
else {
res.send("Hello, Guest.");
}
});
下面是一些更复杂的模式匹配的例子。
app.get(\'/forum/:fid/thread/:tid\', middleware)
// 匹配/commits/71dbb9c
// 或/commits/71dbb9c..4c084f9这样的git格式的网址
app.get(/^\\/commits\\/(\\w+)(?:\\.\\.(\\w+))?$/, function(req, res){
var from = req.params[0];
var to = req.params[1] || \'HEAD\';
res.send(\'commit range \' + from + \'..\' + to);
});
set方法
set方法用于指定变量的值。
app.set("views", __dirname + "/views");
app.set("view engine", "jade");
上面代码使用set方法,为系统变量“views”和“view engine”指定值。
response对象
(1)response.redirect方法
response.redirect方法允许网址的重定向。
response.redirect("/hello/anime");
response.redirect("http://www.example.com");
response.redirect(301, "http://www.example.com");
(2)response.sendFile方法
response.sendFile方法用于发送文件。
response.sendFile("/path/to/anime.mp4");
(3)response.render方法
response.render方法用于渲染网页模板。
app.get("/", function(request, response) {
response.render("index", { message: "Hello World" });
});
上面代码使用render方法,将message变量传入index模板,渲染成HTML网页。
requst对象
(1)request.ip
request.ip属性用于获得HTTP请求的IP地址。
(2)request.files
request.files用于获取上传的文件。
搭建HTTPs服务器
使用Express搭建HTTPs加密服务器,也很简单。
var fs = require(\'fs\');
var options = {
key: fs.readFileSync(\'E:/ssl/myserver.key\'),
cert: fs.readFileSync(\'E:/ssl/myserver.crt\'),
passphrase: \'1234\'
};
var https = require(\'https\');
var express = require(\'express\');
var app = express();
app.get(\'/\', function(req, res){
res.send(\'Hello World Expressjs\');
});
var server = https.createServer(options, app);
server.listen(8084);
console.log(\'Server is running on port 8084\');
项目开发实例
编写启动脚本
上一节使用express命令自动建立项目,也可以不使用这个命令,手动新建所有文件。
先建立一个项目目录(假定这个目录叫做demo)。进入该目录,新建一个package.json文件,写入项目的配置信息。
{
"name": "demo",
"description": "My First Express App",
"version": "0.0.1",
"dependencies": {
"express": "3.x"
}
}
在项目目录中,新建文件app.js。项目的代码就放在这个文件里面。
var express = require(\'express\');
var app = express();
上面代码首先加载express模块,赋给变量express。然后,生成express实例,赋给变量app。
接着,设定express实例的参数。
// 设定port变量,意为访问端口
app.set(\'port\', process.env.PORT || 3000);
// 设定views变量,意为视图存放的目录
app.set(\'views\', path.join(__dirname, \'views\'));
// 设定view engine变量,意为网页模板引擎
app.set(\'view engine\', \'jade\');
app.use(express.favicon());
app.use(express.logger(\'dev\'));
app.use(express.bodyParser());
app.use(express.methodOverride());
app.use(app.router);
// 设定静态文件目录,比如本地文件
// 目录为demo/public/images,访问
// 网址则显示为http://localhost:3000/images
app.use(express.static(path.join(__dirname, \'public\')));
上面代码中的set方法用于设定内部变量,use方法用于调用express的中间件。
最后,调用实例方法listen,让其监听事先设定的端口(3000)。
app.listen(app.get(\'port\'));
这时,运行下面的命令,就可以在浏览器访问http://127.0.0.1:3000。
node app.js
网页提示“Cannot GET /”,表示没有为网站的根路径指定可以显示的内容。所以,下一步就是配置路由。
配置路由
所谓“路由”,就是指为不同的访问路径,指定不同的处理方法。
(1)指定根路径
在app.js之中,先指定根路径的处理方法。
app.get(\'/\', function(req, res) {
res.send(\'Hello World\');
});
上面代码的get方法,表示处理客户端发出的GET请求。相应的,还有app.post、app.put、app.del(delete是javascript保留字,所以改叫del)方法。
get方法的第一个参数是访问路径,正斜杠(/)就代表根路径;第二个参数是回调函数,它的req参数表示客户端发来的HTTP请求,res参数代表发向客户端的HTTP回应,这两个参数都是对象。在回调函数内部,使用HTTP回应的send方法,表示向浏览器发送一个字符串。然后,运行下面的命令。
node app.js
此时,在浏览器中访问http://127.0.0.1:3000,网页就会显示“Hello World”。
如果需要指定HTTP头信息,回调函数就必须换一种写法,要使用setHeader方法与end方法。
app.get(\'/\', function(req, res){
var body = \'Hello World\';
res.setHeader(\'Content-Type\', \'text/plain\');
res.setHeader(\'Content-Length\', body.length);
res.end(body);
});
(2)指定特定路径
上面是处理根目录的情况,下面再举一个例子。假定用户访问/api路径,希望返回一个JSON字符串。这时,get可以这样写。
app.get(\'/api\', function(request, response) {
response.send({name:"张三",age:40});
});
上面代码表示,除了发送字符串,send方法还可以直接发送对象。重新启动node以后,再访问路径/api,浏览器就会显示一个JSON对象。
{
"name": "张三",
"age": 40
}
我们也可以把app.get的回调函数,封装成模块。先在routes目录下面建立一个api.js文件。
// routes/api.js
exports.index = function (req, res){
res.json(200, {name:"张三",age:40});
}
然后,在app.js中加载这个模块。
// app.js
var api = require(\'./routes/api\');
app.get(\'/api\', api.index);
现在访问时,就会显示与上一次同样的结果。
如果只向浏览器发送简单的文本信息,上面的方法已经够用;但是如果要向浏览器发送复杂的内容,还是应该使用网页模板。
静态网页模板
在项目目录之中,建立一个子目录views,用于存放网页模板。
假定这个项目有三个路径:根路径(/)、自我介绍(/about)和文章(/article)。那么,app.js可以这样写:
var express = require(\'express\');
var app = express();
app.get(\'/\', function(req, res) {
res.sendfile(\'./views/index.html\');
});
app.get(\'/about\', function(req, res) {
res.sendfile(\'./views/about.html\');
});
app.get(\'/article\', function(req, res) {
res.sendfile(\'./views/article.html\');
});
app.listen(3000);
上面代码表示,三个路径分别对应views目录中的三个模板:index.html、about.html和article.html。另外,向服务器发送信息的方法,从send变成了sendfile,后者专门用于发送文件。
假定index.html的内容如下:
<html>
<head>
<title>首页</title>
</head>
<body>
<h1>Express Demo</h1>
<footer>
<p>
<a href="/">首页</a> - <a href="/about">自我介绍</a> - <a href="/article">文章</a>
</p>
</footer>
</body>
</html>
上面代码是一个静态网页。如果想要展示动态内容,就必须使用动态网页模板。
动态网页模板
网站真正的魅力在于动态网页,下面我们来看看,如何制作一个动态网页的网站。
安装模板引擎
Express支持多种模板引擎,这里采用Handlebars模板引擎的服务器端版本hbs模板引擎。
先安装hbs。
npm install hbs --save-dev
上面代码将hbs模块,安装在项目目录的子目录node_modules之中。save-dev参数表示,将依赖关系写入package.json文件。安装以后的package.json文件变成下面这样:
// package.json文件
{
"name": "demo",
"description": "My First Express App",
"version": "0.0.1",
"dependencies": {
"express": "3.x"
},
"devDependencies": {
"hbs": "~2.3.1"
}
}
安装模板引擎之后,就要改写app.js。
// app.js文件
var express = require(\'express\');
var app = express();
// 加载hbs模块
var hbs = require(\'hbs\');
// 指定模板文件的后缀名为html
app.set(\'view engine\', \'html\');
// 运行hbs模块
app.engine(\'html\', hbs.__express);
app.get(\'/\', function (req, res){
res.render(\'index\');
});
app.get(\'/about\', function(req, res) {
res.render(\'about\');
});
app.get(\'/article\', function(req, 以上是关于nodejs的express使用介绍的主要内容,如果未能解决你的问题,请参考以下文章