https://github.com/eggjs/egg-session

session plugin for egg
https://github.com/eggjs/egg-session

egg egg-plugin egg-session session

Last synced: about 1 month ago
JSON representation

session plugin for egg

• Host: GitHub
• URL: https://github.com/eggjs/egg-session
• Owner: eggjs
• License: mit
• Created: 2016-07-14T09:40:54.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-02T14:35:09.000Z (6 months ago)
• Last Synced: 2024-10-29T21:05:54.466Z (about 1 month ago)
• Topics: egg, egg-plugin, egg-session, session
• Language: JavaScript
• Size: 43 KB
• Stars: 49
• Watchers: 9
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-egg - egg-session - Session 实现。   (仓库 / [内置插件](https://eggjs.org/zh-cn/basics/plugin.html#%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8))

README

        
# egg-session

[![NPM version][npm-image]][npm-url]

[![Test coverage][codecov-image]][codecov-url]

[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-session.svg?style=flat-square

[npm-url]: https://npmjs.org/package/egg-session

[codecov-image]: https://codecov.io/github/eggjs/egg-session/coverage.svg?branch=master

[codecov-url]: https://codecov.io/github/eggjs/egg-session?branch=master

[download-image]: https://img.shields.io/npm/dm/egg-session.svg?style=flat-square

[download-url]: https://npmjs.org/package/egg-session

Session plugin for egg, based on [koa-session](https://github.com/koajs/session).

## Install

```bash

npm i egg-session --save

```

## Usage

egg-session is a built-in plugin in egg and enabled by default.

```js

// {app_root}/config/plugin.js

exports.session = true; // enable by default

```

### External Store

egg-session support external store, you can store your sessions in redis, memcached or other databases.

For example, if you want to store session in redis, you must:

1. Dependent [egg-redis](https://github.com/eggjs/egg-redis)

  ```bash

  npm i --save egg-redis

  ```

2. Import egg-redis as a plugin and set the configuration

  ```js

  // config/plugin.js

  exports.redis = {

    enable: true,

    package: 'egg-redis',

  };

  ```

  ```js

  // config/config.default.js

  exports.redis = {

    // your redis configurations

  };

  ```

3. Implement a session store with redis

  ```js

  // app.js

  module.exports = app => {

    // set redis session store

    // session store must have 3 methods

    // define sessionStore in `app.js` so you can access `app.redis`

    app.sessionStore = {

      async get(key) {

        const res = await app.redis.get(key);

        if (!res) return null;

        return JSON.parse(res);

      },

      async set(key, value, maxAge) {

        // maxAge not present means session cookies

        // we can't exactly know the maxAge and just set an appropriate value like one day

        if (!maxAge) maxAge = 24 * 60 * 60 * 1000;

        value = JSON.stringify(value);

        await app.redis.set(key, value, 'PX', maxAge);

      },

      async destroy(key) {

        await app.redis.del(key);

      },

    };

    // session store can be a session store class

    // app.sessionStore = class Store {

    //   constructor(app) {

    //     this.app = app;

    //   }

    //   async get() {}

    //   async set() {}

    //   async destroy() {}

    // };

  };

  ```

Once you use external session store, session is strong dependent on your external store, you can't access session if your external store is down. **Use external session stores only if necessary, avoid use session as a cache, keep session lean and stored by cookie!**

## Configuration

Support all configurations in [koa-session](https://github.com/koajs/session).

* logValue

```bash

Support not to print the session value when session event trigger log. Default to be true.

```

[View the default configurations](https://github.com/eggjs/egg-session/blob/master/config/config.default.js)

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](https://github.com/eggjs/egg-session/blob/master/LICENSE)