本文是基于 kraken-js 0.6.1 版本的

关于如何使用kraken-js 可以去看看官网的使用文档 点击这里 。kraken-js 是基于express之上的,目的在于让工程师更多的去关注代码逻辑,少关注自身的开发环境,所以他将express所有的一些公用的配置都写在了配置文件里面了。暴露给开发者的很少。下面来看看kraken-js 源码,分析是如何创建nodejs应用程序的。如果对express 不太理解的,可以看看我之前博客写的express框架解密序列。

按照kraken-js 官网上的步骤,我们创建了一个新项目,然后生成了代码是这个样子的:

对这个结构说明下:

  • /config  ---应用程序和中间件的配置
  • /controllers  ---路由和逻辑
  • /lib ---用户开发的第三方库
  • /locales ---语言包
  • /models  ---模型
  • /public ---公共资源
  • /public/templates ---模板
  • /tests ---一些测试用例
  • index.js ---应用程序入口

我们看看入口文件 index.js  和路由文件controllers/index.js

'use strict';

var kraken = require('kraken-js'),
app = {}; app.configure = function configure(nconf, next) {
// Fired when an app configures itself
next(null);
}; app.requestStart = function requestStart(server) {
// Fired at the beginning of an incoming request
}; app.requestBeforeRoute = function requestBeforeRoute(server) {
// Fired before routing occurs
}; app.requestAfterRoute = function requestAfterRoute(server) {
// Fired after routing occurs
}; kraken.create(app).listen(function (err) {
if (err) {
console.error(err);
}
});
'use strict';

module.exports = function (server) {

    server.get('/', function (req, res) {
var model = { name: 'helloworld' }; res.render('index', model); }); };

我们看到在index.js 文件里面,没有端口设置,没有模板引擎以及其他的中间件设置,只有一些钩子,这个就是kraken-js 的巧妙之处。

具体做法是:

  首先创建一个app,给app添加一些方法(configure,requestStart,requestBeforeRoute,requestAfterRoute),再将app作为kraken的create方法参数

传进去,kraken.create(app),然后在调用listen方法(主要是调用http的createServer创建一个服务)。其实这里的app是一些钩子,作为代理的方式给express框架使用,这些方法的参数server 就是express 框架创建的实例。我们在使用的时候,都是通过express的use方法来调用中间件的。这个后面会有详细的解释。

既然调用了kraken 的create方法,我们就去看看kraken 的源码,看看是怎么构造这个应用程序的。

我们看到在kraken-js/index.js 中,提供了一个对外的调用函数:

exports.create = function (route, delegate) {
return create().use(route, delegate);
};

可以看到它先调用了本身的create方法,然后调用了use方法,我们去看看create方法:

function create() {
return Object.create(kraken, {
_app: {
enumerable: true,
writable: true,
value: null
},
_promise: {
enumerable: true,
writable: true,
value: null
},
host: {
enumerable: true,
writable: true,
value: undefined
},
port: {
enumerable: true,
writable: true,
value: undefined
},
'☯': {
// This is silly, but since a require-d app may be using
// kraken, but the proto isn't a reference to the same
// object, we need to have a unique identifier for the
// `isKraken` check. (Non-enumerable.)
value: '☯'
}
});
}

它创建了一个kraken的对象,然后添加了一些属性。在use的方法中,最重要的是:

 chain = create(this._app)
.then(assign)
.then(create)
.then(mount);

首先,通过调用create方法传入了一个空的app,而这个create方法是

function create(delegate) {
return appcore.create(delegate, pathutil.create(resolveRoot));
}

它直接调用了appcore的create方法:

function create(delegate, resolver, callback) {

    var app, appcore;

    if (isExpress(delegate)) {
callback(null, delegate);
return;
} if (typeof resolver === 'function') {
callback = resolver;
resolver = pathutil.create();
} app = express();
if (!delegate) {
patch.apply('stream', app);
callback(null, app);
return;
} appcore = Object.create(proto, {
_app: {
enumerable: true,
writable: false,
value: app
},
_delegate: {
enumerable: true,
writable: false,
value: delegate
},
_resolver: {
enumerable: true,
writable: false,
value: resolver
},
_config: {
enumerable: true,
writable: true,
value: undefined
},
_i18n: {
enumerable: true,
writable: true,
value: undefined
}
}); appcore.init(function (err) {
if (err) {
callback(err);
return;
}
callback(null, app);
});
}

