egg 官方文檔之:框架擴展(Application、Context、Request、Response、Helper的訪問方式及擴展)

Application

app 對象指的是 Koa 的全局應用對象,全局只有一個,在應用啓動時被建立。
訪問方式:html

  • ctx.app
  • Controller,Middleware,Helper,Service 中均可以經過 this.app 訪問到 Application 對象,例如 this.app.config 訪問配置對象。
  • 在 app.js 中 app 對象會做爲第一個參數注入到入口函數中
// app.js
module.exports = app => {
  // 使用 app 對象
};

Context

Context 指的是 Koa 的請求上下文,這是 請求級別 的對象,每次請求生成一個 Context 實例,一般咱們也簡寫成 ctx。在全部的文檔中,Context 和 ctx 都是指 Koa 的上下文對象。
訪問方式cookie

  • middleware 中 this 就是 ctx,例如 this.cookies.get('foo')。
  • controller 有兩種寫法,類的寫法經過 this.ctx,方法的寫法直接經過 ctx 入參。
  • helper,service 中的 this 指向 helper,service 對象自己,使用 this.ctx 訪問 context 對象,例如 this.ctx.cookies.get('foo')。

Request

Request 對象和 Koa 的 Request 對象相同,是 請求級別 的對象,它提供了大量請求相關的屬性和方法供使用。
訪問方式
ctx.request
ctx 上的不少屬性和方法都被代理到 request 對象上,對於這些屬性和方法使用 ctx 和使用 request 去訪問它們是等價的,例如 ctx.url === ctx.request.url。
Koa 內置的代理 request 的屬性和方法列表:Koa - Request aliasesapp

Response

Response 對象和 Koa 的 Response 對象相同,是 請求級別 的對象,它提供了大量響應相關的屬性和方法供使用。
訪問方式
ctx.response
ctx 上的不少屬性和方法都被代理到 response 對象上,對於這些屬性和方法使用 ctx 和使用 response 去訪問它們是等價的,例如 ctx.status = 404 和 ctx.response.status = 404 是等價的。
Koa 內置的代理 response 的屬性和方法列表:Koa Response aliases框架

Helper

Helper 函數用來提供一些實用的 utility 函數。
它的做用在於咱們能夠將一些經常使用的動做抽離在 helper.js 裏面成爲一個獨立的函數,這樣能夠用 JavaScript 來寫複雜的邏輯,避免邏輯分散各處。另外還有一個好處是 Helper 這樣一個簡單的函數,能夠讓咱們更容易編寫測試用例。
框架內置了一些經常使用的 Helper 函數。咱們也能夠編寫自定義的 Helper 函數。
訪問方式
經過 ctx.helper 訪問到 helper 對象,例如:koa

// 假設在 app/router.js 中定義了 home router
app.get('home', '/', 'home.index');

// 使用 helper 計算指定 url path
ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
// => /?by=recent&limit=20

按照環境進行擴展

另外,還能夠根據環境進行有選擇的擴展,例如,只在 unittest 環境中提供 mockXX() 方法以便進行 mock 方便測試。函數

// app/extend/application.unittest.js
module.exports = {
  mockXX(k, v) {
  }
};

這個文件只會在 unittest 環境加載。
同理,對於 Application,Context,Request,Response,Helper 均可以使用這種方式針對某個環境進行擴展,更多參見運行環境測試

相關文章
相關標籤/搜索