Egg.js搭建后台服务API

写在前面的话

最近在学习Egg.js，它是阿里推出的基于Koa的node开发框架，为企业级框架和应用而生。Egg.js 的官方文档已经很完善了，想学习Egg.js的能够直接查看官方文档。

由于日常开发都是先后端分离的模式，就想着使用Egg建立后台服务，写一套API接口配合其余的项目。该项目的技术栈用到了Egg.js、MongoDB、mongoose。这篇文章记录一下我写注册登陆模块和用户中心模块的过程，目的是及时概括学习过程，锻炼文档能力，和你们进行分享交流，共同进步。

项目地址: Egg-API

项目持续更新中，喜欢的请点心，关注，star ,fork,这些是我长期坚持下去的动力 (。＿ 。） ✎＿

如下是正文

需求分析

对于注册登录模块，需求分析以下:

• 注册成为新用户，对输入的数据进行校验
• 登录进入系统，须要对输入的数据进行校验，基于token鉴权认证
• 登出功能
• 登录进去能够在用户中心模块查看我的信息
• 在用户中心模块修改我的信息

数据分析设计

显式数据：

• userName: String 用户名
• userPass: String 帐号密码
• userEmail: String 用户邮箱
• telphone: String 手机号
• avatar: String 头像
• age: Number 年龄
• sex: String 性别
• City: String 城市

隐式数据：

• userRole: Number 用户角色(1.普通用户、 2.管理员、 3.超级管理员，默认用户为普通用户，超级管理员在建立数据库的时候建立)
• userCreate: Date 用户建立时间
• lastLoginTime: Date 上次登陆时间
• laseLoginPlace: String 上次登陆地址

API分析设计

下文接口说明中的api指接口名，params指传入的数据，code指响应结果标识码,msg指响应结果信息说明,data指响应成功返回的数据

注册接口

api: /api/v1/signup  (post)

params: {
    userName: String,  // 用户名，具备惟一性
    userPass: String,  // 用户密码
    userEmail: String,  // 用户邮箱
}

code: 一、注册成功 0：输入信息不完善或有误 -1：注册失败，该用户名已存在

msg: 响应返回的信息说明

data： {
    _id: _id,
    userName: 用户名,
    token: 生成的token,
}

登陆接口

api: /api/v1/signin  (post，请求头带token)

params: {
    userName: String,  // 用户名
    userPass: String,  // 用户密码
}

code: 一、登陆成功 0：输入信息不完善或有误  -1：用户不存在

msg: 响应返回的信息说明

data: {
    _id： _id，
    userName: 用户名,
    lastLoginTime: 上次登陆时间,
    lastLoginPlace: 上次登陆地点,
}

登出接口

api: /api/v1/signout  (get)

code: 一、登出成功，前端退出系统并清空token

msg: 登出响应返回信息说明

data: {}

查看我的信息接口

api: /api/v1/user/userName  (post，请求头带token)

params: {
    userName: String,
}

code: 一、查询成功  0、输入信息不完善  -一、查询失败

msg: 查找我的信息返回信息说明

data: {
    userName: 用户名,
    userEmail: 用户邮箱,
    age: 年龄,
    city: 城市,
    ......
}

更改我的信息接口

api: /api/v1/user/userName (put,token)

params: {
    ......  // 更改的信息
}

code: 一、更新成功 0、输入信息不完善或有误 -一、更新失败

msg: 更新我的信息返回信息说明

data: {
    userName: 用户名,
    ......
}

编码实现

注:编码实现说明只提供部分，完整内容请移步Egg-API

假设你已经初始化好了一个项目，项目的目录结构约定和官方的一致。由于咱们要使用MongoDB数据库，因此要先安装egg-mongoose,并在配置文件里写入:

// config/plugin.js
exports.mongoose = {
    enable: true,
    package: 'egg-mongoose',
};
// config/config.default.js
config.mongoose = {
    url: 'mongodb://127.0.0.1/apiExample',
    options: {},
};

在model文件夹定义咱们的schema文件：

const UserSchema = new Schema({
    userName: { type: String, unique: true, required: true, },
});

路由定义:

router.post('/api/v1/signup', controller.user.signup);

controller编写：用于解析用户的输入，处理后返回相应的结果。咱们能够把获取到的数据放到render中进行渲染，而后把渲染后的结果发给游览器，或者，也能够把数据直接赋值给ctx.body,而后以json方式返回。

class UserController extends Controller {
    // 登陆
    async signin() {
        const { ctx } = this;
        const rule = {
            userName: { type: 'string', required: true, message: '必填项' },
            userPass: { type: 'string', required: true, message: '必填项' },
        };
        const signinMsg = ctx.request.body;
        await ctx.validate(rule, signinMsg);
        signinMsg.userPass = ctx.helper.encrypt(signinMsg.userPass);
        const result = await ctx.service.user.signin(signinMsg);
        ctx.body = result;
    }
}

service编写：用于编写业务逻辑层，能够复用。复杂数据的处理，好比要展示的信息须要从数据库获取,或者是第三方服务的调用。

class UserService extends Service {
    // 更新用户信息
    async updateUser(userMsg) {
        const { ctx } = this;
        const res = {};
        const result = await ctx.model.User.findByIdAndUpdate(userMsg._id, userMsg);
        res.code = 1;
        res.msg = '用户信息已更改';
        res.data = result;
        return res;
    }
}

一个简单的node应用结构就是这样，如此便实现了用Egg.js负责接口服务。