6.2 Go如何使用session

通过上一小节的介绍，我们知道session是在服务器端实现的一种用户和服务器之间认证的解决方案，目前Go标准包没有为session提供任何支持，这小节我们将会自己动手来实现go版本的session管理和创建。

session创建过程

session的基本原理是由服务器为每个会话维护一份信息数据，客户端和服务端依靠一个全局唯一的标识来访问这份数据，以达到交互的目的。当用户访问Web应用时，服务端程序会随需要创建session，这个过程可以概括为三个步骤：

  • 生成全局唯一标识符（sessionid）；
  • 开辟数据存储空间。一般会在内存中创建相应的数据结构，但这种情况下，系统一旦掉电，所有的会话数据就会丢失，如果是电子商务类网站，这将造成严重的后果。所以为了解决这类问题，你可以将会话数据写到文件里或存储在数据库中，当然这样会增加I/O开销，但是它可以实现某种程度的session持久化，也更有利于session的共享；
  • 将session的全局唯一标示符发送给客户端。

以上三个步骤中，最关键的是如何发送这个session的唯一标识这一步上。考虑到HTTP协议的定义，数据无非可以放到请求行、头域或Body里，所以一般来说会有两种常用的方式：cookie和URL重写。

  1. Cookie 服务端通过设置Set-cookie头就可以将session的标识符传送到客户端，而客户端此后的每一次请求都会带上这个标识符，另外一般包含session信息的cookie会将失效时间设置为0(会话cookie)，即浏览器进程有效时间。至于浏览器怎么处理这个0，每个浏览器都有自己的方案，但差别都不会太大(一般体现在新建浏览器窗口的时候)；
  2. URL重写 所谓URL重写，就是在返回给用户的页面里的所有的URL后面追加session标识符，这样用户在收到响应之后，无论点击响应页面里的哪个链接或提交表单，都会自动带上session标识符，从而就实现了会话的保持。虽然这种做法比较麻烦，但是，如果客户端禁用了cookie的话，此种方案将会是首选。

Go实现session管理

通过上面session创建过程的讲解，读者应该对session有了一个大体的认识，但是具体到动态页面技术里面，又是怎么实现session的呢？下面我们将结合session的生命周期（lifecycle），来实现go语言版本的session管理。

session管理设计

我们知道session管理涉及到如下几个因素

  • 全局session管理器
  • 保证sessionid 的全局唯一性
  • 为每个客户关联一个session
  • session 的存储(可以存储到内存、文件、数据库等)
  • session 过期处理

接下来我将讲解一下我关于session管理的整个设计思路以及相应的go代码示例：

Session管理器

定义一个全局的session管理器

  2. type Manager struct {
  3.     cookieName  string     // private cookiename
  4.     lock        sync.Mutex // protects session
  5.     provider    Provider
  6.     maxLifeTime int64
  7. }
  9. func NewManager(provideName, cookieName string, maxLifeTime int64) (*Manager, error) {
  10.     provider, ok := provides[provideName]
  11.     if !ok {
  12.         return nil, fmt.Errorf("session: unknown provide %q (forgotten import?)", provideName)
  13.     }
  14.     return &Manager{provider: provider, cookieName: cookieName, maxLifeTime: maxLifeTime}, nil
  15. }

Go实现整个的流程应该也是这样的，在main包中创建一个全局的session管理器

  2. var globalSessions *session.Manager
  3. //然后在init函数中初始化
  4. func init() {
  5.     globalSessions, _ = NewManager("memory", "gosessionid", 3600)
  6. }

我们知道session是保存在服务器端的数据，它可以以任何的方式存储，比如存储在内存、数据库或者文件中。因此我们抽象出一个Provider接口，用以表征session管理器底层存储结构。

  2. type Provider interface {
  3.     SessionInit(sid string) (Session, error)
  4.     SessionRead(sid string) (Session, error)
  5.     SessionDestroy(sid string) error
  6.     SessionGC(maxLifeTime int64)
  7. }
  • SessionInit函数实现Session的初始化，操作成功则返回此新的Session变量
  • SessionRead函数返回sid所代表的Session变量，如果不存在，那么将以sid为参数调用SessionInit函数创建并返回一个新的Session变量
  • SessionDestroy函数用来销毁sid对应的Session变量
  • SessionGC根据maxLifeTime来删除过期的数据

那么Session接口需要实现什么样的功能呢？有过Web开发经验的读者知道，对Session的处理基本就 设置值、读取值、删除值以及获取当前sessionID这四个操作，所以我们的Session接口也就实现这四个操作。

  2. type Session interface {
  3.     Set(key, value interface{}) error // set session value
  4.     Get(key interface{}) interface{}  // get session value
  5.     Delete(key interface{}) error     // delete session value
  6.     SessionID() string                // back current sessionID
  7. }

以上设计思路来源于database/sql/driver，先定义好接口，然后具体的存储session的结构实现相应的接口并注册后，相应功能这样就可以使用了，以下是用来随需注册存储session的结构的Register函数的实现。

  2. var provides = make(map[string]Provider)
  4. // Register makes a session provide available by the provided name.
  5. // If Register is called twice with the same name or if driver is nil,
  6. // it panics.
  7. func Register(name string, provider Provider) {
  8.     if provider == nil {
  9.         panic("session: Register provider is nil")
  10.     }
  11.     if _, dup := provides[name]; dup {
  12.         panic("session: Register called twice for provider " + name)
  13.     }
  14.     provides[name] = provider
  15. }