我们知道这个这个参数的app是为空的。所以进入了这个分支:

app = express();
if (!delegate) {
patch.apply('stream', app);
callback(null, app);
return;
}

直接将express导入进来了。patch.apply('stream', app); 是将app的response 直接改写了。返回了express 。接着执行:

.then(assign)
.then(create)
.then(mount);

assign 是将app赋值给this._app 了,同时做了第二件事情,将应用程序的那些钩子返回出来,直接传递给create函数,我们看到create函数再次调用了,与第一次不同的是,本次的参数不为空,

而是我们在应用程序创建的那个“app”,即为我们之前所说的钩子。最后在挂载这个应用程序。

在第二次调用create方法。其实就是通过proto 创建了一个appcore的对象:

appcore = Object.create(proto, {
_app: {
enumerable: true,
writable: false,
value: app
},
_delegate: {
enumerable: true,
writable: false,
value: delegate
},
_resolver: {
enumerable: true,
writable: false,
value: resolver
},
_config: {
enumerable: true,
writable: true,
value: undefined
},
_i18n: {
enumerable: true,
writable: true,
value: undefined
}
});

我们看到将这个app作为appcore的_app 属性,将delegate 其实就是作为_delagate  的一个属性。这个就是index.js 传入的那个参数app对象,接着调用了proto的init方法:

appcore.init(function (err) {
if (err) {
callback(err);
return;
}
callback(null, app);
});

init 是直接调用了 _configure 方法,在这个方法中,首先通过赋值app为 app  = this._app;然后通过方法 this._config = config.create(this._resolve('.'));,读取kraken和本应用程序config 目录下得config文件。最后再调用 next方法。在next方法中:

function next(err) {
var config, settings; if (err) {
callback(err);
return;
} config = self._config;
patch.apply('config', app, config); // XXX: Special-case resolving `express:views` until we get config protocols working.
config.set('express:views', self._resolve(config.get('express:views')));
config.set('express:env', config.get('env:env'));
config.set('express:port', config.port);
config.set('express:host', config.host); settings = config.get('express');
Object.keys(settings).forEach(function (key) { app.set(key, settings[key]);
}); settings = config.get('ssl'); if (settings) {
app.set('ssl', settings);
tls.SLAB_BUFFER_SIZE = settings.slabBufferSize || tls.SLAB_BUFFER_SIZE;
tls.CLIENT_RENEG_LIMIT = settings.clientRenegotiationLimit || tls.CLIENT_RENEG_LIMIT;
tls.CLIENT_RENEG_WINDOW = settings.clientRenegotiationWindow || tls.CLIENT_RENEG_WINDOW;
} self._views();
self._middleware();
callback();
}

这个方法中,首先配置了一些参数。

然后再调用了处理视图的参数_views(),接着调用了 _middleware()函数。

我们看到:

if (typeof this._delegate.configure === 'function') {
this._delegate.configure(this._config.raw, next);
return;
}

如果configure 是一个函数,那么先调用这个,然后再调用那个next方法。在前面我们说过,this._delegate 其实就是index.js 里面创建的那个“app” 钩子。

视图我们省略,我们主要看看怎么调用_middleware 函数这个函数都做了些什么。还是先上源码:

