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的了解也不深,有不对的地方希望大神们能指出,求轻喷!感谢!!!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

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

友情链接更多精彩内容