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負責接口服務。