Controller / 控制器

MVC 模型中,控制器是用户请求的逻辑处理部分。比如:将用户相关的操作都放在 user.js 里,每一个操作就是里面一个 Action。

创建 Controller

项目中的 controller 需要继承 think.Controller 类,这样能使用一些内置的方法。当然项目中可以创建一些通用的基类,然后实际的 controller 都继承自这个基类。

项目创建时会自动创建了一个名为 base.js 的基类,其他 controller 继承该类即可。

//src/controller/user.js

const Base = require('./base.js');
module.exports = class extends Base {
  indexAction(){
    this.body = 'hello world!';
  }
}

创建完成后,框架会监听文件变化然后重启服务。这时访问 http://127.0.0.1:8360/user/index 就可以看到输出的 hello word!

Action 执行

Action 执行是通过中间件 think-controller 来完成的,通过 ctx.action 值在 controller 寻找 xxxAction 的方法名并调用,且调用相关的魔术方法,具体顺序为:

  • 实例化 Controller 类,传入 ctx 对象
  • 如果方法 __before 存在则调用,如果返回值为 false,则停止继续执行
  • 如果方法 xxxAction 存在则执行,如果返回值为 false,则停止继续执行
  • 如果方法 xxxAction 不存在但 __call 方法存在,则调用 __call,如果返回值为 false,则停止继续执行
  • 如果方法 __after 存在则执行

前置操作 __before

项目中,有时候需要在一个统一的地方做一些操作,如:判断是否已经登录,如果没有登录就不能继续后面行为。此种情况下,可以通过内置的 __before 来实现。

__before 是在调用具体的 Action 之前调用的,这样就可以在其中做一些处理。

module.exports = class extends think.Controller {
  async __before(){
    const userInfo = await this.session('userInfo');
    //获取用户的 session 信息,如果为空,返回 false 阻止后续的行为继续执行
    if(think.isEmpty(userInfo)){
      return false;
    }
  }
  indexAction(){
    // __before 调用完成后才会调用 indexAction
  }
}

如果类继承需要调用父级的 __before 方法的话,可以通过 super.__before 来完成,如:

module.exports = class extends Base {
  __before(){
    // 通过 Promise.resolve 将返回值包装为 Promise
    // 如果返回值确定为 Promise,那么就不需要再包装了
    return Promise.resolve(super.__before()).then(flag => {
      // 如果父级想阻止后续继承执行会返回 false,这里判断为 false 的话不再继续执行了。
      if(flag === false) return false;

      // 其他逻辑代码
    })
  }
}

如果不需要 Babel 转译,那么可以用下面更简洁的方式:

module.exports = class extends Base {
  async __before(){
    const flag = await super.__before();
    // 如果父级想阻止后续继承执行会返回 false,这里判断为 false 的话不再继续执行了。
    if(flag === false) return false;
    ...
  }
}

后置操作 __after

后置操作 __after__before 对应,只是在具体的 Action 执行之后执行,如果具体的 Action 执行返回了 false,那么 __after 不再执行。

module.exports = class extends think.Controller {
  indexAction(){

  }
  __after(){
    //indexAction 执行完成后执行,如果 indexAction 返回了 false 则不再执行
  }
}

注:此方法可能会在后续的版本中废弃,如果有类似需求,可以通过中间件类完成。

魔术方法 __call

当解析后的 url 对应的控制器存在,但 Action 不存在时,会试图调用控制器下的魔术方法 __call。这里可以对不存在的方法进行统一处理。

module.exports = class extends think.Controller {
  indexAction(){

  }
  __call(){
    //如果相应的Action不存在则调用该方法
  }
}

ctx 对象

Controller 实例化时会传入 ctx 对象,在 Controller 里可以通过 this.ctx 来获取 ctx 对象,并且 Controller 上很多方法也是通过调用 ctx 里的方法来实现的。

如果子类中需要重写 constructor 方法,那么需要调用父类中的 constructor,并将 ctx 参数传递进去:

const Base = require('./base.js');
module.exports = class extends Base {
  constructor(ctx){
    super(ctx); // 调用父级的 constructor 方法,并把 ctx 传递进去
    // 其他额外的操作
  }
}

多级控制器

有时候项目比较复杂,文件较多,所以希望根据功能进行一些划分。如:用户端的功能放在一块、管理端的功能放在一块。

这时可以借助多级控制器来完成这个功能,在 src/controller/ 目录下创建 user/admin/ 目录,然后用户端的功能文件都放在 user/ 目录下,管理端的功能文件都放在 admin/ 目录下。访问时带上对应的目录名,路由解析时会优先匹配目录下的控制器。

