Express實現路由分發控制、RESTful API
標簽(空格分隔): Node.js
最近在用Express作為自己的WEB應用框架,其中最為迷惑的就是Express的路由控制和分發,在網上搜了很多資料,但是大部分的資料都是將Express的路由控制寫在了app.js入口文件中,但是這樣的寫法寫一些Demo是可以的,但是在實戰項目中基本上不會這樣來寫,因為隨著項目的龐大,在app.js入口文件中的路由控制將會越來越復雜。所以,我們實際項目中一般會將不同的業務邏輯交給不同的模塊開負責。
以下是這幾天摸索出來的一些簡單實現
如果有大神有更好的實現方案或建議,歡迎給予指點
具體實現方式如下
本Demo的目錄結構如下
- node-modules
- api
- user.js
- routes
- index.js
- app.js
- package.json
創建Node.js應用
首先通過cd進入到項目希望放置的目錄,然后執行以下命令
npm init -y
執行完以后,會在目錄中創建一個package.json配置文件,打開該文件,在配置文件中添加項目中所需要的所有依賴。(我個人的搭配是Express+redis數據庫),添加完以后的package.json文件如下
{
"name": "RestfulDocApi",
"version": "1.0.0",
"description": "",
"main": "app.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies":{
"express":"^4.13.4", // express框架
"redis":"^2.5.2", // redis數據庫
"body-parser": "~1.0.1", // 用于解析提交的請求表單
"response-time": "^2.3.1" // 計算響應時間中間件
}
}
安裝Express框架及其依賴
編輯完以后,進入到該目錄,然后執行以下命令安裝Express框架及其依賴
npm install
注意
由于國內被墻,這個過程如果依賴包過多或過大的時候,會非常慢,所以,建議使用淘寶的cnpm來安裝(不安裝也可以,只是會比較慢)
-
安裝cnpm
npm install -g cnpm
-
然后通過cnpm安裝Express框架及其依賴
cnpm install
創建入口文件app.js
在根目錄創建app.js并添加以下代碼
/**
* app.js
* @authors 袁俊亮 (1610712512@qq.com)
* @date 2016-12-09 16:57:54
* @webSite http://www.yuanjunliang.cc
*/
?
var app = require('express')();
var responseTime = require('response-time');
var redis = require('redis');
?
// 創建數據庫客戶端
var client = redis.createClient();
client.on('error',function(err){
console.log('error'+err);
});
?
// 設置端口
app.set('port',(process.env.PORT || 3000));
?
// 使用請求計時模塊
app.use(responseTime());
?
// 設置/routes/index文件為總的路由控制文件
// 在routes/index文件中再進行統一的路由分發,這樣防止app.js中代碼過于臃腫
var routes = require('./routes/index');
routes(app);
?
// 啟動服務的時候監聽端口號
app.listen(app.get('port'),function(){
console.log('Server listening on port:',app.get('port'));
});
實現路由分發控制文件/routes/index.js
創建路由分發控制文件/routes/index.js,在該文件中,實現將用戶所有的請求邏輯處理分發到不同的業務模塊進行處理。實現代碼如下
module.exports = function(app){
// 分發user模塊,比如用戶的注冊和登錄請求業務邏輯將會在/api/user.js中實現
var user = require('../api/user');
app.use('/user',user);
};
處理具體的業務邏輯(與數據庫相關的業務邏輯處理都在這里完成)
創建一個/api目錄下的user.js文件,在其中實現user模塊的業務邏輯處理,代碼如下
/**
* 用戶模塊user.js
* @authors 袁俊亮 (1610712512@qq.com)
* @date 2016-12-09 17:06:42
* @webSite http://www.yuanjunliang.cc
*/
?
var express = require('express');
var router = express.Router();
?
// 處理get請求
router.get('/', function(req, res) {
res.send({
'username':'john',
'sex':'man',
'address':'上海'
});
});
?
// 處理POST請求
router.post('/',function(req,res){
console.log('接受到了post請求');
res.send({
'regist':{title:req.param('username')}
})
});
?
module.exports = router;
經過上訴的處理以后就完成了user模塊的路由控制分發,每當用戶發起與user相關的請求時,就可以在/api/user.js中接收到用戶的相關請求,并做相關處理
業務邏輯擴展
其他的分發邏輯類似,比如在添加一個文章編輯和查看模塊
-
在/api目錄下創建一個post.js文件并在其中實現文章的業務邏輯處理
-
在/routes/index.js文件中添加一條路由規則如下
module.exports = function(app){
// 分發user模塊,比如用戶的注冊和登錄請求業務邏輯將會在/api/user.js中實現
var user = require('../api/user');
app.use('/user',user);
// 文章編輯及查看路由模塊
var post = requier('../api/post');
app.use('/post',post);
};
最后給出上訴項目的Demo源碼
源碼地址為:
鏈接: https://pan.baidu.com/s/1c2kPYCS 密碼: ni3r
源碼使用方法
-
解壓源碼
解壓完源碼以后通過終端cd到本項目中,然后執行npm install安裝所有的依賴。
-
啟動服務
node app.js
如果終端中返回一下信息,說明啟動成功
Server listening on port: 3000
-
在瀏覽器中訪問
http://localhost:3000/user
如果返回一下json數據,說明請求成功
{
"username": "john",
"sex": "man",
"address": "上海"
}