Express运用mongodb治理会话贮存 connect-mongo模块简介

2023年1月3日 212次阅读来源: ASCll

简介

在我的前一篇小文中express-session小书提到了express-session能够替代会话贮存.

那末这篇文章我们就来讲讲express在举行会话治理的时刻如何将会话数据保留在外部数据库中,本文中我们运用mongodb用作会话贮存数据库.

本文中运用的模块以及版本号一览:

模块称号	版本号
express	`4.16.4`
mongodb	`3.1.8`
express-session	`1.15.6`
connect-mongo	`2.0.3`

`connect-mongo`特征

支撑Express5
支撑一切版本的Connect
支撑Mongoose>=4.1.2+
支撑原生Mongodb驱动>=2.0.36
支撑Node.js 4 6 8 10
支撑Mongodb>=3.0

事前剖析

因为mongodb客户端和服务器能够是多对多的关联,故有以下组合.

一个客户端衔接多个服务器
多个客户端衔接一个服务器
多个客户端衔接多个服务器
一个客户端衔接一个服务器

本文重要解说一个客户端衔接一个服务器.

这类状况下,平常服务器监听一个端口,而我们愿望能够同享同一个mongodb驱动的实例.

然则在平常状况下,我们的mongodb数据库不可能只用于会话治理使命,所以本文复用同一个衔接(端口).

只需复用同一个衔接能够完成,那末运用零丁的驱动实例来用作会话治理也就不在话下了.

起步

起首我们引入一切的模块:

const
    Express = require('express')(),
    MongoClient = require('mongodb').MongoClient,
    ExpressSession = require('express-session'),
    MongoStore= require('connect-mongo')(ExpressSession);

看起来connect-mongo须要将express-session包装一下,这步是牢固的.

接下来我们定义几个常量用于衔接数据库:

const
    UrlOfDb = 'mongodb://localhost:27017',
    NameOfDb = 'demo',
    Client = new MongoClient(UrlOfDb);// 建立mongodb客户端

客户端衔接数据库:

Client.connect((error) => {

    if (error) {
        throw error;
    }
    
});

运用一个数据表,而且查询几条数据:

    const
        DataBase = Client.db(NameOfDb),
        Collection = DataBase.collection('sessions');
        
    Collection.find({}).toArray((error, result) => {

        if (error) {
            throw error;
        }
    
        for (const element of result) {
    
            console.log(element);
    
        }

    });

到目前为止我们没有举行session治理,你能够替代本例中的数据表称号用于测试一下运转是不是一般.

完全代码:

const
    Express = require('express')(),
    MongoClient = require('mongodb').MongoClient,// 猎取数据库驱动
    ExpressSession = require('express-session'),// 猎取session中间件
    MongoStore= require('connect-mongo')(ExpressSession);// 猎取session贮存插件
    
const
    UrlOfDb = 'mongodb://localhost:27017',
    NameOfDb = 'demo',
    Client = new MongoClient(UrlOfDb);// 建立客户端
    
Client.connect((error) => {

    if (error) {
        throw error;
    }
    
    const
        DataBase = Client.db(NameOfDb),// 猎取数据库
        Collection = DataBase.collection('sessions'); // 猎取数据表
    
    // 查询数据表
    Collection.find({}).toArray((error, result) => {

        if (error) {
            throw error;
        }

        for (const element of result) {

            console.log(element);

        }

    });
    
});

如今我们来运用express-session中间件,而且替代掉默许的贮存:

// +++++

const
    DataBase = Client.db(NameOfDb),// 猎取数据库
    Collection = DataBase.collection('sessions'),// 猎取数据表
    MongoStoreInstance = new MongoStore({ // 建立一个贮存实例,传入db参数关于的数据库对象
        db:DataBase
    });

// 运用中间件
Express.use(ExpressSession({
    secret: 'hello mongo',// cookie署名
    cookie: {maxAge: 1800000},
    rolling:true,
    saveUninitialized:true,
    resave: false,
    store:MongoStoreInstance // 替代掉默许的贮存
}));

// +++++++

注重:connect-mongo会在该database下建立一个sessions的数据表(没有这个数据表的状况下).

增加一个路由用于完成简朴的考证,用于测试是不是一般事情:

Express.get('/',(request,response)=>{

    if(request.session.name){

        response.send(`迎接返来${request.session.name}`);

        return ;
    }
    
    // 运用查询字符串看成保留的信息
    request.session.name = request.query.name;
    request.session.pwd = request.query.pwd;

    response.send(`迎接登录${request.session.name}`);

});

