Node 之 Express 4x 骨架详解

周末，没事就来公司加班继续研究一下Express ，这也许也是单身狗的生活吧。

1、目录结构：

bin, 存放启动项目的脚本文件
node_modules, 项目所有依赖的库，以及存放 package.json 中安装的模块，当你在 package.json 添加依赖的模块并安装后，存放在这个文件夹下
public，静态文件(css,js,img)
routes，路由文件(MVC中的C,controller)
views，页面文件(jade模板)，后期打算换成 Ejs 模板搞搞
package.json，存储着工程的信息及模块依赖
app.js，应用核心配置文件（入口文件）

2、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"

  }

}

3、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;

4、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);

}

5、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，连实践一下。

巴特西

Node 之 Express 4x 骨架详解

最新文章

热门文章