阅读 5784

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: 1、注册成功 0:输入信息不完善或有误 -1:注册失败,该用户名已存在

msg: 响应返回的信息说明

data: {
    _id: _id,
    userName: 用户名,
    token: 生成的token,
}
复制代码
登录接口
api: /api/v1/signin  (post,请求头带token)

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

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

msg: 响应返回的信息说明

data: {
    _id: _id,
    userName: 用户名,
    lastLoginTime: 上次登录时间,
    lastLoginPlace: 上次登录地点,
}
复制代码
登出接口
api: /api/v1/signout  (get)

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

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

data: {}
复制代码
查看个人信息接口
api: /api/v1/user/userName  (post,请求头带token)

params: {
    userName: String,
}

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

msg: 查找个人信息返回信息说明

data: {
    userName: 用户名,
    userEmail: 用户邮箱,
    age: 年龄,
    city: 城市,
    ......
}
复制代码
更改个人信息接口
api: /api/v1/user/userName (put,token)

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

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

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负责接口服务。

文章分类
后端
文章标签