// 启动服务器
Express.listen(8888, function () {

    console.log('server is listening 8888 port!');

});

完全代码:

const
    Express = require('express')(),
    MongoClient = require('mongodb').MongoClient,
    ExpressSession = require('express-session'),
    MongoStore= require('connect-mongo')(ExpressSession);


const
    UrlOfDb = 'mongodb://localhost:27017',
    NameOfDb = 'demo',
    Client = new MongoClient(UrlOfDb);


function destroyDb(Client) {

    return destroyDb = function () {

        const info = 'Client has been closed!';

        Client.close();
        Client = null;
        console.log(info);

        return info;

    }
}

Client.connect((error) => {

    if (error) {
        throw error;
    }

    const
        DataBase = Client.db(NameOfDb),
        Collection = DataBase.collection('sessions'),
        MongoStoreInstance = new MongoStore({
            db:DataBase
        });


    Express.use(ExpressSession({
        secret: 'hello mongo',
        cookie: {maxAge: 1800000},
        rolling:true,
        saveUninitialized:true,
        resave: false,
        store:MongoStoreInstance
    }));

    // 运用闭包将封闭数据库挂载到全局
    destroyDb(Client);

    // 展现复用一个衔接
    Collection.find({}).toArray((error, result) => {

        if (error) {
            throw error;
        }

        for (const element of result) {

            console.log(element);

        }

    });

    Express.get('/',(request,response)=>{

        if(request.session.name){

            response.send(`迎接返来${request.session.name}`);

            return ;
        }

        request.session.name = request.query.name;
        request.session.pwd = request.query.pwd;

        response.send(`迎接登录${request.session.name}`);

    });

    Express.get('/closedatabase',  (request, respnose) => {

        respnose.send(destroyDb());

    });


    Express.listen(8888, function () {

        console.log('server is listening 8888 port!');

    });

});

注重:我没有删除数据库表的通例输出,在这个例子启动的时刻,你会发明他们共用了同一个衔接,启动的时刻会先输出数据表中的内容.

测试

在阅读器中输入以下内容:

http://localhost:8888/?name=ascll&pwd=123456

阅读器输出:

迎接登录ascll

直接再次接见该页面:

http://localhost:8888/

阅读器输出:

迎接返来ascll

此时在数据库中手动查询后,或许重启本项目,你会在掌握台中发明上次留下的session纪录:

{ _id: 'qbP36wE0nJkvtyNqx_6Amoesjjcsr-sD',
  expires: 2018-12-14T08:27:19.809Z,
  session:
   '{"cookie":{"originalMaxAge":1800000,"expires":"2018-12-14T08:20:21.519Z","httpOnly":true,"path":"/"},"name":"ascll","pwd":"123456"}' }

运用总结

引入connect-mongo和express-session然后挪用connect-mongo将express-sessino传入
猎取上一步返回的类,然后运用express-session中间件的时刻关于store选传入这个类的实例对象

api

建立

Express 4.x, 5.0 and Connect 3.x:

const session = require('express-session');
const MongoStore = require('connect-mongo')(session);
 
app.use(session({
    secret: 'foo',
    store: new MongoStore(options)
}));

Express 2.x, 3.x and Connect 1.x, 2.x:

const MongoStore = require('connect-mongo')(express);
 
app.use(express.session({
    secret: 'foo',
    store: new MongoStore(options)
}));

衔接到MongoDb

运用`mongoose`

const mongoose = require('mongoose');
 
// 基础运用
mongoose.connect(connectionOptions);
 
app.use(session({
    store: new MongoStore({ mongooseConnection: mongoose.connection })
}));
 
// 发起运用体式格局,如许能够复用衔接
const connection = mongoose.createConnection(connectionOptions);
 
app.use(session({
    store: new MongoStore({ mongooseConnection: connection })
}));

运用Mongo原生Node驱动

这类状况下你须要将一个mongodb驱动的一个数据库实例传递给connect-mongo.假如数据库没有打开connect-mongo会自动帮你衔接.

/*
    这里有很多种体式格局来猎取一个数据库实例,详细能够参考官网文档.
*/

app.use(session({
    store: new MongoStore({ db: dbInstance }) // 别忘了MongoStore是connect-mongo传入express-session后返回的一个函数
}));

// 或许也能够运用Promise版本

app.use(session({
    store: new MongoStore({ dbPromise: dbInstancePromise })
}));

