概述
Express是目前最流行的基于Node.js的Web开发框架,可以快速地搭建一个完整功能的网站。
Express上手非常简单,首先新建一个项目目录,假定叫做hello-world。
1 mkdir hello-world
进入该目录,新建一个package.json文件,内容如下。
1 { 2 "name": "hello-world", 3 "description": "hello world test app", 4 "version": "0.0.1", 5 "private": true, 6 "dependencies": { 7 "express": "4.x" 8 } 9 }
上面代码定义了项目的名称、描述、版本等,并且指定需要4.0版本以上的Express。
然后,就可以安装了。
1 npm install
执行上面的命令以后,在项目根目录下,新建一个启动文件,假定叫做index.js。
1 var express = require('express'); 2 var app = express(); 3 4 app.use(express.static(__dirname + '/public')); 5 6 app.listen(8080);
然后,运行上面的启动脚本。
1 node index
现在就可以访问http://localhost:8080
,它会在浏览器中打开当前目录的public子目录(严格来说,是打开public目录的index.html文件)。如果public目录之中有一个图片文件my_image.png
,那么可以用http://localhost:8080/my_image.png
访问该文件。
你也可以在index.js之中,生成动态网页。
1 // index.js 2 3 var express = require('express'); 4 var app = express(); 5 app.get('/', function (req, res) { 6 res.send('Hello world!'); 7 }); 8 app.listen(3000);
然后,在命令行下运行启动脚本,就可以在浏览器中访问项目网站了。
1 node index
上面代码会在本机的3000端口启动一个网站,网页显示Hello World。
启动脚本index.js的app.get
方法,用于指定不同的访问路径所对应的回调函数,这叫做“路由”(routing)。上面代码只指定了根目录的回调函数,因此只有一个路由记录。实际应用中,可能有多个路由记录。
1 // index.js 2 3 var express = require('express'); 4 var app = express(); 5 6 app.get('/', function (req, res) { 7 res.send('Hello world!'); 8 }); 9 app.get('/customer', function(req, res){ 10 res.send('customer page'); 11 }); 12 app.get('/admin', function(req, res){ 13 res.send('admin page'); 14 }); 15 16 app.listen(3000);
这时,最好就把路由放到一个单独的文件中,比如新建一个routes子目录。
1 // routes/index.js 2 3 module.exports = function (app) { 4 app.get('/', function (req, res) { 5 res.send('Hello world'); 6 }); 7 app.get('/customer', function(req, res){ 8 res.send('customer page'); 9 }); 10 app.get('/admin', function(req, res){ 11 res.send('admin page'); 12 }); 13 };
然后,原来的index.js就变成下面这样。
1 // index.js 2 var express = require('express'); 3 var app = express(); 4 var routes = require('./routes')(app); 5 app.listen(3000);
运行原理
底层:http模块
Express框架建立在node.js内置的http模块上。http模块生成服务器的原始代码如下。
1 var http = require("http"); 2 3 var app = http.createServer(function(request, response) { 4 response.writeHead(200, {"Content-Type": "text/plain"}); 5 response.end("Hello world!"); 6 }); 7 8 app.listen(3000, "localhost");
上面代码的关键是http模块的createServer方法,表示生成一个HTTP服务器实例。该方法接受一个回调函数,该回调函数的参数,分别为代表HTTP请求和HTTP回应的request对象和response对象。
Express框架的核心是对http模块的再包装。上面的代码用Express改写如下。
1 var express = require('express'); 2 var app = express(); 3 4 app.get('/', function (req, res) { 5 res.send('Hello world!'); 6 }); 7 8 app.listen(3000);
比较两段代码,可以看到它们非常接近。原来是用http.createServer
方法新建一个app实例,现在则是用Express的构造方法,生成一个Epress实例。两者的回调函数都是相同的。Express框架等于在http模块之上,加了一个中间层。
什么是中间件
简单说,中间件(middleware)就是处理HTTP请求的函数。它最大的特点就是,一个中间件处理完,再传递给下一个中间件。App实例在运行过程中,会调用一系列的中间件。
每个中间件可以从App实例,接收三个参数,依次为request对象(代表HTTP请求)、response对象(代表HTTP回应),next回调函数(代表下一个中间件)。每个中间件都可以对HTTP请求(request对象)进行加工,并且决定是否调用next方法,将request对象再传给下一个中间件。
一个不进行任何操作、只传递request对象的中间件,就是下面这样。
1 function uselessMiddleware(req, res, next) { 2 next(); 3 }
上面代码的next就是下一个中间件。如果它带有参数,则代表抛出一个错误,参数为错误文本。
1 function uselessMiddleware(req, res, next) { 2 next('出错了!'); 3 }
抛出错误以后,后面的中间件将不再执行,直到发现一个错误处理函数为止。
use方法
use是express注册中间件的方法,它返回一个函数。下面是一个连续调用两个中间件的例子
1 var express = require("express"); 2 var http = require("http"); 3 4 var app = express(); 5 6 app.use(function(request, response, next) { 7 console.log("In comes a " + request.method + " to " + request.url); 8 next(); 9 }); 10 11 app.use(function(request, response) { 12 response.writeHead(200, { "Content-Type": "text/plain" }); 13 response.end("Hello world! "); 14 }); 15 16 http.createServer(app).listen(1337);
上面代码使用app.use
方法,注册了两个中间件。收到HTTP请求后,先调用第一个中间件,在控制台输出一行信息,然后通过next
方法,将执行权传给第二个中间件,输出HTTP回应。由于第二个中间件没有调用next
方法,所以request对象就不再向后传递了。
use
方法内部可以对访问路径进行判断,据此就能实现简单的路由,根据不同的请求网址,返回不同的网页内容。
1 var express = require("express"); 2 var http = require("http"); 3 4 var app = express(); 5 6 app.use(function(request, response, next) { 7 if (request.url == "/") { 8 response.writeHead(200, { "Content-Type": "text/plain" }); 9 response.end("Welcome to the homepage! "); 10 } else { 11 next(); 12 } 13 }); 14 15 app.use(function(request, response, next) { 16 if (request.url == "/about") { 17 response.writeHead(200, { "Content-Type": "text/plain" }); 18 } else { 19 next(); 20 } 21 }); 22 23 app.use(function(request, response) { 24 response.writeHead(404, { "Content-Type": "text/plain" }); 25 response.end("404 error! "); 26 }); 27 28 http.createServer(app).listen(1337);
上面代码通过request.url
属性,判断请求的网址,从而返回不同的内容。注意,app.use
方法一共登记了三个中间件,只要请求路径匹配,就不会将执行权交给下一个中间件。因此,最后一个中间件会返回404错误,即前面的中间件都没匹配请求路径,找不到所要请求的资源。
除了在回调函数内部判断请求的网址,use方法也允许将请求网址写在第一个参数。这代表,只有请求路径匹配这个参数,后面的中间件才会生效。无疑,这样写更加清晰和方便。
1 app.use('/path', someMiddleware);
上面代码表示,只对根目录的请求,调用某个中间件。
因此,上面的代码可以写成下面的样子。
1 var express = require("express"); 2 var http = require("http"); 3 4 var app = express(); 5 6 app.use("/home", function(request, response, next) { 7 response.writeHead(200, { "Content-Type": "text/plain" }); 8 response.end("Welcome to the homepage! "); 9 }); 10 11 app.use("/about", function(request, response, next) { 12 response.writeHead(200, { "Content-Type": "text/plain" }); 13 response.end("Welcome to the about page! "); 14 }); 15 16 app.use(function(request, response) { 17 response.writeHead(404, { "Content-Type": "text/plain" }); 18 response.end("404 error! "); 19 }); 20 21 http.createServer(app).listen(1337);
Express的方法
all方法和HTTP动词方法
针对不同的请求,Express提供了use方法的一些别名。比如,上面代码也可以用别名的形式来写
1 var express = require("express"); 2 var http = require("http"); 3 var app = express(); 4 5 app.all("*", function(request, response, next) { 6 response.writeHead(200, { "Content-Type": "text/plain" }); 7 next(); 8 }); 9 10 app.get("/", function(request, response) { 11 response.end("Welcome to the homepage!"); 12 }); 13 14 app.get("/about", function(request, response) { 15 response.end("Welcome to the about page!"); 16 }); 17 18 app.get("*", function(request, response) { 19 response.end("404!"); 20 }); 21 22 http.createServer(app).listen(1337);
上面代码的all方法表示,所有请求都必须通过该中间件,参数中的“*”表示对所有路径有效。get方法则是只有GET动词的HTTP请求通过该中间件,它的第一个参数是请求的路径。由于get方法的回调函数没有调用next方法,所以只要有一个中间件被调用了,后面的中间件就不会再被调用了。
除了get方法以外,Express还提供post、put、delete方法,即HTTP动词都是Express的方法。
这些方法的第一个参数,都是请求的路径。除了绝对匹配以外,Express允许模式匹配。
1 app.get("/hello/:who", function(req, res) { 2 res.end("Hello, " + req.params.who + "."); 3 });
上面代码将匹配“/hello/alice”网址,网址中的alice(名字)将被捕获,作为req.params.who属性的值。需要注意的是,捕获后需要对网址进行检查,过滤不安全字符,上面的写法只是为了演示,生产中不应这样直接使用用户提供的值。
如果在模式参数后面加上问号,表示该参数可选。
1 app.get('/hello/:who?',function(req,res) { 2 if(req.params.id) { 3 res.end("Hello, " + req.params.who + "."); 4 } 5 else { 6 res.send("Hello, Guest."); 7 } 8 });
set方法
set方法用于指定变量的值。
1 app.set("views", __dirname + "/views"); 2 3 app.set("view engine", "jade");
上面代码使用set方法,为系统变量“views”和“view engine”指定值。
response对象
response.redirect方法
response.redirect方法允许网址的重定向。
1 response.redirect("/hello/anime"); 2 response.redirect("http://www.example.com"); 3 response.redirect(301, "http://www.example.com");
response.sendFile方法
response.sendFile方法用于发送文件
1 response.sendFile("/path/to/anime.mp4");
response.render方法
response.render方法用于渲染网页模板。
1 app.get("/", function(request, response) { 2 response.render("index", { message: "Hello World" }); 3 });
上面代码使用render方法,将message变量传入index模板,渲染成HTML网页。
requst对象
request.ip
request.ip属性用于获得HTTP请求的IP地址。
request.filesre
quest.files用于获取上传的文件。
搭建HTTPs服务器
使用Express搭建HTTPs加密服务器
1 var fs = require('fs'); 2 var options = { 3 key: fs.readFileSync('E:/ssl/myserver.key'), 4 cert: fs.readFileSync('E:/ssl/myserver.crt'), 5 passphrase: '1234' 6 }; 7 8 var https = require('https'); 9 var express = require('express'); 10 var app = express(); 11 12 app.get('/', function(req, res){ 13 res.send('Hello World Expressjs'); 14 }); 15 16 var server = https.createServer(options, app); 17 server.listen(8084); 18 console.log('Server is running on port 8084');
参考链接
- Raymond Camden, Introduction to Express
- Christopher Buecheler, Getting Started With Node.js, Express, MongoDB
- Stephen Sugden, A short guide to Connect Middleware
- Evan Hahn, Understanding Express.js
- Chris Sevilleja, Learn to Use the New Router in ExpressJS 4.0
- Stefan Fidanov, Limitless file uploading to Amazon S3 with Node & Express