Egg.js搭建後臺服務API

levin在掘金發表於2018-07-25
JSAPI

寫在前面的話

最近在學習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負責介面服務。

相關文章