_middleware: function () {
var app, delegate, config, srcRoot, staticRoot, errorPages; app = this._app;
delegate = this._delegate;
config = this._config.get('middleware');
srcRoot = this._resolve(config.static.srcRoot);
staticRoot = this._resolve(config.static.rootPath); app.use(express.favicon());
app.use(kraken.compiler(srcRoot, staticRoot, this._config, this._i18n));
app.use(express.static(staticRoot));
app.use(kraken.logger(config.logger)); if (typeof delegate.requestStart === 'function') {
delegate.requestStart(app);
} config.bodyParser && console.warn('The `middleware:bodyParser` configuration will not be honored in future versions. Use `middleware:json`, `middleware:urlencoded`, and `middleware.multipart`.'); app.use(express.json(config.bodyParser || config.json));
app.use(express.urlencoded(config.bodyParser || config.urlencoded)); console.warn('Multipart body parsing will be disabled by default in future versions. To enable, use `middleware:multipart` configuration.');
app.use(express.multipart(config.bodyParser || config.multipart || { limit: 2097152 })); // default to 2mb limit app.use(express.cookieParser(config.session.secret));
app.use(kraken.session(config.session));
app.use(kraken.appsec(config.appsec)); if (typeof delegate.requestBeforeRoute === 'function') {
delegate.requestBeforeRoute(app);
} enrouten(app).withRoutes({
directory: this._resolve(this._config.get('routes:routePath'))
}); if (typeof delegate.requestAfterRoute === 'function') {
delegate.requestAfterRoute(app);
} errorPages = config.errorPages || {};
app.use(kraken.fileNotFound(errorPages['404']));
app.use(kraken.serverError(errorPages['500']));
app.use(kraken.errorHandler(config.errorHandler));
},

在这里我们看到了很熟悉的express 的基本配置,它的一些配置都写在这里面了。

我们看到这些,这些就是处理我们之前的那些钩子函数了。看到了吧,都是传入express 构建的应用程序。

if (typeof delegate.requestStart === 'function') {
delegate.requestStart(app);
} if (typeof delegate.requestBeforeRoute === 'function') {
delegate.requestBeforeRoute(app);
} if (typeof delegate.requestAfterRoute === 'function') {
delegate.requestAfterRoute(app);
}

同时在这里,有

 enrouten(app).withRoutes({
directory: this._resolve(this._config.get('routes:routePath'))
});

这个其实是处理路由的,它使调用了express-enrouten 模块,进入看看这个函数干了写什么事情,可以看到

module.exports = function (app) {

    return {

        withRoutes: function (settings) {

            settings = settings || {};

            if (settings.index) {
require(resolve(settings.index))(app);
return;
} // Directory to scan for routes
loaddir(settings.directory).forEach(function (file) {
var controller = require(file);
if (typeof controller === 'function' && controller.length === 1) {
controller(app);
}
}); (settings.routes || []).forEach(function (def) {
assert.ok(def.path, 'path is required');
assert.ok(typeof def.handler === 'function', 'handler is required'); var method = (def.method || 'get').toLowerCase();
app[method](def.path, def.handler);
}); }
}; };

可以看到,她直接将每一个controller文件require 进来了。然后直接将他作为了一个构造函数,将app作为一个参数传进去了。 所以在我们的controller 里面都是这种方式:

'use strict';

module.exports = function (server) {

    server.get('/', function (req, res) {
var model = { name: 'helloworld' }; res.render('index', model); }); };

这里的server其实就是app,看到了把,这个就是kraken   的妙处。

