Egg.js搭建后台服务API

dailybird 发布于2019-06-26 17:43 / 2763人阅读

摘要：因为平常开发都是前后端分离的模式，就想着使用创建后台服务，写一套接口配合其他的项目。复杂数据的处理，比如要展现的信息需要从数据库获取或者是第三方服务的调用。更新用户信息用户信息已更改一个简单的应用结构就是这样，如此便实现了用负责接口服务。

写在前面的话

最近在学习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负责接口服务。

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/19305.html

Egg.js搭建后台服务API

摘要：因为平常开发都是前后端分离的模式，就想着使用创建后台服务，写一套接口配合其他的项目。复杂数据的处理，比如要展现的信息需要从数据库获取或者是第三方服务的调用。更新用户信息用户信息已更改一个简单的应用结构就是这样，如此便实现了用负责接口服务。写在前面的话最近在学习Egg.js，它是阿里推出的基于Koa的node开发框架，为企业级框架和应用而生。Egg.js 的官方文档已经很完善了，想学...

idealcn 2019-08-26 12:09 评论0 收藏0
阿里egg.js初体验(二)

摘要：接前一篇，阿里初体验一我们继续我们的之旅。注意到，目录里和两个文件夹，这里也是我们编写业务逻辑的主要地方。用于解析用户的输入，处理后返回相应的结果。在使用导出的模块时，需要把导出的模块名改为驼峰标准，且首字母变为小写。接前一篇，阿里egg.js初体验(一) 我们继续我们的egg之旅。我们已经完成了对于项目结构的搭建，现在我们需要开始业务的编写。注意到，目录里controller和se...

liaosilzu2007 2019-08-26 11:32 评论0 收藏0
egg.js框架开发环境搭建

摘要：我为了方便直接就指定了淘宝仓库地址运行服务运行项目就比较简单了，运行的命令在浏览器中打开地址，就能看到服务已经启动完成。传送门：学习node.js服务开发这一篇就够了系列文章 1.创建工程目录 1.1 创建一个文件夹叫 my-egg-application $ mkdir my-egg-application 不熟悉命令行的同学也可以手动创建文件夹 2.初始化项目模板 2.1 进...

Steve_Wang_ 2019-08-23 18:24 评论0 收藏0
Eggjs小试

摘要：项目都很小，但为了进一步了解，特意选择了作为框架基础开发后端服务。能将请求限制在同源网站，即只有拥有专有令牌的网站发送请求才会正确响应。项目生产静默部署，启动使用，停止使用。不足工具函数的访问需要自己手动添加扩展另没有写测试，希望下次补上。前言这段时间，用Eggjs作为后端服务框架开发了几个项目。项目都很小，但为了进一步了解Eggjs，特意选择了Eggjs作为框架基础开发后端服务。...

waltr 2019-08-22 18:04 评论0 收藏0
一个vue加egg.js的博客

摘要：之前自己的博客是用做的，后面想做一个有后台的博客就打算用加来试试，于是就有了这个博客。之前自己的博客是用hexo做的，后面想做一个有后台的博客就打算用vue加node来试试，于是就有了这个博客。项目地址 W-Blog W-Blog是一个基于vue和node的小小小博客前端用vue，后端用egg.js 快速入门技术栈前端：用户端：vue、iview admin端：vue、...

newtrek 2019-06-26 17:47 评论0 收藏0