Node教程——API接口开发（MangoDB+Express）

时间 2020-04-16

标签 node 教程 api 接口开发 mangodb+express mangodb express 繁體版

原文原文链接

git源码

说明：源码已经所有上传到github，仓库地址： https://github.com/BM-laoli/Node-api-Designhtml

模块依赖关系图

1、大纲

大纲：
关于架构，
1. 首先咱们的有一个app.js这个就是根路由起点，用来最初的打入口
  它的功能有：
  1.1 引入模块建立基础的网站服务器，
  1.2 导入bodyPasser，过滤还有处理咱们的post请求
  1.3 导入数据库链接
  1.4 把路由开放出去git
2. 再来一个main.js它在个人route文件夹下，
  2.1 什么需啊哟再这里作二次拦截，再进行分配路由，
  2.2 引入两个逻辑处理模块，当请求发来的时候，若是不是login那么咱们就须要验证token，
  2.3 若是访问的是login那么咱们须要，发post数据，来到处理验证，而后拿token，
  2.4 若是有token，那么再来访问2.2这里的不是logi的其它路由路径，的校验就经过了，因而乎咱们就能分配各类接口了es6
3. 详细的讲解辅助，工具代码
  3.1 这里有咱们在主线逻辑里须要的一些工具
  3.2 中间件Middleware，里面有两个工具，一个是生成token的一个校验token的
  3.3 在3.2中的功能须要依赖model下的一个util下的jwt工具生成token生成的依据是两个密钥对
  3.4 咱们还有两个工具，content 建立数据库的连接，create初始化数据还有开发数据操做对象github

2、展现接口 API文档

1.1 登陆

请求地址	请求方式
/main/login	POST

参数名称	是否必选	参数说明
email	是	邮箱
password	是	密码

{
	"status": 200,
	"msg": "登录成功",
	"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiNWU5MTIwMTViOWI0NmYzZmE4Y2MzMjUzIiwiZXhwIjoxNTg2OTUyMzk1LCJpYXQiOjE1ODY5NTA1OTV9.IsprCaQ_gZRh0BzS8SnAd0iJ27BOpOEb-ZGn0bTlwHVPTiYPK50wiEOL_0aAYINfNT_Mfvb726l3CpiHG9lsJ45m4eqhPeJz9TbAeQj8-ST3CAkYLrD0fhgRG9YiQ5kjVpygdR8NZEWEUV7ux-moyYe7wCoVzN9mbvAkFF3IYG0"
}

1.2 拿着token进行测试

请求地址	请求方式
/main/text	get

参数名称	是否必选	参数说明
token	是	须要附上你的token。在请求头中
无	无	该接口不须要传递参数

{
	"status": 200,
	"msg": "登录成功"
}

注意：以上就是Node写接口的最基础的内容。能够在这个内容上扩展更多的接口web

2、 app.js模块的详解

app.jsmongodb

//引入模块，建立简单服务器
const express = require('express');
//引入路径处理模块
const path = require('path');
//引入注意使用第三方模块处理post
const bodyPaser = require('body-parser')

// 引入数据库链接 不须要返回值
require('./model/content')

//建立服务器
const app = express();

/*//初始化数据库,注意reque的时候 会自动执行引入的js文件
require('./model/create')
*/


//前往当心这个要放在全部的use前面，解析咱们的post请求数据
app.use(bodyPaser.urlencoded({ extended: false }));
//处理静态资源路径
const DataPath = path.join(__dirname, 'public');
//这个咱们后面是有用的，用来操做媒体数据，最重要的就是这个路径还有这个静态资源对象
const StaticUtils = express.static(path.join(__dirname, 'public'));


//拿到路由操做对象
const main = require('./route/mian/main');
//开放接口路径
//拦截请求开始匹配路由  
app.use('/dataPath', (req, res) => {
    res.status(200).send(JSON.stringify({ 'dataPath': DataPath }))
})
app.use(StaticUtils);
app.use('/main', main)


//监听端口
app.listen(3000)
console.log('服务器开启');

3、 main.js二次路由拦截模块

main.js数据库

