Egg.js 基本使用

2023-12-18 16:58
文章标签 使用 js 基本 egg

本文主要是介绍Egg.js 基本使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

我们在上一篇文章Egg.js 源码分析-项目启动, 已经简单的分析了Eggjs 的启动机制, 以及其相应的实现原理,Eggjs 就是针对一系列的约定俗成的规则,在项目启动时,自动加载对应文件夹下面的文件,进行项目的初始化,我们可以参考官网给出的目录结构,去对我们的项目进行规范,包括文件结构规范, 代码逻辑分层规范,从而达到整个项目的规范。

 

 

之所以有这样的一个目录结构 ,其实还是针对于我们上一篇文章Egg.js 源码分析-项目启动 分析所得,在项目启动时,会加载如下的配置, 下面代码后面加了备注,只标注了我们应用对应的文件名称(没有标注eggjs 对应的文件名称)

 

  loadConfig() {// your-project-name/config/plugin.jsthis.loadPlugin();// your-project-name/config/config.default.js // your-project-name/config/`config.${this.serverEnv}`.js super.loadConfig();}
复制代码
  load() {// app > plugin > corethis.loadApplicationExtend();this.loadRequestExtend();this.loadResponseExtend();this.loadContextExtend();this.loadHelperExtend();// your_project_name/app.jsthis.loadCustomApp();// your_project_name/app/service/**.jsthis.loadService();this.loadMiddleware();// your_project_name/app/controller/**.js this.loadController();// your_project_name/ app/router.jsthis.loadRouter(); // Dependent on controllers}
复制代码

从上面可以知道我们应用的一个大致的结构,我们下面就来一一从头开始创建一个项目,深入了解Eggjs 的使用方式(规范)

初始化项目

我们利用egg-init 的手脚架egg-init 先初始化一个项目, 我们可以运行如下命令(一直没怎么接触APP 开发, 所以最近想研究下react-native ,所以创建了一个react-native-learning-server项目):

$ npm i egg-init -g
$ egg-init react-native-learning-server --type=simple
$ cd react-native-learning-server
$ npm i
$ npm run dev
复制代码

浏览器会打开默认端口:http://localhost:7001, 页面会显示hi, egg, 说明我们项目创建成功.

设置路由

我们现在假设我们想做一个类似掘金一样的APP, 我们可以有四个大菜单 Mine , Find , Message, Home

我们简单的设计几个API:

Mine:

APIMethod描叙
/usersGET获取所有的用户
/user/:idGET获取指定用户信息
/userPOST添加用户
/user/:idPUT编辑用户
/user/:idDELETE删除用户

Message:

APIMethod描叙
/messages/:userIdGET获取用户所有的信息
/messagePOST发送信息
/message/:idDELETE删除指定信息

Find:

APIMethod描叙
/search/:keywordGET根据关键字,查询信息

Home:

APIMethod描叙
/hotGET查询最热信息
/heartGET查询关注的热点

我们先只设计如上几个简单的API(我们这篇文章,只是想通过一个伪业务来实现Egg的一些使用方式, 重点是Eggjs 的使用)

上面我们已经初始化了项目, 我们现在编辑app/router.js去设计路由,其代码如下:

module.exports = app => {const { router, controller } = app;router.get('/', controller.home.index);// Userrouter.get('/users', controller.user.findAll);router.get('/user/:id', controller.user.findOne);router.post('/user', controller.user.add);router.put('/user/:id', controller.user.update);router.del('/user/:id', controller.user.delete);// Messagerouter.get('/messages/:userId', controller.message.findByUserId);router.post('/message', controller.message.add);router.del('/messages/:id', controller.message.delete);// Findrouter.get('/search/:keyword', controller.search.find);// Homerouter.get('/hot', controller.home.findHot);router.get('/heart', controller.home.findHeart);
};复制代码

我们先不管Controller的实现, 上面我们就已经实现了我们的路由了, 但是我们发现一个问题,就是当项目越来越大,那这个router.js 会越来越大,也会越来越难以维护,所以我们可以做如下的调整:

  1. 在app下面创建一个文件夹routers, 然后创建四个文件,分别为: user.js, message.js, search.js, home.js,
  2. 然后将router.js 中的路由进行分割,不同的路由都分割到对应的文件下.
  3. 在router.js 中去引用每个单独的路由 拆分后的router.js 如下:
'use strict';
const userRouter = require('./routers/user');
const messageRouter = require('./routers/message');
const homeRouter = require('./routers/home');
const searchRouter = require('./routers/search');
module.exports = app => {const { router, controller } = app;router.get('/', controller.home.index);userRouter(app);messageRouter(app);homeRouter(app);searchRouter(app);
};
复制代码

其routers/user.js 代码如下:

'use strict';module.exports = app => {const { router, controller } = app;router.get('/users', controller.user.findAll);router.get('/user/:id', controller.user.findOne);router.post('/user', controller.user.add);router.put('/user/:id', controller.user.update);router.del('/user/:id', controller.user.delete); 
};复制代码

经过如上的拆分, router.js 的代码变得整洁, 而且相应的路由变得更加容易维护.

设置控制层(Controller)

上面我们已经开发(配置)好了Router, 但是Router 的回调函数,都指向的是app 的controller下面的对象, 如:controller.user.findAll 我们在上一章节已经分析了这个路径怎么来的: controller 是app(应用)的一个属性对象, eggjs 会在启动的时候调用this.loadController(); 方法,去加载整个应用app/controller文件下的所有的js 文件, 会将文件名作为属性名称,挂载在app.controller 对象上, 然后将对应js 文件export(暴露)出来的所有的方法有挂在在文件名称为属性的对象上,然后就可以通过controller.user.findAll这样的方式来引用Controller 下面的方法了。

有了这个思路,我们就可以很清晰的去维护我们控制层了,下面是我们一个home的范例:

'use strict';const Controller = require('egg').Controller;class HomeController extends Controller {async index() {this.ctx.body = 'hi , egg.';}async findHot() {this.ctx.body = this.ctx.request.url;}async findHeart() {this.ctx.body = this.ctx.request.url;}
}module.exports = HomeController;复制代码

设置Service

我们已经开发好了Router 和Controller , 但是在我们的controller 中,都是静态的内容, 一个项目我们需要跟数据库交互,我们一般将跟DB 交互的内容,都放在Service 层,下面我们就来开发我们的service.

我们首先在app目录下面,创建一个service 目录, 并且创建 user.js, message.js, search.js, home.js,文件, 我们先不连接真实的数据库, 创建的service 如下(home.js):

'use strict';const Service = require('egg').Service;class HomeService extends Service {async index() {return 'hi, egg';}findHot() {const hotArticle = [{title: 'Title 0001',desc: 'This is hot article 0001',},{title: 'Title 0002',desc: 'This is hot article 0002',},];return hotArticle;}findHeart() {const heartArticle = [{title: 'Title 0001',desc: 'This is heart article 0001',},{title: 'Title 0002',desc: 'This is heart article 0002',},];return heartArticle;}
}module.exports = HomeService;
复制代码

我们接下来修改Controller文件:

'use strict';const Controller = require('egg').Controller;class HomeController extends Controller {async index() {this.ctx.body = this.service.home.index();}async findHot() {this.ctx.body = this.service.home.findHot();}async findHeart() {this.ctx.body = this.service.home.findHeart();}
}module.exports = HomeController;复制代码

我们调用service方法如: this.service.home.index();, 跟controller 原理类似。

到此位置,我们项目的基本框架,已经搭建完成,我们现在可以思考先,我们怎么连接数据库。

连接DB

我们的数据库我们选择用MongoDB, 所以,我们可以选择用egg-mongoose 插件,我们可以按照文档进行操作: 首先安装插件:

$ npm i egg-mongoose --save

因为egg-mongoose 是作为Eggjs 的一个插件,所以我们要配置这个插件,我们现在app/config/plugin.js中配置插件:

'use strict';
module.exports = {// enable plugins mongoose: {enable: true,package: 'egg-mongoose',},
};
复制代码

接下来,我们要配置MongoDB 的连接, 我们修改app/config/config.default.js

'use strict';module.exports = appInfo => {const config = exports = {};// use for cookie sign key, should change to your own and keep securityconfig.keys = appInfo.name + '_1541735701381_1116';// add your config hereconfig.middleware = [];config.cluster = {listen: {path: '',port: 7001,hostname: '',},};config.mongoose = {client: {url: 'mongodb://127.0.0.1/react-native-demo',options: {},},};return config;
};复制代码

接下来我们需要给MongoDB 配置Model,我们在app 目录下面,创建一个model 文件夹, 并且创建user.js, 代码如下:

'use strict';
// {app_root}/app/model/user.js
module.exports = app => {const mongoose = app.mongoose;const Schema = mongoose.Schema;const UserSchema = new Schema({userName: { type: String },password: { type: String },});return mongoose.model('User', UserSchema);
};
复制代码

然后我们接下来,修改Service 来真正的连接数据库,修改service/user.js 代码如下:

'use strict';
const Service = require('egg').Service;class UserService extends Service {async findAll() {return await this.ctx.model.User.find();}
}module.exports = UserService;复制代码

连接数据库的真个流程完成了,我们可以打开http://localhost:7001/users, 页面就会显示从MongoDB 数据库里面查询的所有的数据。

总结

  1. 安装插件: $ npm i egg-mongoose --save
  2. 配置插件: app/config/plugin.js中配置插件
  3. 配置连接: 我们修改app/config/config.default.js,添加egg-mongoose连接信息
  4. 创建Model: 我们在{app_root}/app/model/user.js 下创建Model.
  5. 修改Service: 修改Servcie 的代码,操作MongoDB, await this.ctx.model.User.find();

问题

  1. 在上一篇文章Egg.js 源码分析-项目启动中,我们并没有分析到,eggjs 会加载model 文件夹下面的文件.那这里的model 目录下的文件是什么时候加载上的?
  2. config.default.js 中,配置mongoose 的连接信息,挂载在config.mongoose上, mongoose这个名称是否是固定的, 可以修改成其他的?
  3. app/config/plugin.js中,配置mongoose的插件信息, mongoose 的属性名称是否是固定的, 可以修改成其他的?

答案

  1. 在eggjs 中,并没有实现加载model 的功能,但是egg-mongoose这个插件实现了这个功能,其代码如下:
function loadModelToApp(app) {const dir = path.join(app.config.baseDir, 'app/model');app.loader.loadToApp(dir, 'model', {inject: app,caseStyle: 'upper',filter(model) {return typeof model === 'function' && model.prototype instanceof app.mongoose.Model;},});
}复制代码
  1. 必须叫做mongoose这个名称,因为在egg-mongoose这个插件中,会直接去读取应用中app.config.mongoose 的配置const { client, clients, url, options, defaultDB, customPromise, loadModel } = app.config.mongoose;,所以这个规则是egg-mongoose插件制定的。
  2. plugin.js的配置名称, 不是固定的, 可以随意,因为其真正重要的配置是: package: 'egg-mongoose',指明这个pulgin 用的是那个具体的包。

初始化数据

在一个项目上线的时候,我们经常需要准备一些初始化数据, 比如用户数据,我们一般会创建一个超级管理员的帐号, 这个帐号,是不需要用户注册的,所以我们可以在项目初始化的时候用脚本生成,我们按照如下步骤进行操作:

  1. 修改app/model/user.js添加isMaster属性,如下:
'use strict';
// {app_root}/app/model/user.js
module.exports = app => {const mongoose = app.mongoose;const Schema = mongoose.Schema;const UserSchema = new Schema({userName: { type: String, required: true },password: { type: String, required: true },isMaster: { type: Boolean, default: false, required: true },});return mongoose.model('User', UserSchema);
};复制代码
  1. {app_root}/app目录下,创建一个data的文件夹,然后创建一个user.json, 其内容如下:
[{"userName": "admin","password": "admin","isMaster": true}
]
复制代码
  1. 因为需要在项目启动的时候,去初始化数据,所以我们在{app_root}目录下,添加一个app.js(this.loadCustomApp()),代码如下:
'use strict';
// app.js
module.exports = app => {app.beforeStart(async () => {if (app.config.initData) {const initUsers = require('./app/data/user.json');const ctx = app.createAnonymousContext();ctx.model.User.create(initUsers, err => {if (err) {app.coreLogger.console.warn('[egg-app-beforeStart] init user data fail %s', err);}});}});
};
复制代码

我们在配置文件中添加了一个initData 的开关用来表示是否需要初始化数据,因为初始化数据,一般就是第一次需要(这个配置,应该作为运行脚本命令的参数传递,这样更易于维护,而且不用每次都去该config.default.js 的代码)

总结

按照上面的操作,我们基本完成了一个项目的基本骨架,我们只需要在上面搭积木就可以了,而且了解了Eggjs 的基本使用。源码


作者:bluebrid
链接:https://juejin.im/post/5bf362f0e51d4543850ff46c
来源:掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

这篇关于Egg.js 基本使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/509138

相关文章

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

Android中Dialog的使用详解

《Android中Dialog的使用详解》Dialog(对话框)是Android中常用的UI组件,用于临时显示重要信息或获取用户输入,本文给大家介绍Android中Dialog的使用,感兴趣的朋友一起... 目录android中Dialog的使用详解1. 基本Dialog类型1.1 AlertDialog(

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

使用Sentinel自定义返回和实现区分来源方式

《使用Sentinel自定义返回和实现区分来源方式》:本文主要介绍使用Sentinel自定义返回和实现区分来源方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Sentinel自定义返回和实现区分来源1. 自定义错误返回2. 实现区分来源总结Sentinel自定

Pandas使用SQLite3实战

《Pandas使用SQLite3实战》本文主要介绍了Pandas使用SQLite3实战,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1 环境准备2 从 SQLite3VlfrWQzgt 读取数据到 DataFrame基础用法:读

JSON Web Token在登陆中的使用过程

《JSONWebToken在登陆中的使用过程》:本文主要介绍JSONWebToken在登陆中的使用过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录JWT 介绍微服务架构中的 JWT 使用结合微服务网关的 JWT 验证1. 用户登录,生成 JWT2. 自定义过滤

Java中StopWatch的使用示例详解

《Java中StopWatch的使用示例详解》stopWatch是org.springframework.util包下的一个工具类,使用它可直观的输出代码执行耗时,以及执行时间百分比,这篇文章主要介绍... 目录stopWatch 是org.springframework.util 包下的一个工具类,使用它

Java使用Curator进行ZooKeeper操作的详细教程

《Java使用Curator进行ZooKeeper操作的详细教程》ApacheCurator是一个基于ZooKeeper的Java客户端库,它极大地简化了使用ZooKeeper的开发工作,在分布式系统... 目录1、简述2、核心功能2.1 CuratorFramework2.2 Recipes3、示例实践3