Egg.js 代码风格指南

🌙
手机阅读
本文目录结构
axihe

建议开发者使用 npm init egg --type=simple showcase 来生成并观察推荐的项目结构和配置。

用类的形式呈现(Classify)

旧写法:

module.exports = app => {
  class UserService extends app.Service {
    async list() {
      return await this.ctx.curl('https://eggjs.org');
    }
  }
  return UserService;
};

修改为:

const Service = require('egg').Service;
class UserService extends Service {
  async list() {
    return await this.ctx.curl('https://eggjs.org');
  }
}
module.exports = UserService;

同时,框架开发者需要改变写法如下,否则应用开发者自定义 Service 等基类会有问题:

const egg = require('egg');

module.export = Object.assign(egg, {
  Application: class MyApplication extends egg.Application {
    // ...
  },
  // ...
});

私有属性与慢初始化

  • 私有属性用 Symbol 来挂载。
  • Symbol 的描述遵循 jsdoc 的规则,描述映射后的类名 + 属性名。
  • 延迟初始化。

    // app/extend/application.js
    const CACHE = Symbol('Application#cache');
    const CacheManager = require('/edu/egg//edu/egg/lib/cache_manager');
    
    module.exports = {
    get cache() {
    if (!this[CACHE]) {
      this[CACHE] = new CacheManager(this);
    }
    return this[CACHE];
    },
    }
    

AXIHE / 精选资源

浏览全部教程

面试题

学习网站

前端培训
自己甄别

前端书籍

关于朱安邦

我叫 朱安邦,阿西河的站长,在杭州。

以前是一名平面设计师,后来开始接接触前端开发,主要研究前端技术中的JS方向。

业余时间我喜欢分享和交流自己的技术,欢迎大家关注我的 Bilibili 和抖音。

关注我: Github / 知乎

如果你加我的私人微信,麻烦写上您的 称呼,所在地区,职业,方便我备注,谢谢


本站的微信公众号

阿西河前端教程

Anbang

安邦的私人微信

微信号: yaolushan

Anbang

Bilibili(B站)

朱安邦

Anbang