快速入门 - 常见问题 - 《ThinkJS 2.2 官方文档》

常见问题

常见问题

为什么推荐 ES6/7 语法开发项目

ES6/7 里提供了大量的新特性，这些特性会带来巨大的开发便利和效率上的提升。如：ES6 里的 */yield 和 ES7 里的 async/await 特性解决异步回调的问题；箭头函数解决 this 作用域的问题；class 语法糖解决类继承的问题。

虽然现在 Node.js 环境还没有完全支持这些新的特性，但借助 Babel 编译，可以稳定运行在现在的 Node.js 环境中。所以我们尽可以享受这些新特性带来的便利。

开发时，修改文件需要重启服务么？

默认情况下，由于 Node.js 的机制，文件修改必须重启才能生效。

这种方式下给开发带来了很大的不便，ThinkJS 提供了一种文件自动更新的机制，文件修改后可以立即生效，无需重启服务。

自动更新的机制会消耗一定的性能，所以默认只在 development 项目环境下开启。线上代码更新还是建议使用 pm2 模块来管理。

如何修改服务监听的端口

默认情况下，Node.js 服务监听的端口为 8360，如果需要修改的话，可以通过修改配置文件 src/common/config/config.js 来修改，如：

export default {
  port: 1234 //将监听的端口修改为 1234
}

怎么修改视图文件目录结构

默认情况下，视图文件路径为 view/[module]/[controller][action].html。其中控制器和操作之间是用 来连接的，如果想将连接符修改为 /，可以修改配置文件 src/common/config/view.js：

export default {
  file_depr: '/', //将控制器和操作之间的连接符修改为 /
}

如何开启 cluster

线上可以开启 cluster 功能达到利用多核 CPU 来提升性能，提高并发处理能力。

可以在配置文件 src/common/config/env/production.js 中加入如下的配置：

export default {
  cluster_on: true //开启 cluster
}

注：如果使用 PM2 管理服务且开启了 cluster，那么 ThinkJS 里就无需再开启 cluster 了。

修改请求超时时间

默认请求的超时时间是 120s，可以通过修改配置文件 src/common/config/config.js 里 timeout 配置值。

export default {
  timeout: 30, //将超时时间修改为 30s
}

如何捕获异常

JS 本身是无法通过 try/catch 来捕获异步异常的，但使用 async/await 后则可以通过 try/catch 来捕获异常，如：

export default class extends think.controller.base {
  async indexAction(){
    try{  
      await this.getFromAPI1();
      await this.getFromAPI2();
      await this.getFromAPI3();
    }catch(err){
      //通过 err.message 拿到具体的错误信息
      return this.fail(err.message);
    }
  }
}

上面的方式虽然可以通过 try/catch 来捕获异常，但在 catch 里并不知道异常是哪个触发的。

实际项目中，经常要根据不同的错误返回不同的错误信息给用户，这时用整体的 try/catch 就不太方便了。

此时可以通过单个异步接口返回特定值来判断，如：

export default class extends think.controller.base {
  async indexAction(){
    //忽略该接口的错误（该接口的错误不重要，可以忽略）
    await this.getFromAPI1().catch(() => {});
    //异常时返回特定值 false 来判断
    let result = await this.getFromAPI2().catch(() => false);
    if(result === false){
      return this.fail('API2 ERROR');
    }
  }
}

如上面代码所述，通过返回特定值判断就可以方便的知道是哪个异步接口发生了错误，这样就可以针对不同的错误返回不同的错误信息。

如何忽略异常

使用 async/await 时，如果 Promise 返回了一个 rejected Promise，那么会抛出异常。如果这个异常不重要需要忽略的话，可以通过 catch 方法返回一个 resolve Promise 来完成。如：

export default class extends think.controller.base {
  async indexAction(){
    //通过在 catch 里返回 undefined 来忽略异常
    await this.getAPI().catch(() => {});
  }
}

PREVENT_NEXT_PROCESS

在调用有些方法后（如：success）后会发现有个 message 为 PREVENT_NEXT_PROCESS 的错误。这个错误是 ThinkJS 为了阻止后续执行添加的，如果要在 catch 里判断是否是该错误，可以通过 think.isPrevent 方法来判断。如：

module.exports = think.controller({
  indexAction(self){
    return self.getData().then(function(data){
      return self.success(data);
    }).catch(function(err){
      //忽略 PREVENT_NEXT_PROCESS 错误
      if(think.isPrevent(err)){
        return;
      }
      console.log(err.stack);
    })
  }
})

另一种处理方式：对于 success 之类的方法前面不要添加 return，这样 catch 里就不会有此类的错误了。

并行处理

使用 async/await 来处理异步时，是串行执行的。但很多场景下我们需要并行处理，这样可以大大提高执行效率，此时可以结合 Promise.all 来处理。

