name: session 控制

sort: 5

session 控制

beego 内置了 session 模块,目前 session 模块支持的后端引擎包括 memory、cookie、file、mysql、redis、couchbase、memcache、postgres,用户也可以根据相应的 interface 实现自己的引擎。

beego 中使用 session 相当方便,只要在 main 入口函数中设置如下:

  1. beego.BConfig.WebConfig.Session.SessionOn = true

或者通过配置文件配置如下:

  1. sessionon = true

通过这种方式就可以开启 session,如何使用 session,请看下面的例子:

  1. func (this *MainController) Get() {
  2. v := this.GetSession("asta")
  3. if v == nil {
  4. this.SetSession("asta", int(1))
  5. this.Data["num"] = 0
  6. } else {
  7. this.SetSession("asta", v.(int)+1)
  8. this.Data["num"] = v.(int)
  9. }
  10. this.TplName = "index.tpl"
  11. }

session 有几个方便的方法:

  • SetSession(name string, value interface{})
  • GetSession(name string) interface{}
  • DelSession(name string)
  • SessionRegenerateID()
  • DestroySession()

session 操作主要有设置 session、获取 session、删除 session。

当然你可以通过下面的方式自己控制这些逻辑:

  1. sess:=this.StartSession()
  2. defer sess.SessionRelease()

sess 对象具有如下方法:

  • sess.Set()
  • sess.Get()
  • sess.Delete()
  • sess.SessionID()
  • sess.Flush()

但是我还是建议大家采用 SetSession、GetSession、DelSession 三个方法来操作,避免自己在操作的过程中资源没释放的问题。

关于 Session 模块使用中的一些参数设置:

  • beego.BConfig.WebConfig.Session.SessionOn

    设置是否开启 Session,默认是 false,配置文件对应的参数名:sessionon。

  • beego.BConfig.WebConfig.Session.SessionProvider

    设置 Session 的引擎,默认是 memory,目前支持还有 file、mysql、redis 等,配置文件对应的参数名:sessionprovider。

  • beego.BConfig.WebConfig.Session.SessionName

    设置 cookies 的名字,Session 默认是保存在用户的浏览器 cookies 里面的,默认名是 beegosessionID,配置文件对应的参数名是:sessionname。

  • beego.BConfig.WebConfig.Session.SessionGCMaxLifetime

    设置 Session 过期的时间,默认值是 3600 秒,配置文件对应的参数:sessiongcmaxlifetime。

  • beego.BConfig.WebConfig.Session.SessionProviderConfig

    设置对应 file、mysql、redis 引擎的保存路径或者链接地址,默认值是空,配置文件对应的参数:sessionproviderconfig。

  • beego.BConfig.WebConfig.Session.SessionHashFunc

    默认值为 sha1,采用 sha1 加密算法生产 sessionid

  • beego.BConfig.WebConfig.Session.SessionHashKey

    默认的 key 是 beegoserversessionkey,建议用户使用的时候修改该参数

  • beego.BConfig.WebConfig.Session.SessionCookieLifeTime

    设置 cookie 的过期时间,cookie 是用来存储保存在客户端的数据。

从 beego1.1.3 版本开始移除了第三方依赖库,也就是如果你想使用 mysql、redis、couchbase、memcache、postgres 这些引擎,那么你首先需要安装

  1. go get -u github.com/astaxie/beego/session/mysql

然后在你的 main 函数中引入该库, 和数据库的驱动引入是一样的:

  1. import _ "github.com/astaxie/beego/session/mysql"

当 SessionProvider 为 file SessionProviderConfig 是指保存文件的目录,如下所示:

  1. beego.BConfig.WebConfig.Session.SessionProvider="file"
  2. beego.BConfig.WebConfig.Session.SessionProviderConfig = "./tmp"

当 SessionProvider 为 mysql 时,SessionProviderConfig 是链接地址,采用 go-sql-driver,如下所示:

  1. beego.BConfig.WebConfig.Session.SessionProvider = "mysql"
  2. beego.BConfig.WebConfig.Session.SessionProviderConfig = "username:password@protocol(address)/dbname?param=value"
  3. 需要特别注意的是,在使用 mysql 存储 session 信息的时候,需要事先在 mysql 创建表,建表语句如下
  1. CREATE TABLE `session` (
  2. `session_key` char(64) NOT NULL,
  3. `session_data` blob,
  4. `session_expiry` int(11) unsigned NOT NULL,
  5. PRIMARY KEY (`session_key`)
  6. ) ENGINE=MyISAM DEFAULT CHARSET=utf8;

当 SessionProvider 为 redis 时,SessionProviderConfig 是 redis 的链接地址,采用了 redigo,如下所示:

  1. beego.BConfig.WebConfig.Session.SessionProvider = "redis"
  2. beego.BConfig.WebConfig.Session.SessionProviderConfig = "127.0.0.1:6379"

当 SessionProvider 为 memcache 时,SessionProviderConfig 是 memcache 的链接地址,采用了 memcache,如下所示:

  1. beego.BConfig.WebConfig.Session.SessionProvider = "memcache"
  2. beego.BConfig.WebConfig.Session.SessionProviderConfig = "127.0.0.1:7080"

当 SessionProvider 为 postgres 时,SessionProviderConfig 是 postgres 的链接地址,采用了 postgres,如下所示:

  1. beego.BConfig.WebConfig.Session.SessionProvider = "postgresql"
  2. beego.BConfig.WebConfig.Session.SessionProviderConfig = "postgres://pqgotest:password@localhost/pqgotest?sslmode=verify-full"

当 SessionProvider 为 couchbase 时,SessionProviderConfig 是 couchbase 的链接地址,采用了 couchbase,如下所示:

  1. beego.BConfig.WebConfig.Session.SessionProvider = "couchbase"
  2. beego.BConfig.WebConfig.Session.SessionProviderConfig = "http://bucketname:bucketpass@myserver:8091"

特别注意点

因为 session 内部采用了 gob 来注册存储的对象,例如 struct,所以如果你采用了非 memory 的引擎,请自己在 main.go 的 init 里面注册需要保存的这些结构体,不然会引起应用重启之后出现无法解析的错误