EggJS接口开发【黑马web前端】

更新时间:2023年03月06日 11时29分54秒来源:黑马程序员论坛

需求

随着Nodejs的普及，前端开发的开发场景基本可以贯穿界面交互到数据存储，无缝实现全栈开发。最近在实现一个内部项目管理工具的时候，就尝试了一把接口和数据库开发。

什么是Egg.js

Egg.js是阿里开源的一套Nodejs开发框架。Egg.js官网的介绍是：

Egg.js 为企业级框架和应用而生，我们希望由 Egg.js 孕育出更多上层框架，帮助开发团队和开发人员降低开发和维护成本。

为什么选择了Egg.js，而不是Koa，Express呢，其实还是为了快速开发，减少搭建项目的时间，Egg.js已经为开发者设计了几乎最常用的目录结构，一切倾向于配置化，隐藏一些业务无关的技术细节。开发者可以更加着重考虑业务逻辑，然后在Egg.js和相关插件的支持下，开发功能即可。

Egg.js还提倡『约定优于配置』，这一点我也是很赞同，一致的约定能够减少不必要的失误，同时保证了一致的开发体验，可以方便的维护不同的项目。

初始化项目

Egg.js提供了脚手架快速初始化项目，但是要求npm >=6.1.0，这基本不是问题。

[size=1em]

$ mkdir egg-example && cd egg-example
$ npm init egg --type=simple
$ npm i

然后启动项目

[size=1em]

1 2	$ npm run dev $ open http://localhost:7001

目录设计

因为Egg.js已经做了太多事情，我只需要关注app和config。

[size=1em]

app/router.js 用于配置URL路由规则，也就是你访问的接口地址，对应的是哪个controller的逻辑。