假如控制器下有 console 子目录,下有 user.js 文件,即:src/controller/console/user.js,当访问请求为 /console/user/login 时,会优先解析出 Controller 为 console/user,Action 为 login

阻止后续逻辑执行

Controller 里的处理顺序依次为 __beforexxxAction__after,有时候在一些特定的场景下,需要提前结束请求,阻止后续的逻辑继续执行。这时候可以通过 return false 来处理。

module.exports = class extends think.Controller {
  __before() {
    if(!user.isLogin) {
      return false; // 这里 return false,那么 xxxAction 和 __after 不再执行
    }
  }
  xxxAction() {
    // action 里 return false,那么 __after 则不再执行
  }
  __after() {

  }
}

获取参数、表单值

对于 URL 上传递的参数或者表单上传的值,框架直接做了解析,可以直接通过对应的方法获取。 对于 URL 上传递的参数,在 Action 中可以通过 get 方法获取。当请求是 POST, PUT, DELETE, PATCH, LINK, UNLINK 时表单提交的字段或者文件可以通过 postfile 方法获取。表单数据解析是通过中间件 think-payload 来完成的,解析后的数据放在 ctx.request.body 对象上,最后包装成 post 和 file 方法供使用。

对于表单数据(文本和文件)的获取,think-payload 中间件会根据请求的 Content-Type 来解析的,默认支持有下面的方式:

  • application/json - 上传的数据格式为 JSON 格式
  • application/x-www-form-urlencoded - 普通的表单数据提交
  • multipart/form-data - 带有文件的表单数据提交
  • text/xml - XML 格式的数据

如果数据格式和 Content-Type 不匹配,那么可能无法获取到对应的数据。

透传数据

由于用户的请求处理经过了中间件、Logic、Controller 等多层的处理,有时候希望在这些环节中透传一些数据,这时候可以通过 ctx.state.xxx 来完成。

// 中间件中设置 state
(ctx, next) => {
  ctx.state.userInfo = {};
}

// Logic、Controller 中获取 state
indexAction() {
  const userInfo = this.ctx.state.userInfo;
}

透传数据时避免直接在 ctx 对象上添加属性,这样可能会覆盖已有的属性,引起一些奇怪的问题。

常见问题

怎么获取 req 和 res 对象?

有时候需要获取 Node 的 reqres 对象,这时候可以通过 this.ctx.reqthis.ctx.res 获取,如:

module.exports = class extends think.Controller {
  indexAction() {
    const req = this.ctx.req;
    const res = this.ctx.res;
    // do something with req & res
  }
}

async/await 和 super 同时使用为什么报错?

module.exports = class extends think.Controller {
  async __before() {
    await super.__before();
  }
}

目前 Babel 的稳定版还是 6.x,这个版本下如果同时使用了 async/await 和 super,那么编译后的代码有问题导致报错,需要等待 7.0 的版本,具体见 https://github.com/babel/babel/issues/3930

目前的解决办法是,不要 async/await 和 super 同时使用,如果必须有 super 调用,那么就直接用 Promise 的方式。如:

module.exports = class extends Base {
  aaa () {
    // 通过 Promise.resolve 将父级方法返回值包装为 Promise,然后就可以用 then 方法了
    return Promise.resolve(super.aaa()).then(data => {
      ...
    })
  }
}

当然如果项目不需要 Babel 编译,那么就可以直接使用。

API

controller.ctx

传递进来的 ctx 对象。

controller.body

设置或者获取返回内容,等同于 ctx.body

controller.ip

  • return {String}

获取当前请求用户的 ip,等同于 ctx.ip

module.exports = class extends think.Controller {
  indexAction() {
    const ip = this.ip; // 获取用户的 IP
  }
}

controller.ips

获取当前请求链路的所有 ip,等同于 ctx.ips

controller.method

获取当前请求的类型,等同于 ctx.method

module.exports = class extends think.Controller {
  indexAction() {
    const method = this.method; // 获取当前请求类型
    if(method === 'OPTIONS') {

    }
  }
}

controller.isGet

判断是否是 GET 请求,等同于 ctx.isGet

module.exports = class extends think.Controller {
  indexAction() {
    if(this.isGet) { // 如果是 GET 请求

    }
  }
}

controller.isPost

判断是否是 POST 请求,等同于 ctx.isPost

