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

idealcn 發(fā)布于2019-08-26 12:09 / 2761人閱讀

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

寫在前面的話

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

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

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

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

以下是正文 需求分析

對于注冊登陸模塊，需求分析如下:

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

登陸進(jìn)入系統(tǒng)，需要對輸入的數(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 賬號密碼

userEmail: String 用戶郵箱

telphone: String 手機(jī)號

avatar: String 頭像

age: Number 年齡

sex: String 性別

City: String 城市

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

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

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

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

laseLoginPlace: String 上次登錄地址

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

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

注冊接口

api: /api/v1/signup  (post)

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

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

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

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

登錄接口

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

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

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

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

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

登出接口

api: /api/v1/signout  (get)

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

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

data: {}

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

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

params: {
    userName: String,
}

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

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

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

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

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

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

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

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

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

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

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

假設(shè)你已經(jīng)初始化好了一個(gè)項(xiàng)目，項(xiàng)目的目錄結(jié)構(gòu)約定和官方的一致。因?yàn)槲覀円褂肕ongoDB數(shù)據(jù)庫，所以要先安裝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編寫：用于解析用戶的輸入，處理后返回相應(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編寫：用于編寫業(yè)務(wù)邏輯層，可以復(fù)用。復(fù)雜數(shù)據(jù)的處理，比如要展現(xiàn)的信息需要從數(shù)據(jù)庫獲取,或者是第三方服務(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è)簡單的node應(yīng)用結(jié)構(gòu)就是這樣，如此便實(shí)現(xiàn)了用Egg.js負(fù)責(zé)接口服務(wù)。

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

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

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/108113.html

發(fā)表評論

登陸后可評論

0條評論

idealcn

男|高級講師

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

TA的文章

常用軟件WinRAR中現(xiàn)新安全漏洞可致攻擊者入侵網(wǎng)絡(luò)修改數(shù)據(jù)

閱讀 2757·2021-10-26 09:50
穩(wěn)愛云：香港CN2 GIA，2核/2G/20M帶寬，月付34元，美國CERA聯(lián)通首月半價(jià)25元

閱讀 2402·2021-10-11 11:08
那些年，我的前端/Java后端書單

閱讀 2139·2019-08-30 15:53
博客喬遷，特此mark

閱讀 1915·2019-08-30 15:44
關(guān)于CSS Reset 那些事（一）之歷史演變與Normalize.css

閱讀 2391·2019-08-28 18:12
仿美團(tuán)城市選擇器的 Vue 插件開發(fā)實(shí)例

閱讀 2532·2019-08-26 13:59
JavaScript的String類型

閱讀 2862·2019-08-26 12:19
Egg.js搭建后臺服務(wù)API

閱讀 2762·2019-08-26 12:09

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN