beego源码解析三（session模块）

雨点打透心脏的1/2处 2022-10-05 14:56 152阅读 0赞

session 模块是用来存储客户端用户，session 模块目前只支持 cookie 方式的请求，如果客户端不支持 cookie，那么就无法使用该模块。

beego session模块代码结构

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70][]

看readme可以看到使用方法

首先必须导入包：

import (
    	"github.com/astaxie/beego/session"
    )

然后需要定义一个全局变量

var globalSessions *session.Manager

最后通过下面的方式就可以使用session

func init() {
    	globalSessions, _ = session.NewManager("memory", `{"cookieName":"gosessionid", "enableSetCookie,omitempty": true, "gclifetime":3600, "maxLifetime": 3600, "secure": false, "sessionIDHashFunc": "sha1", "sessionIDHashKey": "", "cookieLifeTime": 3600, "providerConfig": ""}`)
    	go globalSessions.GC()
    }

上面是readme.md文件种介绍的session模块的使用方式。

我们看看beego是怎么样来使用这个模块的。

鼠标单击session.NewManager就能看到它在哪里使用了，可以看到beego种在如下函数中使用此sessino模块

func registerSession() error {
    	if BConfig.WebConfig.Session.SessionOn {
    		var err error
    		sessionConfig := AppConfig.String("sessionConfig")
    		conf := new(session.ManagerConfig)
    		if sessionConfig == "" {
    			conf.CookieName = BConfig.WebConfig.Session.SessionName
    			conf.EnableSetCookie = BConfig.WebConfig.Session.SessionAutoSetCookie
    			conf.Gclifetime = BConfig.WebConfig.Session.SessionGCMaxLifetime
    			conf.Secure = BConfig.Listen.EnableHTTPS
    			conf.CookieLifeTime = BConfig.WebConfig.Session.SessionCookieLifeTime
    			conf.ProviderConfig = filepath.ToSlash(BConfig.WebConfig.Session.SessionProviderConfig)
    			conf.DisableHTTPOnly = BConfig.WebConfig.Session.SessionDisableHTTPOnly
    			conf.Domain = BConfig.WebConfig.Session.SessionDomain
    			conf.EnableSidInHTTPHeader = BConfig.WebConfig.Session.SessionEnableSidInHTTPHeader
    			conf.SessionNameInHTTPHeader = BConfig.WebConfig.Session.SessionNameInHTTPHeader
    			conf.EnableSidInURLQuery = BConfig.WebConfig.Session.SessionEnableSidInURLQuery
    		} else {
    			if err = json.Unmarshal([]byte(sessionConfig), conf); err != nil {
    				return err
    			}
    		}
    		if GlobalSessions, err = session.NewManager(BConfig.WebConfig.Session.SessionProvider, conf); err != nil {
    			return err
    		}
    		go GlobalSessions.GC()
    	}
    	return nil
    }

上面的代码很简单。

1.首先要配置session ON状态，

2.从配置文件中读取sessionConfig，读出来是个字符串，

3.如果配置文件中没有配置sessionConfig，也就是字符串为空，那么就使用默认配置（见上一篇，这结构中的配置会先初始化一些配置项填入其中）

4.如果读取到了sessionConfig字符串，则将他反序列化成conf结构，

5.接着就是session模块中readme.md中介绍的那样，先newManager,再gc

**此处有个问题**：

readme中传入的是一个字符串，为啥beego使用时传入的是一个配置结构体呢？

查看源码

func NewManager(provideName string, cf *ManagerConfig) (*Manager, error) {
        ...
    }

参数确实是一个ManagerConfig结构体指针，那么readme.md中为啥传入一个字符串呢？

难道会自动进行反序列化？

我决定实验一下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 1][]

奇怪，怎么不行？难道readme.md写的有问题？

我决定去beego使用session的那个函数，将conf改为字符串试试

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 2][]

？？？？

坑爹呢？

那readme.md写错了？我直接拷贝readme.md中的那串字符串过去的。如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 3][]

擦，坑爹呢这是？

\--------------------------------------------

先划过，先看源码吧！

session模块和上一篇的config模块一样，也是采用工厂模式，采用了一个接口，多个实现的方式。目前实现了 memory、 file、Redis 和 MySQL 四种存储引擎。

接口：此处需要实现两个接口，一个Provider，一个Store.Store用于存储，而Provide用于session相关，会用到Store接口。

type Provider interface {
    	SessionInit(gclifetime int64, config string) error
    	SessionRead(sid string) (Store, error)
    	SessionExist(sid string) bool
    	SessionRegenerate(oldsid, sid string) (Store, error)
    	SessionDestroy(sid string) error
    	SessionAll() int //get all active session
    	SessionGC()
    }
    // Store contains all data for one session process with specific id.
    type Store interface {
    	Set(key, value interface{}) error     //set session value
    	Get(key interface{}) interface{}      //get session value
    	Delete(key interface{}) error         //delete session value
    	SessionID() string                    //back current sessionID
    	SessionRelease(w http.ResponseWriter) // release the resource & save data to provider & return the data
    	Flush() error                         //delete all data
    }

来看一个file的实现：、

首先实现了store接口

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 4][]

接着实现了Provider接口

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 5][]

最后调用session的注册函数，将其注册到session模块

func init() {
    	Register("file", filepder)
    }

很简单，具体怎么实现的，不深究了，有需要再看

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70]: /images/20221005/4370383221034966bdfa21f166affb59.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 1]: /images/20221005/9cd8d0aa09034197aaa942ef2366c83e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 2]: /images/20221005/0138ec1d1076408592f8485772db4062.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 3]: /images/20221005/7130e9bea61c426386ba9058181cc4e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 4]: /images/20221005/afd9441fc68340eaadf493c92121289d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTMxOTcxMzkyNQ_size_16_color_FFFFFF_t_70 5]: /images/20221005/35056c8cf4c0487880ca3850b17ac8e0.png