ThinkJS(官网|GitHub)的核心架构是 CBD(核心 Core + 行为 Behavior + 驱动 Driver)模式。核心包含通用函数库、系统默认配置、核心类库等运行 ThinkJS 必不可靠的部分;行为是 ThinkJS 扩展机制中很关键的一部分,也是本文重点要介绍的内容;除了核心和行为之外,ThinkJS 其他功能都是通过驱动来实现的,例如 Cache、Session、DB 等。ThinkJS 把响应用户请求整个流程分成了很多个阶段,对应不同的标签位(Tag)。每个标签位都可以调用一系列 Behavior。使用 Behavior 可以方便地扩展 ThinkJS,实现自己想要的功能。ThinkJS 框架自身很多功能也都是通过它来实现的。系统标签位先来了解一下 ThinkJS 内置了哪些标签位。根据官方文档,ThinkJS 在响应用户请求过程中,会依次执行以下这些操作:执行标签位form_parse;发送 X-Powered-By 响应头信息,值为 thinkjs 的版本号;执行标签位app_init;执行标签位resource_check,判断当前请求是否是静态资源类请求。静态资源类请求执行标签位resource_output;执行标签位path_info,获取修改后的 pathname;执行标签位route_check,进行路由检测,识别对应的 Group、Controller、Action;执行标签位app_begin,检测当前请求是否有静态化缓存;执行标签位action_init,实例化 Controller;调用 __before 方法,如果存在的话;调用对应的 action 方法;调用 __after 方法,如果存在的话;执行标签位view_init,初始化模版引擎;执行标签位view_template, 查到模版文件的具体路径;执行标签位view_parse,解析模版内容;执行标签位view_filter,对解析后的内容进行过滤;执行标签位view_end,模版渲染结束;执行标签位app_end, 应用调用结束;这个完整的请求响应流程,包含了 ThinkJS 所有内置的标签位。内置 Behavior接下来看看 ThinkJS 针对系统标签位分别配置了哪些 Behavior。打开/thinkjs/lib/Conf/tag.js,可以看到如下配置:module.exports = {
app_init: [],//应用初始化form_parse: [jsonParse],//表单数据解析path_info: [],//pathinfo解析resource_check: ['CheckResource'],//静态资源请求检测resource_output: [resourceOutput],//静态资源输出route_check: ['CheckRoute'],//路由检测app_begin: ['ReadHtmlCache'],//应用开始action_init: [],//action执行初始化view_init: [],//模版解析初始化view_template: ['LocateTemplate'],//定位模版文件view_parse: ['ParseTemplate'],//模版解析view_filter: [],//模版内容过滤view_end: ['WriteHtmlCache'],//模版解析结束action_end: [],//action结束app_end: [closeDbConnect],//应用结束content_write: []//内容输出};ThinkJS 内置 Behavior 使用了两种形式:字符串形式需要定义在外部文件中,存放于/thinkjs/lib/Lib/Behavior目录,文件名以Behavior.js结尾;函数形式直接定义在了当前文件里。实现 Behavior要实现自己的 Behavior 很简单,只需要两步:1)在/App/Lib/Behavior/中编写 Behavior 的具体逻辑;2)在App/Conf/tag.js中启用它。当然也可以直接把逻辑实现在tag.js里,不过为了更方便地启用 / 禁用 Behavior,还是推荐定义在外部。下面这样就可以定义一个新的 Behavior,框架会自动调用它的run方法。module.exports = Behavior(function(){return{
run:function(){
}
}
})run方法内部,可以使用this.http获得 ThinkJS 的 HTTP 对象,这个对象是 ThinkJS 对 Request 和 Response 对象的封装,提供了很多方法用来获取和改变请求和响应信息。具体内容可以直接查看/thinkjs/lib/Lib/Core/Http.js文件。位于某些标签位的 Behavior 还会收到额外的参数。例如框架执行view_template标签位时,会把 templateFile 传过来作为run方法的参数;view_filter中的 Behavior 会收到content参数,内容是经过模板渲染后的内容。run方法可以返回具体的值,也可以返回 Promise。如果不希望执行后续流程,需要返回 Pendding Promise。Pendding Promise 永远没有机会被 Resolve,后续流程自然不会执行,这时需要在 Behavior 里手动结束响应,否则请求会被卡住结束不了。具体代码在后面贴出。写好了 Behavior,在App/Conf/tag.js(没有就新建一个)启用它就可以了。类似这样:module.exports = {
app_begin: ["XXX"]
}直接在tag.js定义函数来实现 Behavior 是类似的,只是多了第一个参数:http。这里略过。执行顺序默认情况下,自定义 Behavior 会在框架默认 Behavior 之后运行。可以通过数组的第一个值来改变这个策略,规则如下:将数据第一个值设置为true,表示用自定义 Behavior 替换默认的;将数据第一个值设置为false,表示自定义 Behavior 会在框架默认 Behavior 之前运行;Behavior 示例下面通过两个示例演示 Behavior 的实际用法。首先,我要实现的 Behavior 是用来在博客维护时,访问任何页面都只显示一段提示文字,但 RSS 功能以及管理后台不能受影响。最终实现代码如下:// App/Lib/Behavior/MaintenanceBehavior.jsmodule.exports = Behavior(function(){return{
run:function(content){if('Blog'!==this.http.group ||'Misc'==this.http.controller) {returnfalse;
}varhttp =this.http;
http.echo('网站维护中,请稍后再来看看...').then(function(){
http.end();
});returngetDefer().promise;
}
}
});我通过http.group和http.controller这两个变量确保只修改需要的页面;然后通过http.echo输出自定义内容,并通过http.end结束当前请求;最后还需要返回 Pendding Promise,确保后续流程不会执行。插件写好之后,在/App/Conf/tag.js中启用它就可以了。由于这个 Behavior 目的是修改输出,需要尽早执行,又因为它用到了路由信息,需要放在route_check之后,所以app_begin是最合适的位置:module.exports = {
app_begin: ['Maintenance']
}上一篇文章里,我为了实现 HTTP/2 的 Server Push,需要把要推送的 css 外链找出来放在响应头里。这也是通过 Behavior 实现的,代码如下:// App/Lib/Behavior/ServerPushBehavior.jsmodule.exports = Behavior(function(){return{
run:function(content){
content = content.substr(0,1024);varmatches = content.match(//i);if(matches) {varhref = matches[0].replace(//i,'$1');this.http.setHeader('link','<'+ href +'>; rel=preload; as=stylesheet');
}
}
}
})我从模板渲染后的 content 中截取了前 1024 个字符,从中找到第一个 css 外链,并通过http.setHeader添加自定义头。这个 Behavior 需要用到 html 内容,所以需要配置在view_filter标签位中:module.exports = {
view_filter: ['ServerPush']
}其实,ThinkJS 内置的 Behavior 就是最好的代码示例,可以点这个链接查看。另外,据说在 ThinkJS 2.0 里,Behavior 已经被middleware取代,到底会有什么变化呢?我们拭目以待。本文链接:https://imququ.com/post/thinkjs-behavior.html,参与讨论推荐:领略前端技术 阅读奇舞周刊