5.extend的详细用法

一、重点

官网： https://eggjs.org/zh-cn/basics/extend.html

可扩展

Application
Context
Request
Response
Helper

需注意要在app下新建目录extend文件夹，根据官网创建对应的文件

application.js 、context.js 、 request.js 、response.js、 helper.js

二、application的扩展和使用

1.扩展

@file(application.js)

/*
    外部可以通过 this.app.foo() 来调用
*/
module.exports = {
    foo(params) {
        console.log('extend-app: 我是扩展方法');
    }
}

2.使用

Controller，Middleware，Helper，Service 中都可以通过 this.app来调用。

class HomeController extends Controller {
    async index() {
        // extend-application
        this.app.foo();  
        await this.ctx.render('home');
    }
}

二、context的扩展和使用

1.扩展

@file(context.js)

module.exports = {
    // this 就是 ctx 对象，在其中可以调用 ctx 上的其他方法，或访问属性
    getHost() {
        let host = this.request.header.host;
        console.log('extend-ctx: ', host);
        return host;
    }
}

2.使用

1. middleware 中 this 就是 ctx，例如 this.cookies.get('foo')。
2. controller 有两种写法，类的写法通过 this.ctx，方法的写法直接通过 ctx 入参。
3. helper，service 中的 this 指向 helper，service 对象本身，使用 this.ctx 访问 context 对象，例如 this.ctx.cookies.get('foo')。

例子：controller使用方式

class HomeController extends Controller {
    async index() {
        // extend-application
        this.app.foo();  
        await this.ctx.render('home');
    }
}

三、helper的扩展和使用

1.扩展

@file(application.js)

module.exports = {
    formatDate(date) {
        let time = '2012';
        console.log('time: ', time);
        return time
    }
}

2.使用

1.controller、service中使用

使用方法： this.ctx.helper.fn()

class HomeController extends Controller {
    async index() {        
        this.ctx.helper.formatDate(1453426595000);
    }
}

2.html中使用

使用：helper.fn()

<span><%=helper.formatDate(list[i].dateline)%></span>

四、request的扩展和使用

1.扩展

/*
    外部使用方式：this.ctx.request.fn()
*/
module.exports = {
    rfn(){
        console.log('我是extend-request的方法');
    }
}

2.使用

// controller、service中的使用方法
this.ctx.request.rfn();