全局唯一的Session ID

Session ID是用来识别访问Web应用的每一个用户，因此必须保证它是全局唯一的（GUID），下面代码展示了如何满足这一需求：

  2. func (manager *Manager) sessionId() string {
  3.     b := make([]byte, 32)
  4.     if _, err := rand.Read(b); err != nil {
  5.         return ""
  6.     }
  7.     return base64.URLEncoding.EncodeToString(b)
  8. }

session创建

我们需要为每个来访用户分配或获取与他相关连的Session，以便后面根据Session信息来验证操作。SessionStart这个函数就是用来检测是否已经有某个Session与当前来访用户发生了关联，如果没有则创建之。

  2. func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (session Session) {
  3.     manager.lock.Lock()
  4.     defer manager.lock.Unlock()
  5.     cookie, err := r.Cookie(manager.cookieName)
  6.     if err != nil || cookie.Value == "" {
  7.         sid := manager.sessionId()
  8.         session, _ = manager.provider.SessionInit(sid)
  9.         cookie := http.Cookie{Name: manager.cookieName, Value: url.QueryEscape(sid), Path: "/", HttpOnly: true, MaxAge: int(manager.maxLifeTime)}
  10.         http.SetCookie(w, &cookie)
  11.     } else {
  12.         sid, _ := url.QueryUnescape(cookie.Value)
  13.         session, _ = manager.provider.SessionRead(sid)
  14.     }
  15.     return
  16. }

我们用前面login操作来演示session的运用：

  2. func login(w http.ResponseWriter, r *http.Request) {
  3.     sess := globalSessions.SessionStart(w, r)
  4.     r.ParseForm()
  5.     if r.Method == "GET" {
  6.         t, _ := template.ParseFiles("login.gtpl")
  7.         w.Header().Set("Content-Type", "text/html")
  8.         t.Execute(w, sess.Get("username"))
  9.     } else {
  10.         sess.Set("username", r.Form["username"])
  11.         http.Redirect(w, r, "/", 302)
  12.     }
  13. }

操作值：设置、读取和删除

SessionStart函数返回的是一个满足Session接口的变量，那么我们该如何用他来对session数据进行操作呢？

上面的例子中的代码session.Get("uid")已经展示了基本的读取数据的操作，现在我们再来看一下详细的操作:

  2. func count(w http.ResponseWriter, r *http.Request) {
  3.     sess := globalSessions.SessionStart(w, r)
  4.     createtime := sess.Get("createtime")
  5.     if createtime == nil {
  6.         sess.Set("createtime", time.Now().Unix())
  7.     } else if (createtime.(int64) + 360) < (time.Now().Unix()) {
  8.         globalSessions.SessionDestroy(w, r)
  9.         sess = globalSessions.SessionStart(w, r)
  10.     }
  11.     ct := sess.Get("countnum")
  12.     if ct == nil {
  13.         sess.Set("countnum", 1)
  14.     } else {
  15.         sess.Set("countnum", (ct.(int) + 1))
  16.     }
  17.     t, _ := template.ParseFiles("count.gtpl")
  18.     w.Header().Set("Content-Type", "text/html")
  19.     t.Execute(w, sess.Get("countnum"))
  20. }

通过上面的例子可以看到，Session的操作和操作key/value数据库类似:Set、Get、Delete等操作

因为Session有过期的概念，所以我们定义了GC操作，当访问过期时间满足GC的触发条件后将会引起GC，但是当我们进行了任意一个session操作，都会对Session实体进行更新，都会触发对最后访问时间的修改，这样当GC的时候就不会误删除还在使用的Session实体。

session重置

我们知道，Web应用中有用户退出这个操作，那么当用户退出应用的时候，我们需要对该用户的session数据进行销毁操作，上面的代码已经演示了如何使用session重置操作，下面这个函数就是实现了这个功能：

  2. //Destroy sessionid
  3. func (manager *Manager) SessionDestroy(w http.ResponseWriter, r *http.Request){
  4.     cookie, err := r.Cookie(manager.cookieName)
  5.     if err != nil || cookie.Value == "" {
  6.         return
  7.     } else {
  8.         manager.lock.Lock()
  9.         defer manager.lock.Unlock()
  10.         manager.provider.SessionDestroy(cookie.Value)
  11.         expiration := time.Now()
  12.         cookie := http.Cookie{Name: manager.cookieName, Path: "/", HttpOnly: true, Expires: expiration, MaxAge: -1}
  13.         http.SetCookie(w, &cookie)
  14.     }
  15. }

session销毁

我们来看一下Session管理器如何来管理销毁，只要我们在Main启动的时候启动：

  2. func init() {
  3.     go globalSessions.GC()
  4. }
  2. func (manager *Manager) GC() {
  3.     manager.lock.Lock()
  4.     defer manager.lock.Unlock()
  5.     manager.provider.SessionGC(manager.maxLifeTime)
  6.     time.AfterFunc(time.Duration(manager.maxLifeTime), func() { manager.GC() })
  7. }

我们可以看到GC充分利用了time包中的定时器功能，当超时maxLifeTime之后调用GC函数，这样就可以保证maxLifeTime时间内的session都是可用的，类似的方案也可以用于统计在线用户数之类的。

总结

至此 我们实现了一个用来在Web应用中全局管理Session的SessionManager，定义了用来提供Session存储实现Provider的接口，下一小节，我们将会通过接口定义来实现一些Provider,供大家参考学习。