摘要：是阿里推出的基于的開發(fā)框架，今天抽空體驗了下，按官方教程做一個。用于解析用戶的輸入，處理后返回相應(yīng)的結(jié)果，具體參見。用于編寫業(yè)務(wù)邏輯層，可選，建議使用，具體參見。和用于自定義啟動時的初始化工作，可選，具體參見啟動自定義。

egg.js是阿里推出的基于koa的node開發(fā)框架，今天抽空體驗了下，按官方教程做一個Hacker News。其實官方有腳手架提供，但是這次我們不用。

開始之前，我們先看下KOA對于中間件的洋蔥模型，了解這個，對于我們之后理解一個請求的執(zhí)行路徑會很有幫助。

好了，讓我們開始我們的egg之旅吧！

1, 先初始化項目結(jié)構(gòu)：

$ mkdir egg-example
$ cd egg-example
$ npm init
$ npm i egg --save
$ npm i egg-bin --save-dev

2, 在package.json里，添加如下命令：

"scripts": {
    "dev": "egg-bin dev"
  }

3， 開始編寫代碼，這之前，我們應(yīng)該對項目的目錄結(jié)構(gòu)有個約定，官方的說明在這里 https://eggjs.org/zh-cn/basic... 我們到時候在回來說下這個目錄。

4 我們需要一個controller，一個router，一個config，內(nèi)如如下

// app/controller/home.js
const Controller = require("egg").Controller;

class HomeController extends Controller {
  async index() {
    this.ctx.body = "Hello world";
  }
}

module.exports = HomeController;

// app/router.js
module.exports = app => {
  const { router, controller } = app;
  router.get("/", controller.home.index);
};


// config/config.default.js
exports.keys = <此處改為你自己的 Cookie 安全字符串>;

此時，目錄結(jié)構(gòu)如下：

egg-example
├── app
│   ├── controller
│   │   └── home.js
│   └── router.js
├── config
│   └── config.default.js
└── package.json

好了，現(xiàn)在檢查下，運行 npm run dev，
在 http://127.0.0.1:7001/ 檢查下，一切ok

這里有幾個地方要注意下

Controller 有class和exports兩個寫法，那么這兩個寫法有什么區(qū)別呢？

按照類的方式編寫Controller，不僅可以讓我們更好的對 Controller層代碼進(jìn)行抽象（例如將一些統(tǒng)一的處理抽象成一些私有方法），還可以通過自定義Controller 基類的方式封裝應(yīng)用中常用的方法。至于方法的方式，官方不推薦使用，只是為了做兼容，其中，每一個 Controller 都是一個 async function，它的入?yún)檎埱蟮纳舷挛?Context 對象的實例，通過它我們可以拿到框架封裝好的各種便捷屬性和方法 

config也有module.exports 和 exports兩種寫法，那么這兩種寫法有什么區(qū)別呢？

module.exports是Module系統(tǒng)創(chuàng)建對象的語法，但是如果你希望你的
module是一個類的實例，你可以將實例賦予moduel.exports，如這時候
module.exprots指向的就是一個A的實例了，可以用以下方式調(diào)用A的方
法 module.exports.xxx(),等價于 a.xxx()。但是如果只是exports=
new ClassA();這個只是簡單的將本模塊變量exports重新綁定了而已。注
意，對module.exports的綁定不能是異步綁定或者回調(diào)中！

可以這樣理解，其他模塊使用本模塊時，用的是module.exports指向的東
西，而exports是模塊內(nèi)部變量，外部模塊是無法訪問的。
module.exports和exports是兩個變量，只是一開始這兩個是指向同一個對
象而已?？梢栽谀K內(nèi)部用exports作為module.exports的快捷方式

現(xiàn)在，我們看下官方的目錄結(jié)構(gòu)規(guī)范：

egg-project
├── package.json
├── app.js (可選)
├── agent.js (可選)
├── app
|   ├── router.js
│   ├── controller
│   |   └── home.js
│   ├── service (可選)
│   |   └── user.js
│   ├── middleware (可選)
│   |   └── response_time.js
│   ├── schedule (可選)
│   |   └── my_task.js
│   ├── public (可選)
│   |   └── reset.css
│   ├── view (可選)
│   |   └── home.tpl
│   └── extend (可選)
│       ├── helper.js (可選)
│       ├── request.js (可選)
│       ├── response.js (可選)
│       ├── context.js (可選)
│       ├── application.js (可選)
│       └── agent.js (可選)
├── config
|   ├── plugin.js
|   ├── config.default.js
│   ├── config.prod.js
|   ├── config.test.js (可選)
|   ├── config.local.js (可選)
|   └── config.unittest.js (可選)
└── test
    ├── middleware
    |   └── response_time.test.js
    └── controller
        └── home.test.js

如上，由框架約定的目錄：
app/router.js 用于配置 URL 路由規(guī)則，具體參見 Router。
app/controller/** 用于解析用戶的輸入，處理后返回相應(yīng)的結(jié)果，具體參見 Controller。
app/service/** 用于編寫業(yè)務(wù)邏輯層，可選，建議使用，具體參見 Service。
app/middleware/** 用于編寫中間件，可選，具體參見 Middleware。
app/public/** 用于放置靜態(tài)資源，可選，具體參見內(nèi)置插件 egg-static。
app/extend/** 用于框架的擴(kuò)展，可選，具體參見框架擴(kuò)展。
config/config.{env}.js 用于編寫配置文件，具體參見配置。
config/plugin.js 用于配置需要加載的插件，具體參見插件。
test/** 用于單元測試，具體參見單元測試。
app.js 和 agent.js 用于自定義啟動時的初始化工作，可選，具體參見啟動自定義。關(guān)于agent.js的作用參見Agent機(jī)制。

由內(nèi)置插件約定的目錄：
app/public/** 用于放置靜態(tài)資源，可選，具體參見內(nèi)置插件 egg-static。
app/schedule/** 用于定時任務(wù)，可選，具體參見定時任務(wù)。

若需自定義自己的目錄規(guī)范，參見 Loader API
app/view/** 用于放置模板文件，可選，由模板插件約定，具體參見模板渲染。
app/model/** 用于放置領(lǐng)域模型，可選，由領(lǐng)域類相關(guān)插件約定，如 egg-sequelize。

（未完待續(xù)）