think

think 是一个全局对象，该对象里包含了大量有用的属性和方法。这些方法在应用的任何地方都可以直接使用，无需再 require。

属性

think.startTime

服务启动时间，是个 unix 时间戳。

think.env

当前项目运行的环境，默认支持下面 3 个值，可以在项目启动时指定：

  • development 开发环境，会自动更新修改的文件
  • testing 测试环境
  • production 线上环境，代码上线时使用

    think.dirname

项目的文件夹名称，可以在项目启动时指定，默认值如下：

  1. think.dirname = {
  2.   config: 'config', //配置文件目录
  3.   controller: 'controller', //控制器目录
  4.   model: 'model', //模型目录
  5.   adapter: 'adapter', //适配器目录
  6.   logic: 'logic', //逻辑目录
  7.   service: 'service', //服务目录
  8.   view: 'view', //视图目录
  9.   middleware: 'middleware', //中间件目录
  10.   common: 'common', //通用目录
  11.   bootstrap: 'bootstrap', //启动目录 
  12.   locale: 'locale' //本土化目录
  13. }

think.port

项目运行的端口，可以在项目启动时指定。如果指定，则忽略配置文件里的端口。

think.sep

目录分隔符，等同于 path.sep。

think.isMaster

是否是 master 进程。

think.cli

是否是命令行模式在运行项目，默认为 false。如果是命令行模式，则该值为传递的参数，可以通过下面的方式启动命令行模式。

  1. node www/index.js /home/index/test

think.lang

系统当前的语言，从环境变量中读取，在 Windows 下可能为空。

think.mode

项目当前的模式，框架支持 2 中项目模式：

  • think.mode_normal 多模块模式，目录结构只有 Controller，View，Logic 等分模块
  • think.mode_module 多模块模式，严格按照模块来划分目录结构

    think.version

ThinkJS当前的版本

think.module

当前项目下的模块列表。

think.THINK_PATH

ThinkJS代码的路径

think.THINK_LIB_PATH

ThinkJS代码 lib/ 的具体路径

think.ROOT_PATH

项目的根目录，在 www/index.js 中定义

think.APP_PATH

项目的 app 目录，在 www/index.js 中定义

think.RESOURCE_PATH

项目的静态资源根目录，在 www/index.js 中定义

think.RUNTIME_PATH

Runtime 目录，默认为当前项目下的 runtime/ 目录。

方法

think.Class(methods, clean)

动态的创建一个类，默认继承自 think.base 。 如果使用 ES6 特性进行开发的话，可以直接使用 ES6 里的 class 来创建类。

  1. //继承自 think.base
  2. var Cls1 = think.Class({
  3.   getName: function(){
  5.   }
  6. })
不继承 think.base
  1. var Cls2 = think.Class({
  2.   getName: function(){
  4.   }
  5. }, true);
继承一个类
  1. //继承自 Cls2
  2. var Cls3 = think.Class(Cls2, {
  3.   init: function(name){
  4.     this.name = name;
  5.   },
  6.   getName: function(){
  8.   }
  9. })
实例化类
  1. //获取类的实例，自动调用 init 方法
  2. var instance = new Cls3('thinkjs');

think.extend(target, source1, source2, …)

  • target {Object} 目录对象
  • source1 {Mixed} 源对象1
  • return {Object} 目录对象
    将 source1, source2 等对象上的属性或方法复制到 target 对象上，类似于 jQuery 里的 $.extend 方法。

默认为深度复制，可以将第一个参数传 false 进行浅度复制。 

  1. think.extend({}, {name: 'foo'}, {value: 'bar'});
  2. // returns 
  3. {name: 'foo', value: 'bar'}

