Egg.js搭建后臺(tái)服務(wù)API

dailybird 發(fā)布于2019-06-26 17:43 / 2764人閱讀

摘要：因?yàn)槠匠ｉ_(kāi)發(fā)都是前后端分離的模式，就想著使用創(chuàng)建后臺(tái)服務(wù)，寫(xiě)一套接口配合其他的項(xiàng)目。復(fù)雜數(shù)據(jù)的處理，比如要展現(xiàn)的信息需要從數(shù)據(jù)庫(kù)獲取或者是第三方服務(wù)的調(diào)用。更新用戶信息用戶信息已更改一個(gè)簡(jiǎn)單的應(yīng)用結(jié)構(gòu)就是這樣，如此便實(shí)現(xiàn)了用負(fù)責(zé)接口服務(wù)。

寫(xiě)在前面的話

最近在學(xué)習(xí)Egg.js，它是阿里推出的基于Koa的node開(kāi)發(fā)框架，為企業(yè)級(jí)框架和應(yīng)用而生。Egg.js 的官方文檔已經(jīng)很完善了，想學(xué)習(xí)Egg.js的可以直接查看官方文檔。

因?yàn)槠匠ｉ_(kāi)發(fā)都是前后端分離的模式，就想著使用Egg創(chuàng)建后臺(tái)服務(wù)，寫(xiě)一套API接口配合其他的項(xiàng)目。該項(xiàng)目的技術(shù)棧用到了Egg.js、MongoDB、mongoose。這篇文章記錄一下我寫(xiě)注冊(cè)登錄模塊和用戶中心模塊的過(guò)程，目的是及時(shí)歸納學(xué)習(xí)過(guò)程，鍛煉文檔能力，和大家進(jìn)行分享交流，共同進(jìn)步。

項(xiàng)目地址: Egg-API

項(xiàng)目持續(xù)更新中，喜歡的請(qǐng)點(diǎn)心，關(guān)注，star ,fork,這些是我長(zhǎng)期堅(jiān)持下去的動(dòng)力 (。＿。） ?＿

以下是正文 需求分析

對(duì)于注冊(cè)登陸模塊，需求分析如下:

注冊(cè)成為新用戶，對(duì)輸入的數(shù)據(jù)進(jìn)行校驗(yàn)

登陸進(jìn)入系統(tǒng)，需要對(duì)輸入的數(shù)據(jù)進(jìn)行校驗(yàn)，基于token鑒權(quán)認(rèn)證

登出功能

登陸進(jìn)去可以在用戶中心模塊查看個(gè)人信息

在用戶中心模塊修改個(gè)人信息

數(shù)據(jù)分析設(shè)計(jì)

顯式數(shù)據(jù)：

userName: String 用戶名

userPass: String 賬號(hào)密碼

userEmail: String 用戶郵箱

telphone: String 手機(jī)號(hào)

avatar: String 頭像

age: Number 年齡

sex: String 性別

City: String 城市

隱式數(shù)據(jù)：

userRole: Number 用戶角色(1.普通用戶、 2.管理員、 3.超級(jí)管理員，默認(rèn)用戶為普通用戶，超級(jí)管理員在創(chuàng)建數(shù)據(jù)庫(kù)的時(shí)候創(chuàng)建)

userCreate: Date 用戶創(chuàng)建時(shí)間

lastLoginTime: Date 上次登錄時(shí)間

laseLoginPlace: String 上次登錄地址

API分析設(shè)計(jì)

下文接口說(shuō)明中的api指接口名，params指?jìng)魅氲臄?shù)據(jù)，code指響應(yīng)結(jié)果標(biāo)識(shí)碼,msg指響應(yīng)結(jié)果信息說(shuō)明,data指響應(yīng)成功返回的數(shù)據(jù)

注冊(cè)接口

api: /api/v1/signup  (post)

params: {
    userName: String,  // 用戶名，具有唯一性
    userPass: String,  // 用戶密碼
    userEmail: String,  // 用戶郵箱
}

code: 1、注冊(cè)成功 0：輸入信息不完善或有誤 -1：注冊(cè)失敗，該用戶名已存在

msg: 響應(yīng)返回的信息說(shuō)明

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

登錄接口

api: /api/v1/signin  (post，請(qǐng)求頭帶token)

params: {
    userName: String,  // 用戶名
    userPass: String,  // 用戶密碼
}