export default class extends think.controller.base {
  async indexAction(){
    let p1 = this.getServiceData1();
    let p2 = this.getAPIData2();
    let [p1Data, p2Data] = await Promise.all([p1, p2]);
  }
}

上面的代码 p1 和 p2 是并行处理的，然后用 Promise.all 来获取 2 个数据。这样一方面代码是同步书写的，同时又不失并行处理的性能。

如何输出图片

项目中有时候要输出图片等类型的数据，可以通过下面的方式进行：

export default class extends think.controller.base {
  imageAction(){
    //图片 buffer 数据，读取本地文件或者从远程获取
    let imageBuffer = new Buffer();
    this.type('image/png');
    this.end(imageBuffer);
  }
}

如何在不同的环境下使用不同的配置

我们经常在不同的环境下使用不同的配置，如：开发环境和线上环境使用不同的数据库配置。这时可以通过 src/common/config/env/[env].js 来配置，[env] 默认有 development，testing 和 production 3 个值，分别对应开发环境、测试环境和线上环境。这时可以在对应的配置文件设定配置来用在不同的环境下。

如：配置线上环境下的数据库，那么可以在 src/common/config/env/production.js 中配置：

export default {
  db: { //这里要有一级 db
    type: 'mysql',
    adapter: {
      mysql: {
        host: '',
        port: ''
      }
    }
  }
}

详细的数据库配置请见这里。

nunjucks 模板继承路径怎么写

使用 nunjucks 的模板继承时，由于设置了 root_path，所以路径需要使用相对路径。如：

{% extends "./parent.html" %}  //表示同级别目录下的 parent.html 文件
{% extends "../layout.html" %} //表示父级别下的 layout.html 文件

如何让 Action 只允许命令行调用

默认情况下，Action 既可以用户访问，也可以命令行调用。但有些 Action 我们希望只在命令行下调用，这时可以通过 isCli 来判断。如：

export default class extends think.controller.base {
  indexAction(){
    //禁止 URL 访问该 Action
    if(!this.isCli()){
      this.fail('only allow invoked in cli mode');
    }
    ...
  }
}

如何跨模块调用

当项目比较复杂时，会有一些跨模块调用的需求。

调用 controller

可以通过 this.controller 方法传递第二个参数模块名达到调用其他模块下 controller 的功能，如：

export default class extends think.controller.base {
  indexAction(){
    //获取 admin 模块下 user controller 的实例
    let controllerInstance = this.controller('user', 'admin');
    //获取 controller 的实例下就可以调用下面的方法了
    let bar = controllerInstance.foo();
  }
  index2Action(){
    //也可以通过这种更简洁的方式获取
    let controllerInstance = this.controller('admin/user');
    let bar = controllerInstance.foo();
  }
}

调用 action

可以通过 this.action 方法调用其他模块里 controller 下的 action 方法，如：

export default class extends think.controller.base {
  async indexAction(){
    //获取 admin 模块下 user controller 的实例
    let controllerInstance = this.controller('user', 'admin');
    //调用 controller 里的 test action，会自动调用 __before 和 __after 魔术方法
    let data = await this.action(controllerInstance, 'test')
  }
  async index2Action(){
    //也可以通过字符串来指定 controller，这样会自动找对应的 controller
    let data = await this.action('admin/user', 'test')
  }
}

注：action 调用返回的始终为 Promise，调用 action 时不会调用对应的 logic。

调用 model

可以通过 this.model 方法获取其他模块下的 model 实例，如：

export default class extends think.controller.base {
  indexAction(){
    //获取 admin 模块下的 user model 实例
    let modelInstance1 = this.model('user', {}, 'admin');
    //也可以通过这种更简洁的方式
    let modelInstance2 = this.model('admin/user');
  }
}

如何请求其他接口数据

在项目中，经常要请求其他接口的数据。这时候可以用内置的 http 模块来操作，但 http 模块提供的接口比较基础，写起来比较麻烦。推荐大家用基于 http 模块封装的 request 模块或者 superagent 模块。如：

import request from 'request';
/* 获取 API 接口数据 */
let getApiData = () => {
  let deferred = think.defer();
  request.get({
    url: 'http://www.example.com/api/user',
    headers: {
      'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) Chrome/47.0.2526.111 Safari/537.36'
    }
  }, (err, response, body) => {
    if(err){
      deferred.reject(err);
    }else{
      deferred.resolve(body);
    }
  });
}

但这么写需要创建一个 deferred 对象，然后在回调函数里去根据 err 进行 resolve 或者 reject，写起来有些麻烦。ThinkJS 里提供了 think.promisify 方法来快速处理这一问题。

import request from 'request';
/* 获取 API 接口数据 */
let getApiData = () => {
  let fn = think.promisify(request.get);
  return fn({
    url: 'http://www.example.com/api/user',
    headers: {
      'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) Chrome/47.0.2526.111 Safari/537.36'
    }
  });
}

开发环境好的，线上部署 502

