在yog2框架中自建模塊，以實現socket.io與express共享session中間件

導引

最近遇到了一個需要在yog2框架中增加websocket服務的案子，此文主要講在案子過程中碰到的一些問題和解決方案

由于此文和yog2這個框架高度相關，如需了解yog2請移步 https://github.com/fex-team/yog2

我的做法

需要在yog框架中增加websocket服務，我的做法是在yog的入口文件 yog/app.js 中將socket.io服務器綁定在原有express的server上（也可以綁定在新端口如8081上，看你喜歡），然后在 別處[1] 進行業務邏輯和路由

[1] ：別處的意思是將業務代碼最好放在別的文件夾里，這個根據你們的項目自己決定

我遇到的問題

socket.io服務器的中間件（主要是解析/驗證session的那個）需要重新去寫，當前項目使用配置過的 express-session 中間件完成對session的解析，這完全是重復造輪子

對此問題我的想法

解決方案

新建自己的session解析中間件模塊 mysession ，在yog2的結構樹中的擺放位置如下

├── yog
    ├── app                    
    ├── conf                
    │    ├── plugins                
    │    │    ├── http.js
    │    │    ├── dispatcher.js
    │    │    ├── log.js
    │    │    ├── view.js
    │    │    ├── mysession.js    - mysession模塊的配置文件
    ├── plugins                    
    │    ├── mysession            
    │    │    ├── index.js        - mysession模塊文件
    ├── static
    ├── views
    └── app.js

模塊文件放置入 yog/plugins/mysession/index.js ，詳見 用戶插件相關文檔

module.exports.mysession = function(app, conf){
    return function(){
        app.use(conf);
    };
};

那么坑來了， 官方文檔 里說

yog2 plugin install session

// example using session-file-store to store session
var maxAge = 30 * 24 * 3600 * 1000;
var ttl = maxAge / 1000;
var sessionFileStoreGenerator = require('session-file-store');
var SessionFileStore = sessionFileStoreGenerator(session);
sessionStore = new SessionFileStore({ ttl: ttl });
var conf = session({
    secret: 'mysession-key',
    store: sessionStore,
    resave: false,
    saveUninitialized: true,
    cookie: {
        maxAge: maxAge
    }
});
module.exports.mysession = conf;

最后在 yog/conf/plugins/http.js 中加入這個自定義中間件

// ...
module.exports.http = {
     middleware: [
         // ...
         'views',
         'methodOverride',
         'mysession', //加入我的新中間件
         'dispatcher',
         'notFound',
         'error',
         // ...
     ]
};
// ...

至此，已完成將session解析中間件提取出來，剩下的就是如 此文答案一 中提到的，使用如下代碼共用這個中間件

sio.use(function(socket, next) {
    sessionMiddleware(socket.request, socket.request.res, next);
});

具體實現代碼如下：編輯入口文件 yog/app.js

var yog = require('yog2-kernel');

// 此處載入這個共享的session解析中間件
var sessionMiddleware = require('./conf/plugins/mysession.js').mysession;

var app = yog.bootstrap({
    rootPath: __dirname
}, function(){

    var server = yog.server = app.listen(process.env.PORT || 8080);

    // 以下是為socket.io新加入的代碼

    // 此處綁定在express的server實例上，你也可以綁定一個新端口
    var sio = require('socket.io')(server); 
    sio.use(function(socket, next) {
        sessionMiddleware(socket.request, socket.request.res, next);
    });
    require('../你的socket.io業務邏輯處理與路由代碼文件')(sio);

    // 以上是為socket.io新加入的代碼

});

結語

當然，我對自己的這些解決方案也不是完美認同，比如：

• 編輯入口文件某些情況下并不是best practice，也可以在別處啟動socket服務。

• 通過改變yog2的已有架構來使其更好的支持代碼重用

• 在入口文件中引用模塊也是一個很糟糕的做法，有沒有更優雅的做法呢？

對于在yog2內使用socket的問題、共享中間件的問題等，一定還有更好的解決方案，所以在此拋磚引玉一下，大家都會怎么做？

更多興趣閱讀