code: 1、登錄成功 0：輸入信息不完善或有誤  -1：用戶不存在

msg: 響應(yīng)返回的信息說(shuō)明

data: {
    _id： _id，
    userName: 用戶名,
    lastLoginTime: 上次登錄時(shí)間,
    lastLoginPlace: 上次登錄地點(diǎn),
}

登出接口

api: /api/v1/signout  (get)

code: 1、登出成功，前端退出系統(tǒng)并清空token

msg: 登出響應(yīng)返回信息說(shuō)明

data: {}

查看個(gè)人信息接口

api: /api/v1/user/userName  (post，請(qǐng)求頭帶token)

params: {
    userName: String,
}

code: 1、查詢成功  0、輸入信息不完善  -1、查詢失敗

msg: 查找個(gè)人信息返回信息說(shuō)明

data: {
    userName: 用戶名,
    userEmail: 用戶郵箱,
    age: 年齡,
    city: 城市,
    ......
}

更改個(gè)人信息接口

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

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

code: 1、更新成功 0、輸入信息不完善或有誤 -1、更新失敗

msg: 更新個(gè)人信息返回信息說(shuō)明

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

編碼實(shí)現(xiàn)

注:編碼實(shí)現(xiàn)說(shuō)明只提供部分，完整內(nèi)容請(qǐng)移步Egg-API

假設(shè)你已經(jīng)初始化好了一個(gè)項(xiàng)目，項(xiàng)目的目錄結(jié)構(gòu)約定和官方的一致。因?yàn)槲覀円褂肕ongoDB數(shù)據(jù)庫(kù)，所以要先安裝egg-mongoose,并在配置文件里寫(xiě)入:

// 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編寫(xiě)：用于解析用戶的輸入，處理后返回相應(yīng)的結(jié)果。我們可以把獲取到的數(shù)據(jù)放到render中進(jìn)行渲染，然后把渲染后的結(jié)果發(fā)給游覽器，或者，也可以把數(shù)據(jù)直接賦值給ctx.body,然后以json方式返回。

class UserController extends Controller {
    // 登錄
    async signin() {
        const { ctx } = this;
        const rule = {
            userName: { type: "string", required: true, message: "必填項(xiàng)" },
            userPass: { type: "string", required: true, message: "必填項(xiàng)" },
        };
        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編寫(xiě)：用于編寫(xiě)業(yè)務(wù)邏輯層，可以復(fù)用。復(fù)雜數(shù)據(jù)的處理，比如要展現(xiàn)的信息需要從數(shù)據(jù)庫(kù)獲取,或者是第三方服務(wù)的調(diào)用。

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;
    }
}

一個(gè)簡(jiǎn)單的node應(yīng)用結(jié)構(gòu)就是這樣，如此便實(shí)現(xiàn)了用Egg.js負(fù)責(zé)接口服務(wù)。

GPU云服務(wù)器云服務(wù)器 egg.js 視頻后臺(tái)服務(wù)器搭建服務(wù)器后臺(tái)搭建云服務(wù)器網(wǎng)絡(luò)后臺(tái)搭建

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://specialneedsforspecialkids.com/yun/19305.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

dailybird

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

入手萬(wàn)彩錄屏大師體驗(yàn)高清錄屏視頻輸出且自帶視頻編輯特效素材

閱讀 1718·2021-10-18 13:34
ION Cloud：$120/年/2核/2GB內(nèi)存/60GB SSD空間/3TB流量/1Gbps端口

閱讀 3906·2021-09-08 10:42
搬瓦工VPS：高端線路，助力企業(yè)運(yùn)營(yíng)，10Gbps美國(guó) cn2 gia，1Gbps香港cn2 gia

閱讀 1551·2021-09-02 09:56
sublime text3 - 打造成小程序開(kāi)發(fā)神器

閱讀 1606·2019-08-30 15:54
校招筆試 | C語(yǔ)言筆試必考系列?。?！

閱讀 3127·2019-08-29 18:44
又是一波前端知識(shí)點(diǎn)總結(jié)

閱讀 3298·2019-08-26 18:37
react-lazy-load粗讀

閱讀 2212·2019-08-26 12:13
axios基于常見(jiàn)業(yè)務(wù)場(chǎng)景的二次封裝(更新)

閱讀 453·2019-08-26 10:20

国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN