Egg 代碼風(fēng)格指南

2020-02-06 14:12 更新

建議開發(fā)者使用 npm init egg --type=simple showcase 來生成并觀察推薦的項(xiàng)目結(jié)構(gòu)和配置。

用類的形式呈現(xiàn)(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;

同時,框架開發(fā)者需要改變寫法如下,否則應(yīng)用開發(fā)者自定義 Service 等基類會有問題:

const egg = require('egg');

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

私有屬性與慢初始化

  • 私有屬性用 Symbol 來掛載。
  • Symbol 的描述遵循 jsdoc 的規(guī)則,描述映射后的類名+屬性名。
  • 延遲初始化。
// app/extend/application.js
const CACHE = Symbol('Application#cache');
const CacheManager = require('../../lib/cache_manager');

module.exports = {
get cache() {
if (!this[CACHE]) {
this[CACHE] = new CacheManager(this);
}
return this[CACHE];
},
}


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號