经由过程衔接字符串建立一个衔接

// Basic usage
app.use(session({
    store: new MongoStore({ url: 'mongodb://localhost/test-app' })
}));
 
// Advanced usage
app.use(session({
    store: new MongoStore({
        url: 'mongodb://user12345:foobar@localhost/test-app?authSource=admins&w=1',
        mongoOptions: advancedOptions // See below for details
    })
}));

事宜

一个MongoStore实例有以下的事宜:

事宜称号	形貌	回调参数
create	session建立后触发	sessionId
touch	session被猎取然则未修正	sessionId
update	session被更新	sessionId
set	session建立后或许更新后(为了兼容)	sessionId
destroy	session被烧毁后	sessionId

运用我们之前的例子中增加以下的代码:

// +++
MongoStoreInstance.on('create',(sessionId)=>{
    console.log('create',sessionId);
});

MongoStoreInstance.on('touch',(sessionId)=>{
    console.log('create', sessionId);
});

MongoStoreInstance.on('update',(sessionId)=>{
    console.log('update', sessionId);
});

MongoStoreInstance.on('set',(sessionId)=>{
    console.log('set', sessionId);
});

MongoStoreInstance.on('destroy',(sessionId)=>{
    console.log('destroy', sessionId);
});

// +++

清空cookie后再次运转服务器,多实行几个操纵你就能够看到session的建立以及修正等操纵.

session逾期处置惩罚

基础处置惩罚体式格局

connect-mongo只会运用设置了逾期时候的cookie,假如没有设置则会建立一个新的cookie而且运用tll选项来指定逾期时候:

app.use(session({
    store: new MongoStore({
      url: 'mongodb://localhost/test-app',
      ttl: 14 * 24 * 60 * 60 // 默许逾期时候为14天
    })
}));

注重:用户的每次接见都邑革新逾期时候.

删除逾期session

默许状况下connect-mongo运用MongoDB's TTL collection特征(2.2+)用于自动的移出逾期的session.然则你能够修正这类行动.

connect-mongo会在最先的时刻建立一个TTl索引,条件是你的Mongo db版本在(2.2+)且有权限实行这一操纵.

app.use(session({
    store: new MongoStore({
      url: 'mongodb://localhost/test-app',
      autoRemove: 'native' // Default
    })
}));

注重:这类默许的行动不适用于高并发的状况,这类状况下你须要禁用默许形式,然后自行定义TTl索引.

运用兼容形式

假如你运用了Mongodb的老版本或许不愿望建立TTL索引,你能够指定一个间隔时候让connect-mongo来删除这些逾期的session.

app.use(session({
    store: new MongoStore({
      url: 'mongodb://localhost/test-app',
      autoRemove: 'interval',
      autoRemoveInterval: 10 // 单元分钟
    })
}));

禁用逾期session删除

app.use(session({
    store: new MongoStore({
      url: 'mongodb://localhost/test-app',
      autoRemove: 'disabled'
    })
}));

session懒更新

假如你运用的express-session版本>=1.10,然后不愿望用户每次阅读页面的时刻或革新页面的时刻都要从新保留,你能够限定一段时候内更新session.

app.use(express.session({
    secret: 'keyboard cat',
    saveUninitialized: false, // 假如不保留则不会建立session
    resave: false, // 假如未修正则不会保留
    store: new MongoStore({
        url: 'mongodb://localhost/test-app',
        touchAfter: 24 * 3600 // 指定触发间隔时候 单元秒
    })
}));

经由过程如许设置session只会在24小时内触发1次不管用户阅读多少次页面或许革新多少次.修正session除外.

其他选项

collection 指定缓存数据表的名字默许sessions
fallbackMemory 回退处置惩罚默许运用MemoryStore举行存储
stringify 默许是true,假如为true则序列化和反序列化运用原生的JSON.xxx处置惩罚.
serialize 自定义序列化函数
unserialize 自定义反序列化函数
transformId 将sessionId转为你想要的任何键然后举行贮存

暗坑

也不算是暗坑吧,一用有两点:

Mongodb客户端一般封闭后connect-mongo会报错,虽然会被Express阻拦然则这个模块没有供应error事宜.
Express中间件必需同步挂载?在我的例子中尝试异步加载express-session中间件,然则失利了中间件没有结果.

`connect-mongo`模块npm地点

https://www.npmjs.com/package…

    原文作者：ASCll
    原文地址: https://segmentfault.com/a/1190000017383466
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。

简介

connect-mongo特征