Egg.js基础入门四:对象扩展

续接上篇～～～

Egg虽然提供了很多内置的方法，但如果有时候感觉不够用，也可以自己对Egg中的方法进行扩展。

Egg.js可以对内部的五种对象进行扩展：

可扩展对象	说明	this指向	使用方式
application	全局应用对象	app对象	this.app
context	请求上下文	ctx对象	this.ctx
request	请求级别的对象，提供了请求相关的属性和方法	ctx.request对象	this.ctx.request
response	请求级别的对象，提供了响应相关的属性和方法	ctx.response对象	this.ctx.response
helper	帮助函数	ctx.helper对象	this.ctx.helper

所有扩展内容必须写在/app/extend目录下

如果我们对application进行扩展，必须在该目录下创建application.js，扩展其他内容同理

所有可扩展对象都可以对属性和方法进行扩展

对属性进行扩展需要使用get/set关键字

application扩展

对扩展进行声明：

// /app/extend/application.js
'use strict'
// 扩展内容必须使用module.exports导出一个对象
module.exports = {
  // 方法扩展
  currentTime(){
    return getTime()
  },

  // 属性扩展,属性扩展需要使用get/set关键字声明
  get timeProp(){
    return getTime()
  }
}

function getTime(){
  let now = new Date()
  let year = now.getFullYear()
  let month = now.getMonth() + 1
  let date = now.getDate()
  let nowTime = year + '/' + month + '/' +date
  return nowTime
}

在控制器中使用：

// /app/controller/demo.js
'use strict';
const Controller = require('egg').Controller;
// 定义一个类继承自引入的Controller
class DemoController extends Controller {

  // application扩展
  async extendApp(){
    // 需要从this中取出app这个全局对象
    const { ctx, app } = this
    // 获取扩展方法返回的内容
    let nowTimeByMethod = app.currentTime()
    // 获取扩展属性返回的内容
    let nowTimeByProp = app.timeProp
    ctx.body = {
      extendMethod: nowTimeByMethod,
      extendProp: nowTimeByProp
    }
  }
}

// 将定义的controller暴露出去
module.exports = DemoController;

context扩展

声明扩展：

// /app/extend/context.js
'use strict'

module.exports = {
  // 方法扩展 - 返回请求参数
  getParams(key){
    // 通过ctx调用，所以this指向ctx
    const method = this.request.method
    if(method === 'GET'){
      return key ? this.query[key] : this.query
    }else{
      return key ? this.request.body[key] : this.request.body
    }
  }
}

在controller中可以通过ctx进行使用

// /app/controller/demo.js
// context扩展
async extendCtx(){
    const { ctx } = this
    // 通过扩展的params获取指定参数
    const params = ctx.getParams('name')
    ctx.body = {
        name: params
    }
}

request扩展

对request扩展

// /app/extend/request.js
'use strict'

module.exports = {
  // 属性扩展
  get token(){
    // this.get('token') 获取ctx.request中的token的值，egg提供的语法,就是获取请求头的字段的值
    // 在控制器中直接使用ctx.request.get('token')也是一样的
    return this.get('token')
    
  }
}

request对象存在于ctx上下文中，所以需要使用ctx.request.的方式来调用

// /app/controller/demo.js
// request扩展
async extendReq(){
    const { ctx } = this
    // request在上下文中，所以我们要通过ctx.request来访问扩展内容
    const token = ctx.request.token
    ctx.body = {
        token
    }
}

response扩展

// /app/extend/resposne.js
'use strict'

module.exports = {
  // 设置属性，使用set关键字，必须接受参数
  set token(token){
    // 设置ctx.response的属性的值，就是设置响应头的字段的值
    this.set('token', token)
  }

}

// /app/controller/demo.js
// response扩展
async extendRes(){
    const { ctx } = this
    // response存在于ctx上下文中，通过ctx.response访问
    ctx.response.token = 'newToken'
    // 在浏览器的响应头就能接收到token这个字段
    ctx.body = 'extendRes'

}

helper扩展

扩展方法：

// /app/extend/helper.js
'use strict'

module.exports = {
  // 方法扩展 - 加密字符串为base64
  base64Encode(str = ''){
    return new Buffer(str).toString('base64')
  }
}

控制器中通过ctx.helper. 使用

// app/controller/demo.js
// helper扩展
async extendHelper(){
    const { ctx } = this
    const { name } = ctx.query.name
    // helper也存在于ctx上下文中
    const text = ctx.helper.base64Encode(name)
    ctx.body = text
}

上边简单演示了一下五种对象的扩展，当然实际开发中不会有这么简单的需求，但本章内容旨在入门，仅对语法进行了演示，后续自己仍需要进行深入学习。

我也会在空闲时间继续学习Egg，如果能有一些理解会继续更新内容。

那么Egg的基础入门系列就到这里啦。