const express = require('express')

//业务逻辑
const guard = require('../../Middleware/loginGuard')
const loginPash = require('../../Middleware/loginPash')




//建立路由对象
const admin = express.Router()
    //验证token
admin.use(loginPash)

//登陆路由处理
admin.post('/login', guard)

//首先要验证，而后才是放行到对应的路由接口里面取
admin.get('/text', require('./API/home/index'))

module.exports = admin;

携带的一个简单的测试模块(后续能够仿照这样的模式，写更多的API接口功能模块)
home/index.js

module.exports = async(req, res) => {
    res.send({ status: 200, msg: '登录成功', });
}

4、辅助工具（重点！！！）

数据库链接，设计还有初始化建立模块
model/content.js && model/create.js

const mongoose = require('mongoose');

mongoose.connect('mongodb://localhost/blog')
    .then(() => {
        console.log('数据库链接成功');
    })
    .catch((erro) => {
        console.log(erro);
    })

const mongoose = require('mongoose');

 const bcrypt = require('bcrypt')


 /*使用MongDB数据库，设计数据第一步（代码角度分析）
 1.设定规则,Schema构造器,Schema的构造函数就是规则，注意规则是一系列对象
 2.建立数据
 */

 const userSchema = new mongoose.Schema({
     username: {
         type: String,
         required: true,
         min: 2,
         max: 10
     },
     email: {
         type: String,
         //注意 咱们的邮箱凭据是用户登陆的令牌，咱们须要指定他为惟一的
         unique: true, //这个时候，在插入的时候若是有重复的就给你抱一个错误
     },
     password: {
         type: String,
         required: true,
     },
     role: { //须要说明一下，这个地方角色，咱们硬性规定，超级管理员是admin普通用户是normal，为何不用01？由于这里string了
         type: String,
         required: true
     },
     state: {
         //咱们使用O1状态来设计这个数据字段，默认值是0。0是启用状态
         type: Number,
         default: 0
     }
 })

 //使用规则建立集合,
 //必定要注意，咱们的User就是表明了我目前最user数据集合，后期的增删改查咱们都须要用到这个东西，全部咱们暴露出去给路由业务使用
 const User = mongoose.model('User', userSchema)


 //咱们再来复习一下，如何用同步的方式获取异步的api结果？使用async 还有awit就能够

 async function createUser() {
     const salt = await bcrypt.genSalt(10)
     const pass = await bcrypt.hash('123456', salt)
     const user = await User.create({
         username: 'lli',
         email: '18376621755@163.com',
         password: pass,
         role: 'admin',
         state: 0,
     })
 }


 //  createUser()




 /* //  初始化用户，注意咱们的create返回的是一个promies
   User.create({
     username: 'bmlaoli',
     email: '861795660@qq.com',

     password: '123456',

     role: 'admin',
     state: 0,
 })
 .then(() => {
     console.log('用户建立成功');
 })
 .catch((error) => {
     console.log('用户建立失败');
 })*/








 //注意啊，es6中若是键值对的名字是同样的就能够省略值。因为咱们后期还会作更多的数据集合，因而乎我这里须要暴露一个对象出去
 module.exports = {
     User
 }

另外一个重要的工具模块，用来建立token 根据就是文件夹下的两个密钥对文件
jwt.js

/*
 *描述：如下是jwt工具，生成用于访问验证的token 
 */

// 引入模块依赖
const fs = require('fs');
const path = require('path');
const jwt = require('jsonwebtoken');
// 建立 token 类
class Jwt {
    constructor(data) {
            this.data = data;
        }
        //生成token
    generateToken() {
        let data = this.data;
        let created = Math.floor(Date.now() / 1000);
        let cert = fs.readFileSync(path.join(__dirname, '../../pem/private_key.pem')); //私钥 能够本身生成，注意这里要使用 密钥对，请求百度下载，两对密钥对
        let token = jwt.sign({
            data,
            exp: created + 60 * 30,
        }, cert, { algorithm: 'RS256' });
        return token;
    }