think.isBoolean(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测一个对象是否是布尔值。
  1. think.isBoolean(true); //true
  2. think.isBoolean(false); //true
  3. think.isBoolean('string'); //false

think.isNumber(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测一个对象是否是数字。
  1. think.isNumber(1); //true
  2. think.isNumber(1.21); //true

think.isObject(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是对象
  1. think.isObject({}); //true
  2. think.isObject({name: "welefen"}); //true
  3. think.isObject(new Buffer('welefen')); //false

think.isString(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是字符串
  1. think.isString("xxx"); // true
  2. think.isString(new String("xxx")); //true

think.isFunction(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是函数
  1. think.isFunction(function(){}); //true
  2. think.isFunction(new Function("")); //true

think.isDate(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是日期对象
  1. think.isDate(new Date()); //true

think.isRegExp(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是正则
  1. think.isRegExp(/\w+/); //true
  2. think.isRegExp(new RegExp("/\\w+/")); //true

think.isError(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是个错误
  1. think.isError(new Error("xxx")); //true

think.isEmpty(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否为空
  1. // 检测是否为空
  2. think.isEmpty({}); //true
  3. think.isEmpty([]); //true
  4. think.isEmpty(""); //true
  5. think.isEmpty(0); //true
  6. think.isEmpty(null); //true
  7. think.isEmpty(undefined); //true
  8. think.isEmpty(false); //true

think.isArray(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是数组
  1. think.isArray([]); //true
  2. think.isArray([1, 2]); //true
  3. think.isArray(new Array(10)); //true

think.isIP4(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是 IP4
  1. think.isIP4("10.0.0.1"); //true
  2. think.isIP4("192.168.1.1"); //true

think.isIP6(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是 IP6
  1. think.isIP6("2031:0000:130f:0000:0000:09c0:876a:130b"); //true
  2. think.isIP6("2031:0000:130f::09c0:876a:130b"); //true

think.isIP(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是 IP
  1. think.isIP("10.0.0.1"); //true
  2. think.isIP("192.168.1.1"); //true
  3. think.isIP("2031:0000:130f:0000:0000:09c0:876a:130b"); //true ip6

think.isFile(file)

  • file {Mixed} 要检测的文件路径
  • return {Boolean}
    检测是否是文件，如果不存在或者不是文件则返回 false
  1. think.isFile("/home/welefen/a.txt"); //true
  2. think.isFile("/home/welefen/dirname"); //false

think.isFileAsync(file)

  • file {Mixed} 要检测的文件路径
  • return {Promise}
    异步检测是否是文件，返回一个 Promise。该方法在 2.1.5 版本中添加。

think.isDir(dir)

  • dir {Mixed} 要检测的路径
  • return {Boolean}
    检测是否是目录，如果不存在则返回 false
  1. think.isDir("/home/welefen/dirname"); //true

think.isDirAsync(dir)

  • dir {Mixed} 要检测的路径
  • return {Promise}
    异步检测是否是目录，返回 Promise。该方法在 2.1.5 版本中添加。

think.datetime(date, format)

  • date {Date}
  • format {String} 日期格式，默认为 YYYY-MM-DD HH:mm:ss
  • return {String}
    返回一个格式化的日期，格式为：YYYY-MM-DD HH:mm:ss，如：
  1. let str = think.datetime();
  2. //str is 2016-02-01 10:00:00
  3. //
  4. let str1 = think.datetime(new Date, 'YYYY-MM-DD');
  5. // str1 is 2016-02-01

该方法在 2.1.5 版本中添加。

think.isBuffer(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是 Buffer
  1. think.isBuffer(new Buffer(20)); //true

think.isNumberString(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    是否是字符串类型的数字
  1. think.isNumberString(1); //true
  2. think.isNumberString("1"); //true
  3. think.isNumberString("1.23"); //true

think.isPromise(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是个 Promise
  1. think.isPromise(new Promise(function(){})); //true
  2. think.isPromise(getPromise()); //true

think.isHttp(obj)

  • obj {Mixed} 要检测的对象
  • return {Boolean}
    检测是否是包装的 http 对象
  1. think.isHttp(http); // true

think.isWritable(path)

  • path {String} 要写的目录
  • return {Boolean}
    判断文件或者目录是否可写，如果不存在则返回 false

think.isPrevent(obj)

  • obj {Mixed}
  • return {Boolean}
    判断是否是个阻止类型的 Promise。通过 think.prevent() 会生成该 Promise 。

think.mkdir(p, mode)

  • p {String} 要创建的目录
  • mode {Number} 要创建的目录权限，默认为 0777
    递归的创建目录，如果目录已经存在，那么修改目录的权限。
  1. // 假设 /home/welefen/a/b/ 不存在
  2. think.mkdir("/home/welefen/a/b");
  3. think.mkdir("home/welefne/a/b/c/d/e"); // 递归创建子目录

think.rmdir(p, reserve)

  • p {String} 要删除的目录
  • reserve {Boolean} 是否保留该目录。如果为 true，则只删除子目录
  • return {Promise}
    递归的删除目录，如果目录不存在则直接返回。返回是个 Promise，后续操作要在 then 里执行
  1. function rmTmp(){
  2.   think.rmdir('/foo/bar').then(function(){
  3.     //后续其他操作
  4.   })
  5. }

如果使用 Generator Function，则可以使用 yield

  1. function * rmTmp(){
  2.   yield think.rmdir('/foo/bar');
  3.   //后续其他操作
  4. }

think.chmod(p, mode)

  • p {String} 要修改的目录
  • mode {Number} 目录权限，默认为0777
    修改目录权限，如果目录不存在则直接返回
  1. think.chmod("/home/welefen/a", 0777);

think.md5(str)

  • str {String} 要计算的字符串
  • return {String} 返回字符串的 md5 值
    计算字符串的 md5 值
  1. think.md5('thinkjs'); 
  2. // returns 7821eb623e0b1138a47db6a88c3f56bc

think.camelCase(sr)

  • str {String} 要转换的字符串
  • return {String}
    转换为驼峰方式
  1. think.camelCase('a_bbb_ccc');
  2. //returns aBbbCcc

think.defer()

  • return {Object} Deferred对象
    创建一个 Deferred 对象，new Promise 的一种快捷方式。虽然不建议使用 Deferred这种方式，但有时候不得不使用。如：setTimeout, event。
  1. //使用Deferred的方式
  2. var fn = function(){
  3.   var deferred = think.defer();
  4.   process.nextTick(function(){
  5.     if(xxx){
  6.       deferred.resolve(data);
  7.     }else{
  8.       deferred.reject(err);
  9.     }
  10.   })
  11.   return deferred.promise;
  12. }

使用 Deferred 方式比直接使用 new Promise 的方法代码更加简洁。

  1. //直接使用new Promise的方式
  2. var fn = function(){
  3.   return new Promise(function(resolve, reject){
  4.     process.nextTick(function(){
  5.       if(xxx){
  6.         resolve(data);
  7.       }else{
  8.         reject(err);
  9.       }
  10.     })
  11.   })
  12. }

注： 异步 callback 的操作不要使用 Deferred 方式，可以用 think.promisify 方法快速把 callback 包装成 Promise。

think.promisify(fn, receiver)

  • fn {Function} 要转化的函数
  • receiver {Object} this指向
    将异步方法快速包装成 Promise，异步方法必须符合最后一个参数为回调函数，且回调函数的第一个参数为 err 的原则。
  1. var fs = require('fs');
  3. //获取文件内容
  4. var getContent = function(filePath){
  5.   //将readFile方法包装成Promise
  6.   var readFilePromise = think.promisify(fs.readFile, fs);
  7.   //读取文件内容
  8.   return readFilePromise(filePath, 'utf8');
  9. }
  11. //获取具体的文件内容
  12. getContent('/foo/bar/file.txt').then(function(content){
  13.   console.log(content);
  14. }).catch(function(err){
  15.   console.error(err.stack);
  16. })

think.reject(err)

  • err {Error} Error对象
  • return {Promise} reject promise
    返回一个 reject promise，与 Promise.reject不同的是，该方法会自动打印错误信息。避免需要调用 catch 方法手工打印错误信息。
  1. //使用Promise.reject
  2. var fn = function(){
  3.   return Promise.reject(new Error('xxx'));
  4. }
  5. //需要手工调用catch方法打印错误信息
  6. fn().catch(function(err){
  7.   console.error(err.stack);
  8. })
  1. //使用think.reject
  2. var fn = function(){
  3.   return think.reject(new Error('xxx'));
  4. }
  5. //会自动打印格式化后的错误信息
  6. fn();

think.co

co 模块的别名 https://github.com/tj/co

think.lookClass(name, type, module, base)

  • name {String} 类名
  • type {String} 类型 (controller | model | logic …)
  • module {String} 模块名
  • base {String} 找不到时找对应的基类
    根据类型，名称来查找类。如果找不到会到 common 模块下查找，如果还是找不到，则查找对应类型的基类。
  1. //查找 home 模块下 user controller
  2. //如果找不到，会找 common 模块下 user controller
  3. //如果还是找不到，会找 base controller
  4. think.lookClass('user', 'controller', 'home'); 
  6. //查找 admin 模块下 user controller
  7. think.lookClass('admin/user', 'controller');

think.getPath(module, type, prefix)

  • module {String} 模块名
  • type {String} 类型，如： controller, model, logic
  • prefix {String} 前缀
    根据当前项目类型获取对应类型的目录。
  1. let path = think.getPath('home', 'controller');

假如当前项目的根目录是/foo/bar，那么获取到的目录为：

  • 项目模式think.mode_normal 下路径为 /foo/bar/app/controller/home

  • 项目模式think.mode_module 下路径为 /foo/bar/app/home/controller

    think.require(name, flag)

  • name {String}

  • flag {Boolean}

    think.safeRequire(file)

  • file {String} 要加载的文件
    安全的加载一个文件，如果文件不存在，则返回 null，并打印错误信息。

think.prevent()

返回一个特殊的 reject promise 。该 Promise 可以阻止后续的行为且不会报错。

think.log(msg, type, showTime)

  • msg {String | Error} 信息
  • type {String} 类型
  • showTime {Number | Boolean} 是否显示时间
    打印日志，该方法打印出来的日志会有时间，类型等信息，方便查看和后续处理。
  1. think.log('WebSocket Status: closed', 'THINK');
  2. //writes '[2015-09-23 17:43:00] [THINK] WebSocket Status: closed'
打印错误信息
  1. think.log(new Error('error'), 'ERROR');
  2. //writes '[2015-09-23 17:50:17] [Error] Error: error'
显示执行时间
  1. think.log('/static/module/jquery/1.9.1/jquery.js', 'HTTP', startTime);
  2. //writes '[2015-09-23 17:52:13] [HTTP] /static/module/jquery/1.9.1/jquery.js 10ms'
不显示时间
  1. think.log('/static/module/jquery/1.9.1/jquery.js', 'HTTP', null);
  2. //writes '[HTTP] /static/module/jquery/1.9.1/jquery.js'
自定义
  1. think.log(function(colors){
  2.   return colors.yellow('[WARNING]') + ' test';
  3. });
  4. //writes '[WARNING] test'

其中 colors 为 npm 模块 colors，https://github.com/Marak/colors.js 。

think.config(name, value, data)

  • name {String} 配置名称
  • value {Mixed} 配置值
  • data {Object} 配置对象
    读取或者设置配置，可以指定总的配置对象。
  1. //获取配置
  2. let value = think.config('name');
  3. //获取 admin 模块下的配置
  4. let value = think.config('name', undefined, 'admin');
  6. // 写入配置
  7. think.config('name', 'value');

think.getModuleConfig(module)

  • module {String} 模块名称
  • return {Object}
    获取模块的所有配置。该配置包含模块的配置，通用模块的配置，框架默认的配置。
  1. //获取 admin 模块的所有配置
  2. let configs = think.getModuleConfig('admin');

think.hook()

注册、获取和执行 hook，项目中可以根据需要追加或者修改。

获取事件对应的 middleware 列表
  1. think.hook('view_template');
  2. //returns
  3. ['locate_template']
设置 hook
  1. //替换原有的 hook
  2. think.hook('view_template', ['locate_template1']);
  4. //将原有的之前追加
  5. think.hook('view_template', ['locate_template1'], 'prepend');
  7. //将原有的之后追加
  8. think.hook('view_template', ['locate_template1'], 'append');
删除 hook
  1. think.hook('view_template', null);
执行 hook
  1. let result = think.hook('view_template', http, data);
  2. //result is a promise

think.middleware()

注册、创建、获取和执行 middleware。

创建 middleware
  1. //解析 XML 示例
  2. var ParseXML = think.middleware({
  3.   run: function(){
  4.     var http = this.http;
  5.     return http.getPayload().then(function(payload){
  6.       var data = xmlParse.parse(payload); //使用一个xml解析，这里 xmlParse 是示例
  7.       http._post = data; //将解析后的数据赋值给 http._post，后续可以通过 http.post('xxx') 获取 
  8.     });
  9.   }
  10. });

使用 ES6 创建 middleware。

  1. let Cls1 = class extends think.middleware.base {
  2.   run(){
  3.     let http = this.http;
  4.   }
  5. }
注册 middleware

middleware 可以是个简单的 function，也可以是较为复杂的 class。

  1. //注册 middleware 为 function
  2. think.middleware('parse_xml', http => {
  4. })
  1. //注册 middleware 为 class
  2. //会自动调用 run 执行
  3. let Cls = think.middleware({
  4.   run: function(){
  5.     let http = this.http;
  7.   }
  8. });
  9. think.middleware('parse_xml', Cls);
获取 middleware
  1. let middleware = think.middleware('parse_xml');
执行 middleware
  1. let result = think.middleware('parse_xml', http);
  2. //result is a promise

think.adapter()

创建、注册、获取和执行 adapter。

创建 adapter
  1. //创建一个 adapter
  2. var Cls = think.adapter({
  4. });
  6. //创建一个 session adapter，继承自 session base 类
  7. var Cls = think.adapter('session', 'base', {
  9. })
  1. //使用 ES6 创建一个 session adapter
  2. let Cls = class extends think.adapter.session {
  4. }
注册 adapter
  1. //注册一个 xxx 类型的 session adapter
  2. think.adapter('session', 'xxx', Cls);
获取 adapter
  1. //获取 file 类型的 session adapter
  2. let Cls = think.adapter('session', 'file');
执行 adapter
  1. let Adapter = think.adapter('session', 'file');
  2. let instance = new Adapter(options);

think.gc(instance)

  • instance {Object} 类的实例
    注册实例到 gc 队列中。instance 必须含有属性 gcType 和方法 gc。

像 cache, session 这些功能一般都是有过期时间，过期后需要要进行清除工作。框架提供了一套机制方便清除过期的文件等。

  1. let Cls = class extends think.adapter.cache {
  2.   init(options){
  3.     super.init(options);
  4.     this.gcType = 'xFileCache';
  5.     think.gc(this);
  6.   }
  7.   gc(){
  8.     //寻找过期的内容并清除
  9.   }
  10. }

think.http(req, res)

  • req {Object} request 对象
  • res {Object} response 对象
  • return {Promise}
    根据 req 和 res 包装成 http 对象。req 和 res 可以自定义。
  1. //根据一个 url 生成一个 http 对象，方便命令行下调用
  2. think.http('/index/test').then(http => {
  4. });

think.uuid(length)

  • length {Number} 生成字符串的长度，默认为 32
    生成一个随机字符串。

think.parseConfig(…args)

解析配置里的 adapter 和 parser，如：

  1. let config = think.parseConfig({prefix: 'think_'}, {
  2.   type: 'mysql',
  3.   adapter: {
  4.     mysql: {
  5.       prefix: 'test_',
  6.       host: ['10.0.0.1', '10.0.0.2'],
  7.       parser: options => {
  8.         return {
  9.           host: '10.0.0.1'
  10.         }
  11.       }
  12.     }
  13.   }
  14. });
  15. // config value is {prefix: 'test_', host: '10.0.0.1'}

如果只想解析 adapter，而不解析 parser，可以通过传递第一个参数为 true，如：

  1. let config = think.parseConfig(true, {prefix: 'think_'}, {
  2.   type: 'mysql',
  3.   adapter: {
  4.     mysql: {
  5.       prefix: 'test_',
  6.       host: ['10.0.0.1', '10.0.0.2'],
  7.       parser: options => {
  8.         return {
  9.           host: '10.0.0.1'
  10.         }
  11.       }
  12.     }
  13.   }
  14. });
  15. // config value is {prefix: 'test_', ['10.0.0.1', '10.0.0.2'], parser: function(){...}}

think.session(http)

  • http {Object} http对象
    生成 session，并写到 http 对象上。如果已经存在，则直接返回。

think.controller()

创建、执行 controller

创建 controller
  1. //创建 controller, 继承 think.controller.base
  2. let Cls = think.controller({
  4. })
  5. //创建 controller, 继承 think.controller.rest
  6. let Cls = think.controller('rest', {
  8. })
  1. //使用 ES6 创建 controller
  2. let Cls1 = class extends think.controller.base {
  4. }
实例化 controller
  1. //实例化 home 模块下 user controller
  2. let instance = think.controller('user', http, 'home');

think.logic()

创建、执行 logic

创建 logic
  1. //创建 logic, 继承 think.logic.base
  2. let Cls = think.logic({
  4. })
  1. //使用 ES6 创建 logic
  2. let Cls1 = class extends think.logic.base {
  4. }
实例化 logic
  1. //实例化 home 模块下 user logic
  2. let instance = think.logic('user', http, 'home');

think.model()

创建或者获取 model

创建 model
  1. //创建一个 model
  2. let model = think.model({
  3.   getList: function(){
  5.   }
  6. });
  8. //ES6 里直接继承 think.model.base 类
  9. let model = class extends think.model.base {
  10.   getList(){
  12.   }
  13. }
  16. //创建一个 model 继承自 mongo model
  17. let model = think.model('mongo', {
  18.   getList: function(){
  20.   }
  21. });
  22. //ES6 里直接继承 think.model.mongo 类
  23. let model = class extends think.model.mongo {
  24.   getList(){
  26.   }
  27. }
获取 model 实例
  1. let configs = {
  2.   host: '127.0.0.1',
  3.   name: 'user'
  4. }
  5. //获取 home 模块下 user model
  6. let instance = think.model('user', configs, 'home');

think.service()

创建或者获取 service

创建 service
  1. //创建一个 service 类
  2. let service = think.service({
  4. })
  6. //ES6 里直接继承 think.service.base 类
  7. let service = class extends think.service.base {
  9. }

service 基类继承自 think.base，所以可以用 think.base 里的方法。

如果 serivce 不想写成类，那就没必要通过这种方法创建。

获取 service
  1. //获取 home 模块下 post service，并传递参数 {} 
  2. //如果获取到的 service 是个类，则自动实例化
  3. think.service('post', {}, 'home');

think.cache(name, value, options)

  • name {String} 缓存 key
  • value {Mixed} 缓存值
  • options {Object} 缓存选项
  • return {Promise} 操作都是返回 Promise
    获取、设置或者删除缓存， value 是 undefined 表示读取缓存。 value 是 null 时删除缓存。

value 为 Function 时表示获取缓存，如果获取不到，则调用该函数，然后将返回值设置到缓存中并返回。

  1. //获取缓存
  2. think.cache('name').then(data => {});
  4. //指定缓存类型获取，从 redis 里获取缓存
  5. think.cache('name', undefined, {type: 'redis'});
  7. //如果缓存 userList 不存在，则查询数据库，并将值设置到缓存中
  8. think.cache('userList', () => {
  9.   return think.model('user').select();
  10. });
  12. //设置缓存
  13. think.cache('name', 'value');
  15. //删除缓存
  16. think.cache('name', null);

think.locale(key, …data)

  • key {String} 要获取的 key
  • data {Array} 参数
    根据语言获取对应的值，当前语言通过 think.lang 方法来获取，可以在系统启动时指定。
  1. think.locale('CONTROLLER_NOT_FOUND', 'test', '/index/test');
  2. //returns 
  3. 'controller `test` not found. url is `/index/test`.'

think.validate()

注册、获取或执行检测。

注册检测方法
  1. //注册检测类型为 not_number
  2. think.validate('not_number', value => {
  3.   return !(/^\d+$/.test(value));
  4. })
获取检测方法
  1. let fn = think.validate('not_number');
检测数据
  1. let result = think.validate({
  2.   name: {
  3.     value: 'name',
  4.     required: true,
  5.     not_number: true
  6.   },
  7.   pwd: {
  8.     value: 'xxx',
  9.     required: true,
  10.     minLength: 6
  11.   }
  12. });
  13. //如果 result 是 isEmpty，表示数据都正常
  14. if(think.isEmpty(result)){
  16. }

think.await(key, callback)

  • key {String}
  • callback {Function}
    执行等待，避免一个耗时的操作多次被执行。 callback 需要返回一个 Promise 。

如：用户访问时，要请求一个远程的接口数据。如果不处理，每个用户请求都会触发这个远程接口的访问，导致有很大的资源浪费。可以让这些用户公用一个远程接口的请求。

  2. import superagent from 'superagent';
  4. export default class extends think.controller.base {
  5.   * indexAction(){
  6.     let result = yield think.await('get_xxx_data', () => {
  7.       let req = superagent.post('xxxx');
  8.       let fn = think.promisify(req.end, req);
  9.       return fn();
  10.     });
  11.     this.success(result);
  12.   }
  13. }

think.npm(pkg)

  • pkg {String} 模块名
    加载模块。如果模块不存在，则自动安装。这样可以做到动态安装模块。
  1. //如果mysql模块，则通过npm安装
  2. let mysql = think.npm('mysql');
  1. //指定版本加载一个模块
  2. let mysql = think.npm('mysql@2.0.0')

think.error(err, addon)

  • err {Error | Promise | String} 错误信息
  • addon {Error | String} 追加的错误信息
    格式化错误信息，将部分系统的错误信息描述完整化。
  1. let error = think.error(new Error('xxx'));
捕获 promise 的错误信息
  1. let promise = Project.reject(new Error('xxx'));
  2. promise = think.error(promise)

自动给 promise 追加 catch，捕获错误信息。

think.statusAction(status, http, log)

  • status {Number} 状态码
  • http {Object} 包装的http对象
  • log {Boolean} 是否打印错误信息
    当系统出现异常时（系统错误，页面找不到，没权限等），显示对应的错误页面。

创建项目时，会在 common 模块下生成文件 src/common/controller/error.js，专门用来处理错误情况。

默认支持的错误类型有：400, 403, 404, 500, 503。

项目里可以根据需要修改错误页面或者扩展。

  1. export default class extends think.controller.base {
  2.   indexAction(){
  3.     if(xxxx){
  4.       let error = new Error('not found');
  5.       //将错误信息写到 http 对象上，用于模版里显示
  6.       this.http.error = error;
  7.       return think.statusAction(404, this.http);
  8.     }
  9.   }
  10. }

think.parallelLimit(dataList, callback, options)

  • dataList {Array} 要处理的数据列表
  • callback {Function} 处理函数，会将每条数据传递进去，需要返回 Promise
  • options {Object} 额外选项

  • return {Promise}
    options 包含一下选项：

  • limit {Number} 并发限制数，默认为 10 条

  • ignoreError {Boolean} 是否忽略错误，默认情况下一个错误后会停止后续执行
    并发限制处理方法。如：有 10000 条网络数据需要处理，如果同时处理会会网络 IO 错误，此时可以对并发处理进行限制。该方法在 2.0.6 版本中添加。
一个请求下多条数据同时处理场景
  1. import superagent from 'superagent';
  3. export default class extends think.controller.base {
  4.   async indexAction(){
  5.     let dataList = [...];
  6.     //result 为每条处理结果集合
  7.     //如果某些条数据处理异常，那么对应的数据为 undefined，处理时需要过滤下
  8.     let result = await think.parallelLimit(dataList, item => {
  9.       let url = item.url;
  10.       let req = superagent.get(url);
  11.       let fn = think.promisify(req.end, req); //将 end 方法包装成 Promise
  12.       return fn();
  13.     }, {
  14.       limit: 20, //一次执行 20 条
  15.       ignoreError: true
  16.     })
  17.   }
  18. }
单条数据在多个请求下处理场景

有些数据处理虽在一个情况下只用处理一次，但单次处理比较耗时，如果同时请求很多的话可能会导致报错。这个时候也要进行限制，如果当前同时处理数目较多，后续请求则进行等待。

这个需求可以通过传入一个相同的 key 将任务分组，如：

  1. import gm from 'gm';
  3. export default class extends think.controller.base {
  4.   async indexAction(){
  5.     let result = await think.parallelLimit('clip_image', () => {
  6.       let imageFile = this.file('image').path;
  7.       let instance = gm(imageFile).resize(240, 240).noProfile();
  8.       let fn = think.promisify(instance.write, instance);
  9.       return fn('/path/to/save/image.png');
  10.     }, {
  11.       limit: 20 //一次执行 20 条
  12.     })
  13.   }
  14. }

类

think.base

think.base 详细介绍请见 这里

think.http.base

think.http.base 详细介绍请见 这里

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