paypal之nodejs 框架 Kraken-js 源码分析
本文是基于 kraken-js 0.6.1 版本的
關(guān)于如何使用kraken-js 可以去看看官網(wǎng)的使用文檔 點(diǎn)擊這里?。kraken-js 是基于express之上的,目的在于讓工程師更多的去關(guān)注代碼邏輯,少關(guān)注自身的開發(fā)環(huán)境,所以他將express所有的一些公用的配置都寫在了配置文件里面了。暴露給開發(fā)者的很少。下面來看看kraken-js 源碼,分析是如何創(chuàng)建nodejs應(yīng)用程序的。如果對express 不太理解的,可以看看我之前博客寫的express框架解密序列。
按照kraken-js 官網(wǎng)上的步驟,我們創(chuàng)建了一個(gè)新項(xiàng)目,然后生成了代碼是這個(gè)樣子的:
對這個(gè)結(jié)構(gòu)說明下:
- /config ?---應(yīng)用程序和中間件的配置
- /controllers ?---路由和邏輯
- /lib ---用戶開發(fā)的第三方庫
- /locales ---語言包
- /models ?---模型
- /public ---公共資源
- /public/templates ---模板
- /tests ---一些測試用例
- index.js ---應(yīng)用程序入口
我們看看入口文件 index.js ?和路由文件controllers/index.js
'use strict';var kraken = require('kraken-js'),app = {};app.configure = function configure(nconf, next) {// Fired when an app configures itselfnext(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 文件里面,沒有端口設(shè)置,沒有模板引擎以及其他的中間件設(shè)置,只有一些鉤子,這個(gè)就是kraken-js 的巧妙之處。
具體做法是:
首先創(chuàng)建一個(gè)app,給app添加一些方法(configure,requestStart,requestBeforeRoute,requestAfterRoute),再將app作為kraken的create方法參數(shù)
傳進(jìn)去,kraken.create(app),然后在調(diào)用listen方法(主要是調(diào)用http的createServer創(chuàng)建一個(gè)服務(wù))。其實(shí)這里的app是一些鉤子,作為代理的方式給express框架使用,這些方法的參數(shù)server 就是express 框架創(chuàng)建的實(shí)例。我們在使用的時(shí)候,都是通過express的use方法來調(diào)用中間件的。這個(gè)后面會(huì)有詳細(xì)的解釋。
既然調(diào)用了kraken 的create方法,我們就去看看kraken 的源碼,看看是怎么構(gòu)造這個(gè)應(yīng)用程序的。
我們看到在kraken-js/index.js 中,提供了一個(gè)對外的調(diào)用函數(shù):
exports.create = function (route, delegate) {return create().use(route, delegate); };可以看到它先調(diào)用了本身的create方法,然后調(diào)用了use方法,我們?nèi)タ纯碿reate方法:
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: '?'}}); }它創(chuàng)建了一個(gè)kraken的對象,然后添加了一些屬性。在use的方法中,最重要的是:
chain = create(this._app).then(assign).then(create).then(mount);首先,通過調(diào)用create方法傳入了一個(gè)空的app,而這個(gè)create方法是
function create(delegate) {return appcore.create(delegate, pathutil.create(resolveRoot));}它直接調(diào)用了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);}); }我們知道這個(gè)這個(gè)參數(shù)的app是為空的。所以進(jìn)入了這個(gè)分支:
app = express();if (!delegate) {patch.apply('stream', app);callback(null, app);return;}直接將express導(dǎo)入進(jìn)來了。patch.apply('stream', app); 是將app的response 直接改寫了。返回了express 。接著執(zhí)行:
.then(assign)
.then(create)
.then(mount);
assign 是將app賦值給this._app 了,同時(shí)做了第二件事情,將應(yīng)用程序的那些鉤子返回出來,直接傳遞給create函數(shù),我們看到create函數(shù)再次調(diào)用了,與第一次不同的是,本次的參數(shù)不為空,
而是我們在應(yīng)用程序創(chuàng)建的那個(gè)“app”,即為我們之前所說的鉤子。最后在掛載這個(gè)應(yīng)用程序。
在第二次調(diào)用create方法。其實(shí)就是通過proto 創(chuàng)建了一個(gè)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}});我們看到將這個(gè)app作為appcore的_app 屬性,將delegate 其實(shí)就是作為_delagate ?的一個(gè)屬性。這個(gè)就是index.js 傳入的那個(gè)參數(shù)app對象,接著調(diào)用了proto的init方法:
appcore.init(function (err) {if (err) {callback(err);return;}callback(null, app);});init 是直接調(diào)用了?_configure 方法,在這個(gè)方法中,首先通過賦值app為?app ?= this._app;然后通過方法?this._config = config.create(this._resolve('.'));,讀取kraken和本應(yīng)用程序config 目錄下得config文件。最后再調(diào)用?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();}這個(gè)方法中,首先配置了一些參數(shù)。
然后再調(diào)用了處理視圖的參數(shù)_views(),接著調(diào)用了?_middleware()函數(shù)。
我們看到:
if (typeof this._delegate.configure === 'function') {this._delegate.configure(this._config.raw, next);return;}如果configure 是一個(gè)函數(shù),那么先調(diào)用這個(gè),然后再調(diào)用那個(gè)next方法。在前面我們說過,this._delegate 其實(shí)就是index.js 里面創(chuàng)建的那個(gè)“app” 鉤子。
視圖我們省略,我們主要看看怎么調(diào)用_middleware 函數(shù)這個(gè)函數(shù)都做了些什么。還是先上源碼:
_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 的基本配置,它的一些配置都寫在這里面了。
我們看到這些,這些就是處理我們之前的那些鉤子函數(shù)了。看到了吧,都是傳入express 構(gòu)建的應(yīng)用程序。
if (typeof delegate.requestStart === 'function') {delegate.requestStart(app);}if (typeof delegate.requestBeforeRoute === 'function') {delegate.requestBeforeRoute(app);}if (typeof delegate.requestAfterRoute === 'function') {delegate.requestAfterRoute(app);}同時(shí)在這里,有
enrouten(app).withRoutes({directory: this._resolve(this._config.get('routes:routePath'))});這個(gè)其實(shí)是處理路由的,它使調(diào)用了express-enrouten 模塊,進(jìn)入看看這個(gè)函數(shù)干了寫什么事情,可以看到
module.exports = function (app) {return {withRoutes: function (settings) {settings = settings || {};if (settings.index) {require(resolve(settings.index))(app);return;}// Directory to scan for routesloaddir(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);});}};};可以看到,她直接將每一個(gè)controller文件require 進(jìn)來了。然后直接將他作為了一個(gè)構(gòu)造函數(shù),將app作為一個(gè)參數(shù)傳進(jìn)去了。 所以在我們的controller 里面都是這種方式:
'use strict';module.exports = function (server) {server.get('/', function (req, res) {var model = { name: 'helloworld' };res.render('index', model);});};這里的server其實(shí)就是app,看到了把,這個(gè)就是kraken ? 的妙處。
轉(zhuǎn)載于:https://www.cnblogs.com/yupeng/p/3484189.html
總結(jié)
以上是生活随笔為你收集整理的paypal之nodejs 框架 Kraken-js 源码分析的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Excel 使用AutoFill提示“类
- 下一篇: js之定时器