    // 校验token
    verifyToken() {
        let token = this.data;
        let cert = fs.readFileSync(path.join(__dirname, '../../pem/public_key.pem')); //公钥 能够本身生成
        let res;
        try {
            let result = jwt.verify(token, cert, { algorithms: ['RS256'] }) || {};
            let { exp = 0 } = result, current = Math.floor(Date.now() / 1000);
            if (current <= exp) {
                res = result.data || {};
            }
        } catch (e) {
            res = 'err';
        }
        return res;
    }
}

module.exports = Jwt;

接下里是两个具体的token校验功能模块
我把它们都放到了middleware文件夹下
loginGuard.js && loginPash.js

const JwtUtil = require('../model/util/jwt')
const { User } = require('../model/create')
const bcrypt = require('bcrypt')


const guard = async(req, res, next) => {
    //注意使用第三方模块处理post
    //进图具体的业务逻辑，解构出来咱们须要的东西
    const { email, password, _id } = req.body; //注意啊，因为咱们的中间件处理的请求因而乎咱们的req身上就有这个处理的全部数据了，这个以前有说过

    console.log(req.body);

    if (email.trim().length == 0 || password.trim().length == 0) {
        res.status(400).send(
                JSON.stringify({ message: '邮箱或密码错误' })
            ) //注意send自动把状态码设置成了200，因此你须要改一下
        return
    }


    //若是用户存在就先找到这个用户额信息,注意这里的这个异步await
    let user = await User.findOne({ email });
    //这里的user就是指向当前查询出来的数据文档对象

    if (user) {
        //比对操做,第一个参数是一个明文密码，第二个参数咱们查询出来的加密密码 ，方法返回一个Boolean值,对比成功就是true，异步api能够直接加await
        const isValid = await bcrypt.compare(password, user.password)
        if (isValid) {
            //用户校验成功，添加tooken
            // 登录成功，添加token验证
            let _id = user._id.toString();
            // 将用户id传入并生成token
            let jwt = new JwtUtil(_id);
            let token = jwt.generateToken();
            // 将 token 返回给客户端
            res.send({ status: 200, msg: '登录成功', token: token });
            //校验成功就
            next()
        } else {
            res.status(400).send(
                JSON.stringify({ message: '邮箱或密码错误' })
            )
        }

    } else {
        res.status(400).send(
            JSON.stringify({ message: '邮箱或密码错误' })
        )
    }
}

module.exports = guard

loginPash.jsexpress

const JwtUtil = require('../model/util/jwt')





//验证token
const loginPash = function(req, res, next) {
    // 我这里知识把登录和注册请求去掉了，其余的多有请求都须要进行token校验 
    if (req.url != '/login?') {
        let token = req.headers.token;
        let jwt = new JwtUtil(token);
        let result = jwt.verifyToken();
        // 若是考验经过就next，不然就返回登录信息不正确
        if (result == 'err') {
            console.log(result);
            console.log(req.url);
            res.send({ status: 403, msg: '登陆已过时,请从新登陆' });
            // res.render('login.html');
        } else {
            next();
        }
    } else {
        next();
    }
};



module.exports = loginPash;

5、最后咱们梳理一下，这些模块之间的关系

其实这套接口下来，我比较菜鸡，用了两天的工做之余的时间，因为我没怎么接触接口的设计，对于后台的一些设计模式还有理念不是特别懂，走了不少弯路，以上的是我写了三次笔记，长达2000多行子，反复的修改，才成型，但愿大佬高抬贵手指点迷津，也但愿，这篇入门的文档，能给你带来收获，接下里，我就用这里的模型，开发更多的接口。敬请期待。json

各个模块的引用关系，用例图

Node教程——API接口开发（MangoDB+Express）

git源码

模块依赖关系图

1、大纲

2、展现 接口 API文档

1.1 登陆

1.2 拿着token进行测试

2、 app.js模块的详解

3、 main.js二次路由拦截模块

4、 辅助工具（重点！！！）

5、 最后咱们梳理一下，这些模块之间的关系

2、展现接口 API文档

4、辅助工具（重点！！！）

5、最后咱们梳理一下，这些模块之间的关系