Typescript + Egg.js实践

Egg.js是阿里开源的基于Koa的一个企业级Node框架,具体介绍在这里不做详细说明,想要了解更多可以查看Egg.js文档

*.d.ts

Egg.js搭配Typescript开发的关键就是*.d.ts文件。

Egg.js本身并不是使用Typescript开发,但是它提供了相对应的index.d.ts文件,让你可以使用TS引入Egg。

Egg提供给你它的index.d.ts,但是在工作中,你自己编写的Controller、Service、Helper等,都需要自己编写index.d.ts文件放在typings文件夹下,好在Egg提供了一个工具可以自动分析你的代码生成相对于的d.ts文件,你需要全局安装egg-ts-helper工具:

$ npm install egg-ts-helper -g

安装成功后在你编写完Controller或者Service后,手动执行命令$ ets 或者你可以选择新开一个命令行执行$ ets -w 它可以检测你的文件修改,自动生成对应的d.ts文件。

Controller和Service的编写在文官方档上写的很清晰,也没有什么需要特别注意的点。

Helper

在工作中或者使用Egg写demo的时候,你可能会用到一些util函数,官方推荐写在helper.js中,但是你在实际使用Ts在Helper中写函数的时候,你会碰到一个问题,官方文档中说明,你可以在helper.js中使用this.ctx以及this.app获取Context和Application对象,但是你直接在helper.js中写this.ctx或者this.app的时候,会报异常,这是Egg的自动加载机制导致的,你需要手动在函数中指定this的类型:

import {

    IHelper,

} from 'egg';

export default {

    test(this: IHelper) {

        const { ctx, app } = this;

    }

};

这样你就可以在helper.js中愉快的使用ctx和app对象了。

plugin

在使用Egg的插件时,也有一点需要注意,比如我使用egg-redis插件。

plugin.ts

import { EggPlugin } from 'egg';

const plugin: EggPlugin = {

    static: true,

    nunjucks: {

        enable: true,

        package: 'egg-view-nunjucks',

    },

    redis: {

        enable: true,

        package: 'egg-redis',

    },

};

export default plugin;

config.default.ts

// ...

config.redis = {

  client: {

      port: 6379,

      host: '127.0.0.1',

      password: '',

      db: 0,

  },

};

// ...

这时,按照文档说明,你可以在Controller或者Service中使用this.app.redis来操作redis,但实际上会报错,这个问题也是由于redis没有在Application中进行声明导致的,我尝试在typings下的index.d.ts中做声明

typings/index.d.ts

declare module 'egg' {

    interface Application {

        redis;

    }

}

声明后,可以正常使用this.app.redis,但是我不确定这种方式是否正确~

Model

 在实际使用中,免不了操作数据库,我使用的是mongoDB,在plugin和config中配置好egg-mongoose插件后,你需要在你的app文件夹下新增一个model文件夹,在该文件夹下编写你的Model:

app/model/user.ts

export default (app) => {

    const mongoose = app.mongoose;

    const Schema = mongoose.Schema;

    const userSchema = new Schema({

        mobile: {

            type: String,

            required: true,

        },

        password: {

            type: String,

            required: true,

        },

    });

    return mongoose.model('User', userSchema);

};

这时,如果你的ets -w 没有关闭的话,在你工程目录的typings文件夹下生成了一个名叫model的文件夹。现在你可以在你的Controller和Service中使用this.ctx.model.User获取到模型对象。

这里需要注意,我不清楚你们是如何开发的,在我使用Egg之前,我习惯在Model中编写对数据库操作的代码,原本我准备在Model中操作数据库,但都以失败而告终,仔细查看文档后发现:

对数据库的访问操作属于Web层中的数据处理层,因此我们强烈建议将这部分代码放在Service层中维护。

在Egg中,推荐在Service中操作数据库,既然这样,我也只能“入乡随俗”啦。

本人只是Node菜鸟,对Egg的了解也不深,有不对的地方希望大神们能指出,求轻喷!感谢!!!

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,097评论 18 139
  • 默默的活着 经受时光的 荏苒变迁 承受岁月的 风霜雨雪 时光 留下一条条 印迹 岁月 刻下一道道 年轮 就这样 默...
    清晨的风儿阅读 213评论 0 3
  • 想知道咋夜狂风爆雨留下的 泽国汪洋 想知道今朝风和日丽孕育的 田园花香 想沿着梦想轨迹遥望遥远星河 但那儿更静,更...
    江城妖怪阅读 133评论 0 0
  • 【韩喜文2017.12.26星期二】 好展馆让天下没有卖不出去产品 好展馆让天下没有不能传承的文化 日精进:726...
    韩喜文阅读 68评论 0 1
  • #心灵自由写作群# 第4篇 2018.6.6 今天是到新工作单位报到的第一天,我感觉自己发挥得不错,上台自我介绍时...
    菲梵飞阅读 157评论 0 0