paypal之nodejs 框架 Kraken-js 源码分析的更多相关文章

  1. basket.js 源码分析

    basket.js 源码分析 一.前言 basket.js 可以用来加载js脚本并且保存到 LocalStorage 上,使我们可以更加精准地控制缓存,即使是在 http 缓存过期之后也可以使用.因此 ...

  2. DotNetty网络通信框架学习之源码分析

    DotNetty网络通信框架学习之源码分析 有关DotNetty框架,网上的详细资料不是很多,有不多的几个博友做了简单的介绍,也没有做深入的探究,我也根据源码中提供的demo做一下记录,方便后期查阅. ...

  3. events.js 源码分析

    events.js 源码分析 1. 初始化 // 使用 this.ee = new EventEmitter(); // 源码 // 绑定this域,初始化 _events,_eventsCount和 ...

  4. Backbone.js源码分析(珍藏版)

    源码分析珍藏,方便下次阅读! // Backbone.js 0.9.2 // (c) 2010-2012 Jeremy Ashkenas, DocumentCloud Inc. // Backbone ...

  5. Vue.js 源码分析(二十五) 高级应用 插槽 详解

    我们定义一个组件的时候,可以在组件的某个节点内预留一个位置,当父组件调用该组件的时候可以指定该位置具体的内容,这就是插槽的用法,子组件模板可以通过slot标签(插槽)规定对应的内容放置在哪里,比如: ...

  6. Vue.js 源码分析(一) 代码结构

    关于Vue vue是一个兴起的前端js库,是一个精简的MVVM.MVVM模式是由经典的软件架构MVC衍生来的,当View(视图层)变化时,会自动更新到ViewModel(视图模型),反之亦然,View ...

  7. 深入理解分布式调度框架TBSchedule及源码分析

    简介 由于最近工作比较忙,前前后后花了两个月的时间把TBSchedule的源码翻了个底朝天.关于TBSchedule的使用,网上也有很多参考资料,这里不做过多的阐述.本文着重介绍TBSchedule的 ...

  8. $Django cbv源码分析 djangorestframework框架之APIView源码分析

    1 CBV的源码分析 #视图 class login (View): pass #路由 url(r'^books/$', views.login.as_view()) #阅读源码: #左侧工程栏--- ...

  9. Require.js 源码分析

    本文将简单介绍下个人对require.js的源码分析,简单分析实现原理 一.require加载资源的流程 require中,根据AMD(Asynchronous Module Definition)的 ...

  10. Vue.js 源码分析(三十二) 总结

    第一次写博客,坚持了一个多月时间,Vue源码分析基本分析完了,回过头也看也漏了一些地方,比如双向绑定里的观察者模式,也可以说是订阅者模式,也就是Vue里的Dep.Watcher等这些函数的作用,网上搜 ...

随机推荐

  1. 【洛谷P3398】仓鼠找sugar

    画个图就能多少看出些规律 证明借鉴一下大牛的题解: 设从A到B,经过的深度最小的点为X 同理,C,D的为Y 题目是一个点从A出发到B 一个从C出发到D 那么从A到B可以分解成 先从A到X 再从X到B. ...

  2. 如何利用java得到当前的时间和前一天的时间

    1.得到当前的时间 Calendar   cal   =   Calendar.getInstance(); String time=formatter.format(cal.getTime()); ...

  3. 第二章——建立一个HelloWorld项目,练习使用git的add/commit/push/pull/fetch/clone等基本命令。比较项目的新旧版本的差别-----答题者:徐潇瑞

    1.首先下载安装git,很简单所以就不详细说了,当弹出一个类似的命令窗口的东西,就说明Git安装成功 2.因为Git是分布式版本控制系统,所以需要填写用户名和邮箱作为一个标识 3.接着,注册githu ...

  4. Mysql --分区表(1)

    检查是否支持分区 通过如下命令检查的Mysql是否支持partition mysql> SHOW PLUGINS; ... | ARCHIVE | ACTIVE | STORAGE ENGINE ...

  5. 图层的transform属性

    Main.storyboard // //  ViewController.m //  7A11.图层的transform属性 // //  Created by huan on 16/2/4. // ...

  6. struts2--文件上传与下载

    1.文件上传: --表单准备: > 需把HTML表单的enctype属性设置为multipart/form-data; > 需把HTML表单的method属性设置为post: > 需 ...

  7. Adaboost算法初识

    1.算法思想很简单: AdaBoost 是一种迭代算法,其核心思想是针对同一个训练集训练不同的分类器,即弱分类器,然后把这些弱分类器集合起来,构造一个更强的最终分类器.(三个臭皮匠,顶个诸葛亮) 它的 ...

  8. EJB到底是什么,真的那么神秘吗??

    1. 我们不禁要问,什么是"服务集群"?什么是"企业级开发"? 既然说了EJB 是为了"服务集群"和"企业级开发",那么 ...

  9. 不均匀的Windows处理器编组

    不均匀的Windows处理器编组 之前写过一篇文章,关于SQLSERVER能识别多少个逻辑CPU的,前些天在论坛里有人问Windows处理器编组是如何划分的?? SQLSERVER到底能识别多少个逻辑 ...

  10. SQL语句汇总(二)——数据修改、数据查询

    首先创建一张表如下,创建表的方法在上篇介绍过了,这里就不再赘述. 添加新数据: INSERT INTO <表名> (<列名列表>) VALUES (<值列表>)  ...