Node 之 Express 4x 骨架詳解

週末，沒事就來公司加班繼續研究一下Express ，這也許也是單身狗的生活吧。

一、目錄結構：

• bin, 存放啓動項目的腳本文件
• node_modules, 項目全部依賴的庫，以及存放 package.json 中安裝的模塊，當你在 package.json 添加依賴的模塊並安裝後，存放在這個文件夾下
• public，靜態文件(css,js,img)
• routes，路由文件(MVC中的C,controller)
• views，頁面文件(jade模板)，後期打算換成 Ejs 模板搞搞
• package.json，存儲着工程的信息及模塊依賴
• app.js，應用核心配置文件（入口文件）

 

二、Package.json

package.json用於項目依賴配置及開發者信息，scripts屬性是用於定義操做命令的，能夠很是方便的增長啓動命令，好比默認的start，用npm start表明執行node ./bin/www命令。當在 dependencies 中添加依賴的模塊時，運行 npm install ，npm 會檢查當前目錄下的 package.json，並自動安裝全部指定的模塊。

{
  "name": "myapp",
  "version": "0.0.0",
  "private": true,
  "scripts": {
    "start": "node ./bin/www"
  },
  "dependencies": {
    "body-parser": "~1.13.2",
    "cookie-parser": "~1.3.5",
    "debug": "~2.2.0",
    "express": "~4.13.1",
    "jade": "~1.11.0",
    "morgan": "~1.6.1",
    "serve-favicon": "~2.3.0"
  }
}

三、app.js

核心文件，也是項目入口文件。

var express = require('express');
//用於處理目錄的對象，提升開發效率
var path = require('path');  
//用戶加載圖標
var favicon = require('serve-favicon');  
//在控制檯中，顯示req請求的信息
var logger = require('morgan'); 
//加載cookie模塊，用於獲取web瀏覽器發送的cookie中的內容
var cookieParser = require('cookie-parser'); 
//解析客戶端請求的body中的內容,內部使用JSON編碼處理,url編碼處理以及對於文件的上傳處理
var bodyParser = require('body-parser');  

var routes = require('./routes/index');
var users = require('./routes/users');
var demo = require('./routes/demo');

var app = express();  //生成一個express實例 app


//設置VIEWS文件夾，__dirname是node.js裏面的全局變量。取得執行js所在的路徑
app.set('views', path.join(__dirname, 'views'));
// 視圖引擎設置
app.set('view engine', 'jade');


// 定義icon圖標，參數爲圖標的路徑。若是不指明，則用默認的express圖標
//app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));

//加載日誌中間件，定義日誌和輸出級別
app.use(logger('dev'));

//加載解析json的中間件,接受json請求 
app.use(bodyParser.json()); 

//加載解析urlencoded請求體的中間件
app.use(bodyParser.urlencoded({ extended: false })); 

//加載解析cookie的中間件
app.use(cookieParser());  

//靜態文件目錄設置,設置public文件夾爲存放靜態文件的目錄
app.use(express.static(path.join(__dirname, 'public')));
//app.use(express.static(path.join(__dirname, 'html')));

//路由控制器
app.use('/', routes);
app.use('/users', users);
app.use('/demo',demo);

// 捕獲404錯誤，並轉發到錯誤處理器
app.use(function(req, res, next) {
  var err = new Error('Not Found');
  err.status = 404;
  next(err);
});

// error handlers

// 開發環境下的500錯誤處理器，將錯誤信息渲染error模版並顯示到瀏覽器中
if (app.get('env') === 'development') {
  app.use(function(err, req, res, next) {
    res.status(err.status || 500);
    res.render('error', {
      message: err.message,
      error: err
    });
  });
}

// 生產環境下的錯誤處理器，將錯誤信息渲染error模版並顯示到瀏覽器中
// no stacktraces leaked to user
app.use(function(err, req, res, next) {
  res.status(err.status || 500);
  res.render('error', {
    message: err.message,
    error: {}
  });
});

//導出app實例供其餘模塊調用
module.exports = app;

四、Bin/www文件

www文件內容：這裏擁有着http服務器的基本配置，www文件也是一個node的腳本，用於分離配置和啓動程序只用。代碼以下：

#!/usr/bin/env node  //代表是 node 可執行文件

/**
 * Module dependencies.
 */
//依賴加載
//引入咱們上面導出的app實例
var app = require('../app');

//引入debug模塊，打印調試日誌
var debug = require('debug')('myapp:server');
var http = require('http');

/**
 * Get port from environment and store in Express.
 */
//定義啓動端口
var port = normalizePort(process.env.PORT || '3000');
app.set('port', port);

/**
 * Create HTTP server.
 */

var server = http.createServer(app);

/**
 * Listen on provided port, on all network interfaces.
 */

server.listen(port);
server.on('error', onError);
server.on('listening', onListening);

/**
 * Normalize a port into a number, string, or false.
 */
//端口標準化函數
function normalizePort(val) {
  var port = parseInt(val, 10);

  if (isNaN(port)) {
    // named pipe
    return val;
  }

  if (port >= 0) {
    // port number
    return port;
  }

  return false;
}

/**
 * Event listener for HTTP server "error" event.
 */
//HTTP異常事件處理函數
function onError(error) {
  if (error.syscall !== 'listen') {
    throw error;
  }

  var bind = typeof port === 'string'
    ? 'Pipe ' + port
    : 'Port ' + port;

  // handle specific listen errors with friendly messages
  switch (error.code) {
    case 'EACCES':
      console.error(bind + ' requires elevated privileges');
      process.exit(1);
      break;
    case 'EADDRINUSE':
      console.error(bind + ' is already in use');
      process.exit(1);
      break;
    default:
      throw error;
  }
}

/**
 * Event listener for HTTP server "listening" event.
 */
//事件綁定函數
function onListening() {
  var addr = server.address();
  var bind = typeof addr === 'string'
    ? 'pipe ' + addr
    : 'port ' + addr.port;
  debug('Listening on ' + bind);
}

五、routes

生成一個路由實例用來捕獲訪問主頁的GET請求，導出這個路由並在app.js中經過app.use('/', routes); 加載。這樣，當訪問主頁時，就會調用res.render('index', { title: 'Express' });渲染views/index.jade模版並顯示到瀏覽器中。

var express = require('express');
var router = express.Router();

/* GET home page. */
router.get('/', function(req, res, next) {
  res.render('index', { title: 'Express' });
});

module.exports = router;

關於路由，路由中有兩個經常使用功能：

• app.route()函數，建立可連接的途徑處理程序的路由路徑。
• express.Router類，建立模塊化安裝路徑的處理程序。

app.route方法會返回一個Route實例，它能夠繼續使用全部的HTTP方法，包括get,post,all,put,delete,head等。

1 app.route('/users')
2   .get(function(req, res, next) {})
3   .post(function(req, res, next) {})

express.Router類，則能夠幫助咱們更好的組織代碼結構。在app.js文件中，定義了app.use(‘/’, routes); routes是指向了routes目錄下的index.js文件，./routes/index.js文件中，express.Router被定義使用， 路徑/*處理都會由routes/index.js文件裏的Router來處理。若是咱們要管理不一樣的路徑，那麼能夠直接配置爲多個不一樣的Router。

1 app.use('/user', require('./routes/user').user);
2 app.use('/admin', require('./routes/admin').admin);
3 app.use('/', require('./routes'));

 

Express生成的骨架大體內容都差很少了解了。下一篇寫一個小demo，連實踐一下。