有时候开发环境下是好的，到线上使用 pm2 和 nginx 部署时，访问出现 502 的情况，这个情况一般为 node 服务没有正常启动导致的。可以通过 pm2 logs 看对应的错误信息来分析排查，也可以先关闭服务，手动通过 node www/production.js 启动服务，然后访问看具体的错误信息。

设置跨域头信息

高级浏览器支持通过设置头信息达到跨域请求，ThinkJS 里可以通过下面的方式来设置：

export default class extends think.controller.base {
  indexAction(){
    let method = this.http.method.toLowerCase();
    if(method === 'options'){
      this.setCorsHeader();
      this.end();
      return;
    }
    this.setCorsHeader();
    this.success();
  }
  setCorsHeader(){
    this.header('Access-Control-Allow-Origin', this.header('origin') || '*');
    this.header('Access-Control-Allow-Headers', 'x-requested-with');
    this.header('Access-Control-Request-Method', 'GET,POST,PUT,DELETE');
    this.header('Access-Control-Allow-Credentials', 'true');
  }
}

更多头信息设置请见 https://www.w3.org/TR/cors。

如果是在 REST API，那么可以放在 __call 方法里判断，如：

export default class extends think.controller.base {
  __call(){
    let method = this.http.method.toLowerCase();
    if(method === 'options'){
      this.setCorsHeader();
      this.end();
      return;
    }
    this.setCorsHeader();
    return super.__call();
  }
  setCorsHeader(){
    this.header('Access-Control-Allow-Origin', this.header('origin') || '*');
    this.header('Access-Control-Allow-Headers', 'x-requested-with');
    this.header("Access-Control-Allow-Methods", "GET,POST,OPTIONS,PUT,DELETE");
    this.header('Access-Control-Allow-Credentials', 'true');
  }
}

current path is not thinkjs project.

使用 thinkjs 命令创建一些 adapter 或者 model 之类时，有时候会报 current path is not thinkjs project 的错误。

这是因为在用 thinkjs new project 来创建项目时，会在项目下创建一个名为 .thinkjsrc 的文件，这个文件里有对项目的一些描述。后续创建 adapter 等功能时需要读取这个文件，如果这个文件丢失，那么就会报 current path is not thinkjs project 错误。

解决方案也很简单，找个目录创建一个模式一样的项目，然后把 .thinkjsrc 文件拷贝到当前项目下即可。

注：.thinkjsrc 文件需要纳入到项目版本管理中，不然后续会持续出现这个问题。

编译时，如何追加 presets 和 plugins

使用 Babel 编译时，内置使用的 presets 为 es2015-loose,stage-1，plugins 为 transform-runtime。如果内置的不满足项目的需求，可以修改 www/development.js 来追加，如：

//compile src/ to app/
instance.compile({
  log: true,
  presets: ['stage-0'], //添加 stage-0 presets
  plugins: ['transform-decorators-legacy']
});

添加对应的 presets 和 plugins 后，需要在项目安装对应的依赖才可运行。

如何自定义创建服务

ThinkJS 默认会创建一个 HTTP 服务，如果不能满足项目的需求的话，可以自定义创建服务。

可以通过修改 src/common/config/config.js 文件，添加配置 create_server 来自定义服务，如：

import http from 'http';
export default {
  create_server: (callback, port, host, app) => {
    let server = http.createServer(callback);
    server.listen(port, host);
    return server;
  }
}

其中形参 callback 为：

let callback = (req, res) => {
  think.http(req, res).then(http => {
    new this(http).run();
  });
};

用户登录后才能访问

项目开发中，经常会有某些功能需要用户登录后才能访问，如：后台管理。对于此类需要可以放在一个通用的逻辑处理里，建议放在 base controller 里的 __before 进行处理。

/* base controller */
export default class extends think.controller.base {
  async __before(){
    //部分 action 下不检查
    let blankActions = ['login'];
    if(blankActions.indexOf(this.http.action) >= 0){
      return;
    }
    let userInfo = await this.session('userInfo');
    //判断 session 里的 userInfo
    if(think.isEmpty(userInfo)){
      return this.redirect('/user/login');
    }
  }
}

其他 controller 文件继承 base controller，如：

import Base from './base';
export default class extends Base {
}

这样继承了 Base 的 controller 都会校验用户信息了。

TypeError: Unkown charset 'utf8mb4'

升级到 2.2.2 版本后，如果数据库的编码之前填的是 utf8mb4，那么会报一个 TypeError: Unkown charset 'utf8mb4' 的错误。这是因为 2.2.2 版本将依赖的 mysql 库改为了 node-mysql2（该模块性能是 node-mysql 的 2 倍），这个模块不支持 utf8mb4 简写，所以需要将配置文件里的数据库编码改为 UTF8MB4_GENERAL_CI，具体支持的编码列表见：https://github.com/sidorares/node-mysql2/blob/master/lib/constants/charsets.js

原文: https://thinkjs.org/zh-cn/doc/2.2/question.html