Express实现路由分发控制、RESTful API

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 袁俊亮 ([email protected])
 * @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 袁俊亮 ([email protected])
 * @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": "上海"
}