Node.js Express 框架
Express 簡介
Express 是一個簡潔而靈活的 node.js Web應用框架, 提供了一系列強大特性幫助你建立各種 Web 應用,和豐富的 HTTP 工具。
使用 Express 可以快速地搭建一個完整功能的網站。
Express 框架核心特性:
- 可以設定中介軟體來響應 HTTP 請求。
- 定義了路由表用於執行不同的 HTTP 請求動作。
- 可以通過向模板傳遞引數來動態渲染 HTML 頁面。
安裝 Express
安裝 Express 並將其儲存到依賴列表中:
$ cnpm install express --save
以上命令會將 Express 框架安裝在當前目錄的 node_modules 目錄中, node_modules 目錄下會自動建立 express 目錄。以下幾個重要的模組是需要與 express 框架一起安裝的:
body-parser - node.js 中介軟體,用於處理 JSON, Raw, Text 和 URL 編碼的資料。
cookie-parser - 這就是一個解析Cookie的工具。通過req.cookies可以取到傳過來的cookie,並把它們轉成物件。
multer - node.js 中介軟體,用於處理 enctype="multipart/form-data"(設定表單的MIME編碼)的表單資料。
$ cnpm install body-parser --save
$ cnpm install cookie-parser --save
$ cnpm install multer --save
安裝完後,我們可以檢視下 express 使用的版本號:
$ cnpm list express
/data/www/node
└── express@4.15.2 -> /Users/tianqixin/www/node/node_modules/.4.15.2@express
第一個 Express 框架例項
接下來我們使用 Express 框架來輸出 "Hello World"。
以下例項中我們引入了 express 模組,並在客戶端發起請求後,響應 "Hello World" 字串。
建立 express_demo.js 檔案,程式碼如下所示:
express_demo.js 檔案程式碼:
//express_demo.js 檔案
var express = require('express');
var app = express();
app.get('/', function (req, res) {
res.send('Hello World');
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應用例項,訪問地址為 http://%s:%s", host, port)
})
執行以上程式碼:
$ node express_demo.js
應用例項,訪問地址為 http://0.0.0.0:8081
在瀏覽器中訪問 http://127.0.0.1:8081,結果如下圖所示:
請求和響應
Express 應用使用回撥函式的引數: request 和 response 物件來處理請求和響應的資料。
app.get('/', function (req, res) {
// --
})
request 和 response 物件的具體介紹:
Request 物件 - request 物件表示 HTTP 請求,包含了請求查詢字串,引數,內容,HTTP 頭部等屬性。常見屬性有:
- req.app:當callback為外部檔案時,用req.app訪問express的例項
- req.baseUrl:獲取路由當前安裝的URL路徑
- req.body / req.cookies:獲得「請求主體」/ Cookies
- req.fresh / req.stale:判斷請求是否還「新鮮」
- req.hostname / req.ip:獲取主機名和IP地址
- req.originalUrl:獲取原始請求URL
- req.params:獲取路由的parameters
- req.path:獲取請求路徑
- req.protocol:獲取協議型別
- req.query:獲取URL的查詢引數串
- req.route:獲取當前匹配的路由
- req.subdomains:獲取子域名
- req.accepts():檢查可接受的請求的文件型別
- req.acceptsCharsets / req.acceptsEncodings /
- req.acceptsLanguages:返回指定字符集的第一個可接受字元編碼
- req.get():獲取指定的HTTP請求頭
- req.is():判斷請求頭Content-Type的MIME型別
Response 物件 - response 物件表示 HTTP 響應,即在接收到請求時向客戶端傳送的 HTTP 響應資料。常見屬性有:
- res.app:同req.app一樣
- res.append():追加指定HTTP頭
- res.set()在res.append()後將重置之前設定的頭
- res.cookie(name,value [,option]):設定Cookie
opition: domain / expires / httpOnly / maxAge / path / secure / signed - res.clearCookie():清除Cookie
- res.download():傳送指定路徑的檔案
- res.get():返回指定的HTTP頭
- res.json():傳送JSON響應
- res.jsonp():傳送JSONP響應
- res.location():只設定響應的Location HTTP頭,不設定狀態碼或者close response
- res.redirect():設定響應的Location HTTP頭,並且設定狀態碼302
- res.render(view,[locals],callback):渲染一個view,同時向callback傳遞渲染後的字串,如果在渲染過程中有錯誤發生next(err)將會被自動呼叫。callback將會被傳入一個可能發生的錯誤以及渲染後的頁面,這樣就不會自動輸出了。
- res.send():傳送HTTP響應
- res.sendFile(path [,options] [,fn]):傳送指定路徑的檔案 -會自動根據檔案extension設定Content-Type
- res.set():設定HTTP頭,傳入object可以一次設定多個頭
- res.status():設定HTTP狀態碼
- res.type():設定Content-Type的MIME型別
路由
我們已經瞭解了 HTTP 請求的基本應用,而路由決定了由誰(指定指令碼)去響應客戶端請求。
在HTTP請求中,我們可以通過路由提取出請求的URL以及GET/POST引數。
接下來我們擴充套件 Hello World,新增一些功能來處理更多型別的 HTTP 請求。
建立 express_demo2.js 檔案,程式碼如下所示:
express_demo2.js 檔案程式碼:
var express = require('express');
var app = express();
// 主頁輸出 "Hello World"
app.get('/', function (req, res) {
console.log("主頁 GET 請求");
res.send('Hello GET');
})
// POST 請求
app.post('/', function (req, res) {
console.log("主頁 POST 請求");
res.send('Hello POST');
})
// /del_user 頁面響應
app.get('/del_user', function (req, res) {
console.log("/del_user 響應 DELETE 請求");
res.send('刪除頁面');
})
// /list_user 頁面 GET 請求
app.get('/list_user', function (req, res) {
console.log("/list_user GET 請求");
res.send('使用者列表頁面');
})
// 對頁面 abcd, abxcd, ab123cd, 等響應 GET 請求
app.get('/ab*cd', function(req, res) {
console.log("/ab*cd GET 請求");
res.send('正則匹配');
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應用例項,訪問地址為 http://%s:%s", host, port)
})
執行以上程式碼:
$ node express_demo2.js
應用例項,訪問地址為 http://0.0.0.0:8081
接下來你可以嘗試訪問 http://127.0.0.1:8081 不同的地址,檢視效果。
在瀏覽器中訪問 http://127.0.0.1:8081/list_user,結果如下圖所示:
靜態檔案
Express 提供了內建的中介軟體 express.static 來設定靜態檔案如:圖片, CSS, JavaScript 等。
你可以使用 express.static 中介軟體來設定靜態檔案路徑。例如,如果你將圖片, CSS, JavaScript 檔案放在 public 目錄下,你可以這麼寫:
app.use('/public', express.static('public'));
我們可以到 public/images 目錄下放些圖片,如下所示:
node_modules
server.js
public/
public/images
public/images/logo.png
讓我們再修改下 "Hello World" 應用新增處理靜態檔案的功能。
建立 express_demo3.js 檔案,程式碼如下所示:
express_demo3.js 檔案程式碼:
var express = require('express');
var app = express();
app.use('/public', express.static('public'));
app.get('/', function (req, res) {
res.send('Hello World');
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應用例項,訪問地址為 http://%s:%s", host, port)
})
執行以上程式碼:
$ node express_demo3.js
應用例項,訪問地址為 http://0.0.0.0:8081
執行以上程式碼:
在瀏覽器中訪問 http://127.0.0.1:8081/public/images/logo.png(本例項採用了菜鳥教程的 logo),結果如下圖所示:
GET 方法
以下例項演示了在表單中通過 GET 方法提交兩個引數,我們可以使用 server.js 檔案內的 process_get 路由器來處理輸入:
index.htm 檔案程式碼:
<html>
<body>
<form action="http://127.0.0.1:8081/process_get" method="GET">
First Name: <input type="text" name="first_name"> <br>
Last Name: <input type="text" name="last_name">
<input type="submit" value="Submit">
</form>
</body>
</html>
server.js 檔案程式碼:
var express = require('express');
var app = express();
app.use('/public', express.static('public'));
app.get('/index.htm', function (req, res) {
res.sendFile( __dirname + "/" + "index.htm" );
})
app.get('/process_get', function (req, res) {
// 輸出 JSON 格式
var response = {
"first_name":req.query.first_name,
"last_name":req.query.last_name
};
console.log(response);
res.end(JSON.stringify(response));
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應用例項,訪問地址為 http://%s:%s", host, port)
})
執行以上程式碼:
node server.js
應用例項,訪問地址為 http://0.0.0.0:8081
現在你可以向表單輸入資料,並提交,如下演示:
POST 方法
以下例項演示了在表單中通過 POST 方法提交兩個引數,我們可以使用 server.js 檔案內的 process_post 路由器來處理輸入:
index.htm 檔案程式碼:
<html>
<body>
<form action="http://127.0.0.1:8081/process_post" method="POST">
First Name: <input type="text" name="first_name"> <br>
Last Name: <input type="text" name="last_name">
<input type="submit" value="Submit">
</form>
</body>
</html>
server.js 檔案程式碼:
var express = require('express');
var app = express();
var bodyParser = require('body-parser');
// 建立 application/x-www-form-urlencoded 編碼解析
var urlencodedParser = bodyParser.urlencoded({ extended: false })
app.use('/public', express.static('public'));
app.get('/index.htm', function (req, res) {
res.sendFile( __dirname + "/" + "index.htm" );
})
app.post('/process_post', urlencodedParser, function (req, res) {
// 輸出 JSON 格式
var response = {
"first_name":req.body.first_name,
"last_name":req.body.last_name
};
console.log(response);
res.end(JSON.stringify(response));
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應用例項,訪問地址為 http://%s:%s", host, port)
})
執行以上程式碼:
$ node server.js
應用例項,訪問地址為 http://0.0.0.0:8081
現在你可以向表單輸入資料,並提交,如下演示:
檔案上傳
以下我們建立一個用於上傳檔案的表單,使用 POST 方法,表單 enctype 屬性設定為 multipart/form-data。
index.htm 檔案程式碼:
<html>
<head>
<title>檔案上傳表單</title>
</head>
<body>
<h3>檔案上傳:</h3>
選擇一個檔案上傳: <br />
<form action="/file_upload" method="post" enctype="multipart/form-data">
<input type="file" name="image" size="50" />
<br />
<input type="submit" value="上傳檔案" />
</form>
</body>
</html>
** server.js 檔案程式碼: **
var express = require('express');
var app = express();
var fs = require("fs");
var bodyParser = require('body-parser');
var multer = require('multer');
app.use('/public', express.static('public'));
app.use(bodyParser.urlencoded({ extended: false }));
app.use(multer({ dest: '/tmp/'}).array('image'));
app.get('/index.htm', function (req, res) {
res.sendFile( __dirname + "/" + "index.htm" );
})
app.post('/file_upload', function (req, res) {
console.log(req.files[0]); // 上傳的檔案資訊
var des_file = __dirname + "/" + req.files[0].originalname;
fs.readFile( req.files[0].path, function (err, data) {
fs.writeFile(des_file, data, function (err) {
if( err ){
console.log( err );
}else{
response = {
message:'File uploaded successfully',
filename:req.files[0].originalname
};
}
console.log( response );
res.end( JSON.stringify( response ) );
});
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("應用例項,訪問地址為 http://%s:%s", host, port)
})
執行以上程式碼:
$ node server.js
應用例項,訪問地址為 http://0.0.0.0:8081
瀏覽器訪問 http://127.0.0.1:8081/index.htm,如圖所示:
現在你可以向表單輸入資料,並提交,如下演示:
Cookie 管理
我們可以使用中介軟體向 Node.js 伺服器傳送 cookie 資訊,以下程式碼輸出了客戶端傳送的 cookie 資訊:
express_cookie.js 檔案程式碼:
// express_cookie.js 檔案
var express = require('express')
var cookieParser = require('cookie-parser')
var util = require('util');
var app = express()
app.use(cookieParser())
app.get('/', function(req, res) {
console.log("Cookies: " + util.inspect(req.cookies));
})
app.listen(8081)
執行以上程式碼:
$ node express_cookie.js
現在你可以訪問 http://127.0.0.1:8081 並檢視終端資訊的輸出,如下演示: