Eggjs使用总结

1. router
2. Controller
3. Service
4. 日志
5. 定时任务
6. 读取MySQL
6.1. 第一步:在plugin.js中启用
6.2. 第二步:在config.${env}.js中配置
6.3. 第三步:在代码中使用
7. 插件
8. http访问
9. 多线程


以下,假设项目名称为demo

eggjs非常重视约定。比如Controller、Service只能在文件夹demo/app/controller、demo/app/service下;而定时任务只要在demo/app/schedule下就可以自动加载。每个文件夹、文件根据位置即说明了其功能。

注意,在eggjs总大量使用的async和await。这是es6中对Generator函数的补充,其中async相当于定义了一个function方法,而await相当于yield调用function方法

对于mysql,egg-mysql基本上相当于dao层了。因此,eggjs建议在service层使用。所以就没有专门的dao层了。


#1. router

路由所在文件:demo/app/router.js。路由中配置的是路径、http方法、对应的Controller方法。如下示例:

module.exports = app => {
    const {router,controller} = this.app;
    router.get('/',controller.home.getUser);//get 表示是http get方法;第一个参数是路径;第二个参数的结构为:controller.在demo/app/constroller/下的某一个文件名.文件中的方法名
}


#2. Controller

Controller所在文件夹demo/app/controller/*。eggjs规定在controller中尽量只进行参数的转换、校验、返回值的转换等,复杂的业务操作应在Service中进行。Controller可以再次封装,比如使用BaseController继承eggjs的Controller,然后其它的controller继承BaseController即可,这点与Service不同,Service的父类只能是eggjs的Service。使用示例:

const Controller = require('egg').Controller;

class UserController extends Controller{

}
module.exports = UserController;


#3. Service

Service所在文件夹为:demo/app/service/*,Service必须直接继承自eggjs的Service。示例

const Service = require('egg').Service;

class UserService extends Service{

}
module.exports = UserService;


#4. 日志

在Controller、Service中使用日志时,可直接使用,this.logger,有none,warn,info,debug,error等方法。默认目录在项目下logs,其结构为:demo/logs/demo/…,默认以eggjs开头的日志后跟日志的生成者。日志的生成路径及大小可以在demo/app/config/config.${env}.js中进行配置,配置内容如下:

exports.logger = {
    dir:'',//配置日志生成路径
    level:'DEBUG',//日志级别
    //....其它
}


#5. 定时任务

定时任务所在文件夹:demo/app/schedule

定时任务示例:

const Subscription = require('egg').Subscription;

class schedule1 extends Subscription{
    //设置定时任务信息
    static get schedule(){
        return {
            interval:'1m',//设置时间间隔
            type:'all'//所有worker都执行
        }
    }

    //要执行的内容
    async subscirbe(){
        this.logger.info(1);
    }
}


#6. 读取MySQL

使用的是egg-mysql插件。插件使用方法


#6.1. 第一步:在plugin.js中启用

路径demo/config/plugin.js

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


#6.2. 第二步:在config.${env}.js中配置

路径demo/config/config.${env}.js

exports.mysql = {
    // 单数据库信息配置
        client: {
            // host
            host: '127.0.0.1',
            // 端口号
            port: '3306',
            // 用户名
            user: 'root',
            // 密码
            password: '1',
            // 数据库名
            database: 'test',
        },
        // 是否加载到 app 上,默认开启
        app: true,
        // 是否加载到 agent 上,默认关闭
        agent: false,
}


#6.3. 第三步:在代码中使用

如下,在Service中

const mysql = await this.app.mysql.query('sys_user_info',{user_id:'123'});

//也可以拼接sql,注意sql注入的问题
const user = await this.app.mysql.query('select * from sys_user_info t where t.user_id=?',['123']);


#7. 插件

插件的配置在demo/app/config/plugin.js中。注意package和path互斥

//egg-mysql的使用

//nunjucks的使用
exports.nunjucks = {
    enable:true,
    package:'egg-view-nunjucks',//
}


#8. http访问

在应用启动时,httpclient会自动初始化到app中,这样在app.js中就可以直接使用了

//app.js
module.exports = app=>{
    app.beforeStart(async ()=>{
        const result = await app.curl('',{
            method:'post',
            dataType:'json',
            data:{}
        });
    });
}

在Controller或者Service,可以通过ctx.curl使用,因为httpclient默认也设置进去了。

const Controller = require('egg').Controller;

class UserController extends Controller {
    index(){
        this.ctx.curl('',{});
    }
}

module.exports = UserController;

httpclient可在config/config.${env}.js中进行配置。

curl的option中可以进行不同的参数设置。


#9. 多线程

nodejs多线程采用的是如下思路:先启动一个主线程,这个主线程不干别的,主要是用来创建和管理其它线程。它会根据cpu的数目来创建其它业务线程。因为线程间通信和其它共同操作的缘故,需要一个agent线程来做业务线程共同的工作,如记录日志等。每一个业务线程的运行都是当前代码的副本。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342