app/controller/** 用于解析用户的输入，处理后返回相应的结果，这里其实可以写service和model的逻辑，但是按照单一职责的原则，我们会在controller主要放置参数解析和返回值，以及非数据库操作的逻辑。

app/service/** 用于编写业务逻辑层，可选，建议使用，你可以理解成对数据库操作的封装。

app/model/** 用于定义mongodb的schema，这部分很神奇的是Egg.js已经封装mongodb链接数据库，并将model绑定到了ctx上，方便调用。

config/config.default.js 用于编写配置文件，可以配置不同的开发环境，不同的变量，但是因为业务比较单一，内部使用，所以只使用了默认设置。我的项目中配置了跨域、mongoose、csrf，等等。

[size=1em]

config.mongoose = {
url: "mongodb://127.0.0.1/*****",
options: {}
};

config.cors = {
origin: '*',
allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH'
}

config.security = {
csrf: {
enable: false,
},
};

config/plugin.js 用于配置需要加载的插件，比如egg-mongoose，egg-cors。

[size=1em]

module.exports = {
mongoose: {
      enable: true,
      package: "egg-mongoose"
},
cors: {
      enable: true,
      package: "egg-cors"
}
};

这里需要注意的是，很多博客提供的代码都是ES6的代码，在我初始化的模板中是不可行的，如下：

[size=1em]

exports.cors = {
enable: true,
package: 'egg-cors',
}

开发项目

基础搭建好了，开发就变得很简单了，我遵循的逻辑是：Model-->路由-->Contoller-->Service，先设计数据库Schema，然后增加新的路由，支持对应的Controller，然后在Service中完成数据库操作。

router.js

[size=1em]

router.get("/api/task", controller.task.index);
router.post("/api/task", controller.task.create);
router.put("/api/task/:id", controller.task.update);
router.delete("/api/task/:id", controller.task.destroy );

// 也可以简写为
router.resources('topics', '/api/task', controller.task);

controller中实现的方法具体可以参考下面的对应关系

MethodPathRoute NameController.Action
GET/postspostsapp.controllers.posts.index
GET/posts/newnew_postapp.controllers.posts.new
GET/posts/:idpostapp.controllers.posts.show
GET/posts/:id/editedit_postapp.controllers.posts.edit
POST/postspostsapp.controllers.posts.create
PUT/posts/:idpostapp.controllers.posts.update
DELETE/posts/:idpostapp.controllers.posts.destroy

controller/task.js

[size=1em]

exports.index = function*() {
// ...
const result = yield this.service.task.index(this.params);
this.body = result;
};

exports.create = function*() {
// ...
const result = yield this.service.task.create(this.request.body);
this.body = result;
};

exports.update = function*() {
// ...
const result = yield this.service.task.update(this.params.id, this.request.body);
this.body = result;
};

exports.destroy = function*() {
// ...
const result = yield this.service.task.destroy(this.params);
this.body = result;
};

service/task.js

[size=1em]

module.exports = app => {
class TaskService extends app.Service {
      *index(params) {
         let tasks = yield this.ctx.model.Task.find(params);
         let result = {};
         result.data = tasks;
         return result;
      }

      *create(request) {
      }

      *update(id, request) {
      }

      *destroy(params) {
      }
}
return TaskService;
};

model/task.js

[size=1em]

module.exports = app => {
const mongoose = app.mongoose;
const Schema = mongoose.Schema;
const TaskSchema = new Schema({
      id: {type: Number},
      text: {type: String},
      type: {type: String},
      progress: {type: Number},
      open: {type: Boolean},
      start_date: {type: String},
      owner_id: [{type: String}],
      duration: {type: Number},
      parent: {type: Number}
});
return mongoose.model("Task", TaskSchema);
};

部署

Egg.js 框架内置了 egg-cluster 来启动 Master 进程，Master 有足够的稳定性，不再需要使用 pm2 等进程守护模块。只需要两个命令即可：

[size=1em]

# 启动服务
npm start
# 关闭服务
npm run stop

结语

站在巨人的肩膀上，让我们的开发效率倍增，但是还是建议大家先从Koa2学起，对然后对比Egg.js，你就会了解它到底封装了哪些东西，为我们节省了多少工作量，后面还要继续对Egg.js的插件开发进行了解。

推荐了解热门学科

java培训	Python人工智能	Web前端培训	PHP培训
区块链培训	影视制作培训	C++培训	产品经理培训
UI设计培训	新媒体培训	产品经理培训	Linux运维
大数据培训	智能机器人软件开发

传智播客是一家致力于培养高素质软件开发人才的科技公司，“黑马程序员”是传智播客旗下高端IT教育品牌。自“黑马程序员”成立以来，教学研发团队一直致力于打造精品课程资源，不断在产、学、研3个层面创新自己的执教理念与教学方针，并集中“黑马程序员”的优势力量，针对性地出版了计算机系列教材50多册，制作教学视频数+套，发表各类技术文章数百篇。

传智播客从未停止思考

传智播客副总裁毕向东在2019IT培训行业变革大会提到，“传智播客意识到企业的用人需求已经从初级程序员升级到中高级程序员，具备多领域、多行业项目经验的人才成为企业用人的首选。”

中级程序员和初级程序员的差别在哪里?
项目经验。毕向东表示，“中级程序员和初级程序员最大的差别在于中级程序员比初级程序员多了三四年的工作经验，从而多出了更多的项目经验。“为此，传智播客研究院引进曾在知名IT企业如阿里、IBM就职的高级技术专家，集中研发面向中高级程序员的课程，用以满足企业用人需求，尽快补全IT行业所需的人才缺口。

何为中高级程序员课程?

传智播客进行了定义。中高级程序员课程，是在当前主流的初级程序员课程的基础上，增加多领域多行业的含金量项目，从技术的广度和深度上进行拓展。“我们希望用5年的时间，打造上百个高含金量的项目，覆盖主流的32个行业。”传智播客课程研发总监于洋表示。

黑马程序员热门视频教程【点击播放】

Python入门教程完整版（懂中文就能学会）	零起点打开Java世界的大门
C++\| 匠心之作从0到1入门学编程	PHP\|零基础入门开发者编程核心技术
Web前端入门教程_Web前端html+css+JavaScript	软件测试入门到精通

全国中心

EggJS接口开发【黑马web前端】

最新资讯

相关阅读