module.exports = class extends think.Controller {
  indexAction() {
    if(this.isPost) { // 如果是 POST 请求

    }
  }
}

controller.isCli

  • return {Boolean}

是否是命令行下调用,等同于 ctx.isCli

module.exports = class extends think.Controller {
  indexAction() {
    if(this.isCli) { // 如果是命令行调用

    }
  }
}

controller.userAgent

获取当前请求的 userAgent,等同于 ctx.userAgent

module.exports = class extends think.Controller {
  indexAction() {
    const userAgent = (this.userAgent || '').toLowerCase();
    if(userAgent.indexOf('spider') > -1) {

    }
  }
}

controller.isMethod(method)

判断当前的请求类型是否是指定的类型,等同于 ctx.isMethod

module.exports = class extends think.Controller {
  indexAction() {
    const isDelete = this.isMethod('DELETE'); // 是否是 DELETE 请求
  }
}

controller.isAjax(method)

判断是否是 Ajax 请求。如果指定了 method,那么请求类型也要相同,等同于 ctx.isAjax

module.exports = class extends think.Controller {
  indexAction(){
    //是ajax 且请求类型是 POST
    let isAjax = this.isAjax('post');
  }
}

controller.isJsonp(callback)

是否是 jsonp 请求,等同于 ctx.isJsonp

controller.get(name)

获取 query 参数,等同于 ctx.param。由于 ctx.get 已经被 Koa 使用,所以无法添加 ctx.get 方法。

controller.post(name)

获取 POST 提交的参数,等同于 ctx.post

controller.file(name)

等同于 ctx.file 方法。

controller.header(name, value)

  • name {String} header 名
  • value {String} header 值

获取或者设置 header。

module.exports = class extends think.Controller {
  indexAction(){
    let accept = this.header('accept'); //获取 header
    this.header('X-NAME', 'thinks'); //设置 header
  }
}

controller.expires(time)

设置 Cache-Control 和 Expires 缓存头,等同于 ctx.expires

controller.referer(onlyHost)

获取 referrer,等同于 ctx.referer

controller.referrer(onlyHost)

该方法等同于 controller.referer 方法。

controller.cookie(name, value, options)

操作 cookie,等同于 ctx.cookie

controller.redirect(url)

页面跳转,等同于 ctx.redirect

controller.jsonp(data, callback)

输出 jsonp 格式内容,等同于 ctx.jsonp

controller.json(data)

json 的方式输出内容,等同于 ctx.json

controller.status

设置状态码,等同于 ctx.status

controller.success(data, message)

格式化输出一个正常的数据,一般是操作成功后输出,等同于 ctx.success

controller.fail(errno, errmsg, data)

格式化输出一个异常的数据,一般是操作失败后输出,等同于 ctx.fail

controller.download(filepath, filename)

下载文件,等同于 ctx.download

controller.controller(name, m)

  • name {String} 控制器名称
  • m {String} 模块名,多模块项目下有效
  • return {Object} 控制器实例

获取另一个控制器的实例,如果不存在则报错。

module.exports = class extends think.Controller {
  indexAction() {
    // 获取其他控制器实例,然后调用其方法
    const userController = this.controller('user');
    userController.xxx();
  }
  index2Action() {
    // 获取子级控制器实例,然后调用其方法
    const userController = this.controller('console/user');
    userController.xxx();
  }
  index3Action() {
    // 获取 admin 模块下控制器实例,然后调用其方法
    const userController = this.controller('console/user', 'admin');
    userController.xxx();
  }
}

controller.action(controller, name, m)

  • controller {String | Object} 控制器名称,会通过 this.controller 获取到控制器实例
  • name {String} Action 名称
  • m {String, Optional} 模块名,多模块项目下有效
  • return {Mixed}

调用其他控制器下的 Action 方法,会自动调用 __before__after 之类的魔术方法。

module.exports = class extends think.Controller {
  indexAction() {
    // 调用 user 控制器的 loginAction 方法
    const ret = this.action('user', 'login');
  }
  index2Action() {
    // 调用 front/user 控制器(子级控制器)的 loginAction 方法
    const ret = this.action('front/user', 'login');
  }
  index3Action() {
    // 调用 admin 模块下(多模块项目) user 控制器的 loginAction 方法
    const ret = this.action('user', 'login', 'admin');
  }
}

controller.service(name, m, ...args)

实例化 Service 类,等同于 think.service

如发现文档中的错误,请点击这里修改本文档,修改完成后请 pull request,我们会尽快合并、更新。