Egg.js搭建后臺服務API

idealcn 發布于2019-08-26 12:09 / 2750人閱讀

摘要：因為平常開發都是前后端分離的模式，就想著使用創建后臺服務，寫一套接口配合其他的項目。復雜數據的處理，比如要展現的信息需要從數據庫獲取或者是第三方服務的調用。更新用戶信息用戶信息已更改一個簡單的應用結構就是這樣，如此便實現了用負責接口服務。

寫在前面的話

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

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/108113.html

Egg.js搭建后臺服務API

摘要：因為平常開發都是前后端分離的模式，就想著使用創建后臺服務，寫一套接口配合其他的項目。復雜數據的處理，比如要展現的信息需要從數據庫獲取或者是第三方服務的調用。更新用戶信息用戶信息已更改一個簡單的應用結構就是這樣，如此便實現了用負責接口服務。寫在前面的話最近在學習Egg.js，它是阿里推出的基于Koa的node開發框架，為企業級框架和應用而生。Egg.js 的官方文檔已經很完善了，想學...

dailybird 2019-06-26 17:43 評論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