express 全局接口

周末，没事就来公司加班继续研究一下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

npm install

1 {
 2   "name": "myapp",
 3   "version": "0.0.0",
 4   "private": true,
 5   "scripts": {
 6     "start": "node ./bin/www"
 7   },
 8   "dependencies": {
 9     "body-parser": "~1.13.2",
10     "cookie-parser": "~1.3.5",
11     "debug": "~2.2.0",
12     "express": "~4.13.1",
13     "jade": "~1.11.0",
14     "morgan": "~1.6.1",
15     "serve-favicon": "~2.3.0"
16   }
17 }

 

3、app.js

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

1 var express = require('express');
 2 //用于处理目录的对象，提高开发效率
 3 var path = require('path');  
 4 //用户加载图标
 5 var favicon = require('serve-favicon');  
 6 //在控制台中，显示req请求的信息
 7 var logger = require('morgan'); 
 8 //加载cookie模块，用于获取web浏览器发送的cookie中的内容
 9 var cookieParser = require('cookie-parser'); 
10 //解析客户端请求的body中的内容,内部使用JSON编码处理,url编码处理以及对于文件的上传处理
11 var bodyParser = require('body-parser');  
12 
13 var routes = require('./routes/index');
14 var users = require('./routes/users');
15 var demo = require('./routes/demo');
16 
17 var app = express();  //生成一个express实例 app
18 
19 
20 //设置VIEWS文件夹，__dirname是node.js里面的全局变量。取得执行js所在的路径
21 app.set('views', path.join(__dirname, 'views'));
22 // 视图引擎设置
23 app.set('view engine', 'jade');
24 
25 
26 // 定义icon图标，参数为图标的路径。如果不指明，则用默认的express图标
27 //app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));
28 
29 //加载日志中间件，定义日志和输出级别
30 app.use(logger('dev'));
31 
32 //加载解析json的中间件,接受json请求 
33 app.use(bodyParser.json()); 
34 
35 //加载解析urlencoded请求体的中间件
36 app.use(bodyParser.urlencoded({ extended: false })); 
37 
38 //加载解析cookie的中间件
39 app.use(cookieParser());  
40 
41 //静态文件目录设置,设置public文件夹为存放静态文件的目录
42 app.use(express.static(path.join(__dirname, 'public')));
43 //app.use(express.static(path.join(__dirname, 'html')));
44 
45 //路由控制器
46 app.use('/', routes);
47 app.use('/users', users);
48 app.use('/demo',demo);
49 
50 // 捕获404错误，并转发到错误处理器
51 app.use(function(req, res, next) {
52   var err = new Error('Not Found');
53   err.status = 404;
54   next(err);
55 });
56 
57 // error handlers
58 
59 // 开发环境下的500错误处理器，将错误信息渲染error模版并显示到浏览器中
60 if (app.get('env') === 'development') {
61   app.use(function(err, req, res, next) {
62     res.status(err.status || 500);
63     res.render('error', {
64       message: err.message,
65       error: err
66     });
67   });
68 }
69 
70 // 生产环境下的错误处理器，将错误信息渲染error模版并显示到浏览器中
71 // no stacktraces leaked to user
72 app.use(function(err, req, res, next) {
73   res.status(err.status || 500);
74   res.render('error', {
75     message: err.message,
76     error: {}
77   });
78 });
79 
80 //导出app实例供其他模块调用
81 module.exports = app;

 

4、Bin/www文件

www文件内容：这里拥有着http服务器的基本配置，www文件也是一个node的脚本，用于分离配置和启动程序只用。代码如下：

1 #!/usr/bin/env node  //表明是 node 可执行文件
 2 
 3 /**
 4  * Module dependencies.
 5  */
 6 //依赖加载
 7 //引入我们上面导出的app实例
 8 var app = require('../app');
 9 
10 //引入debug模块，打印调试日志
11 var debug = require('debug')('myapp:server');
12 var http = require('http');
13 
14 /**
15  * Get port from environment and store in Express.
16  */
17 //定义启动端口
18 var port = normalizePort(process.env.PORT || '3000');
19 app.set('port', port);
20 
21 /**
22  * Create HTTP server.
23  */
24 
25 var server = http.createServer(app);
26 
27 /**
28  * Listen on provided port, on all network interfaces.
29  */
30 
31 server.listen(port);
32 server.on('error', onError);
33 server.on('listening', onListening);
34 
35 /**
36  * Normalize a port into a number, string, or false.
37  */
38 //端口标准化函数
39 function normalizePort(val) {
40   var port = parseInt(val, 10);
41 
42   if (isNaN(port)) {
43     // named pipe
44     return val;
45   }
46 
47   if (port >= 0) {
48     // port number
49     return port;
50   }
51 
52   return false;
53 }
54 
55 /**
56  * Event listener for HTTP server "error" event.
57  */
58 //HTTP异常事件处理函数
59 function onError(error) {
60   if (error.syscall !== 'listen') {
61     throw error;
62   }
63 
64   var bind = typeof port === 'string'
65     ? 'Pipe ' + port
66     : 'Port ' + port;
67 
68   // handle specific listen errors with friendly messages
69   switch (error.code) {
70     case 'EACCES':
71       console.error(bind + ' requires elevated privileges');
72       process.exit(1);
73       break;
74     case 'EADDRINUSE':
75       console.error(bind + ' is already in use');
76       process.exit(1);
77       break;
78     default:
79       throw error;
80   }
81 }
82 
83 /**
84  * Event listener for HTTP server "listening" event.
85  */
86 //事件绑定函数
87 function onListening() {
88   var addr = server.address();
89   var bind = typeof addr === 'string'
90     ? 'pipe ' + addr
91     : 'port ' + addr.port;
92   debug('Listening on ' + bind);
93 }

 

5、routes

生成一个路由实例用来捕获访问主页的GET请求，导出这个路由并在app.js中通过app.use('/', routes); 加载。这样，当访问主页时，就会调用res.render('index', { title: 'Express' });渲染views/index.jade模版并显示到浏览器中。

1 var express = require('express');
2 var router = express.Router();
3 
4 /* GET home page. */
5 router.get('/', function(req, res, next) {
6   res.render('index', { title: 'Express' });
7 });
8 
9 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'));