Go gorilla/sessions库安装使用的方法(go,gorilla,sessions,开发技术)

这篇“Gogorilla/sessions库安装使用的方法”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看这篇“Gogorilla/sessions库安装使用的方法”文章吧。

简介

gorilla/sessions是 gorilla web 开发工具包中管理 session 的库。它提供了基于 cookie 和本地文件系统的 session。同时预留扩展接口，可以使用其它的后端存储 session 数据。

本文先介绍sessions提供的两种 session 存储方式，然后通过第三方扩展介绍在多个 Web 服务器实例间如何保持登录状态。

快速使用

本文代码使用 Go Modules。

创建目录并初始化：

$mkdirgorilla/sessions&&cdgorilla/sessions$gomodinitgithub.com/darjun/go-daily-lib/gorilla/sessions

安装gorilla/sessions库：

$goget-ugithub.com/valyala/gorilla/sessions

现在我们实现在服务器端通过 session 存储一些信息的功能：

packagemainimport("fmt""github.com/gorilla/mux""github.com/gorilla/sessions""log""net/http""os")var(store=sessions.NewFilesystemStore("./",securecookie.GenerateRandomKey(32),securecookie.GenerateRandomKey(32)))funcset(whttp.ResponseWriter,r*http.Request){session,_:=store.Get(r,"user")session.Values["name"]="dj"session.Values["age"]=18err:=sessions.Save(r,w)iferr!=nil{http.Error(w,err.Error(),http.StatusInternalServerError)return}fmt.Fprintln(w,"HelloWorld")}funcread(whttp.ResponseWriter,r*http.Request){session,_:=store.Get(r,"user")fmt.Fprintf(w,"name:%sage:%d\n",session.Values["name"],session.Values["age"])}funcmain(){r:=mux.NewRouter()r.HandleFunc("/set",set)r.HandleFunc("/read",read)log.Fatal(http.ListenAndServe(":8080",r))}

整个程序逻辑比较清晰，分别在/set和/read路径下挂上设置和读取的处理函数。重点是变量store。我们调用session.NewFilesystemStore()方法创建了一个*sessions.FilesystemStore类型的对象，它会将我们的 session 内容存储到文件系统（即本地磁盘上）。我们需要给NewFilesytemStore()方法传入至少 2 个参数，第一个参数指定 session 存储的本地磁盘路径。后续参数依次指定hashKey和blockKey（可省略），前者用于验证，后者用于加密，我们可以使用securecookie生成足够随机的 key，详情见前一篇介绍securecookie的文章。

sessions为所有的 session 存储抽象了一个接口Store：

typeStoreinterface{Get(r*http.Request,namestring)(*Session,error)New(r*http.Request,namestring)(*Session,error)Save(r*http.Request,whttp.ResponseWriter,s*Session)error}

实现这个接口可以自定义我们存储 session 的位置和格式。

在set处理函数中，我们调用store.Get(r, "user")获取名为user的 session，如果 session 不存在，则创建一个新的。sessions库支持为同一个用户创建多个 session，store.Get()方法的第二个参数指定名字。获取到的*Session结构如下：

typeSessionstruct{IDstringValuesmap[interface{}]interface{}Options*OptionsIsNewboolstoreStorenamestring}

数据直接存放在Session.Values字段中，这是一个类型为map[interface{}]interface{}的字段，几乎能保存任何类型的数据（之所以我这里要说几乎，因为还要考虑序列化到存储的限制，有些数据类型无法序列化为字节流保存，如chan）。

在set处理函数中，我们直接操作Values字段，最后我们调用store.Save(r, w, session)将 session数据保存到对应的存储中。

在get处理函数中，同样地我们先调用store.Get(r, "user")获取*Session对象，然后读取里面的name和age值。

运行：

$gorunmain.go

首先访问localhost:8080/set，通过浏览器的开发者工具Application页签查看 cookie：

我们发现 session 的名字会作为 cookie 名发送到客户端，session ID 被保存为 cookie 的值。

然后我们访问localhost:8080/read，读取到 session 保存的数据：

另前面说过FilesystemStore数据是存储在本地硬盘上的，在运行程序的本地目录我们看到有以 session 开头的文件，文件名 session 后面的部分就是 session ID：

cookie 存储

除了默认的将本地文件系统作为存储外，sessions还支持将 cookie 作为存储，也就是将 session 的数据直接通过 cookie 在客户端和服务器之间传输。cookie 存储的创建方式与文件系统存储的创建方式类似：

varstore=sessions.NewCookieStore(securecookie.GenerateRandomKey(32),securecookie.GenerateRandomKey(32))

sessions.NewCookieStore()方法的第一个参数为 hashKey 用于验证，第二个参数为 blockKey 用于加密，与sessions.NewFilesystemStore()一样。

其他部分的代码完全不用修改，运行程序的结果与上面的一致。session 数据保存在 cookie 中，随每次请求由客户端传给服务器。这种方式其实就是之前文章中介绍的 cookie 用法。

记录登录状态

之前我们介绍gorilla/mux时介绍过使用 cookie 保存登录状态。当时将用户名和密码经过简单的 Base64 编码后就直接存放在 cookie 中了，基本处于“裸露”状态。只要有意，很容易就能窃取用户名和密码。现在我们将用户关键信息存储在 session 中，cookie 中只存储一个 session ID。

首先，我们设计 3 个页面，登录页面，主页面，授权才能访问的 secret 页面。登录页面只需要用户名&密码的输入框和登录按钮即可：

//login.tpl<formaction="/login"method="post"><label>Username:</label><inputname="username"><br><label>Password:</label><inputname="password"type="password"><br><buttontype="submit">登录</button></form>

登录请求根据方法不同需要执行不同的操作，GET 方法表示请求登录的页面，POST 方法表示执行登录操作。我们使用handlers.MethodHandler这个中间件来处理同一个路径的不同方法的请求：

r.Handle("/login",handlers.MethodHandler{"GET":http.HandlerFunc(Login),"POST":http.HandlerFunc(DoLogin),})

Login处理函数很简单，只是展示页面：

funcLogin(whttp.ResponseWriter,r*http.Request){ptTemplate.ExecuteTemplate(w,"login.tpl",nil)}

这里我使用 Go 标准库html/template模版库来加载和管理各个页面的模板：

var(ptTemplate*template.Template)funcinit(){template.Must(template.New("").ParseGlob("./tpls/*.tpl"))}

DoLogin处理函数，需要验证登录请求，然后创建User对象，保存在 session 中，接着重定向到主页面：

funcDoLogin(whttp.ResponseWriter,r*http.Request){r.ParseForm()username:=r.Form.Get("username")password:=r.Form.Get("password")ifusername!="darjun"||password!="handsome"{http.Redirect(w,r,"/login",http.StatusFound)return}SaveSessionUser(w,r,&User{Username:username})http.Redirect(w,r,"/",http.StatusFound)}

下面是主页面的处理，我们可以从 session 中取出保存的User对象，根据是否有User对象显示不同的页面：

//home.tpl{%if.%}<p>Hi,{%.Username%}</p><br><ahref="/secret"rel="externalnofollow">Gotosecret?</a>{%else%}<p>Hi,stranger</p><br><ahref="/login"rel="externalnofollow">Gotologin?</a>{%end%}

HomeHandler代码如下：

funcHomeHandler(whttp.ResponseWriter,r*http.Request){u:=GetSessionUser(r)ptTemplate.ExecuteTemplate(w,"home.tpl",u)}

最后是 secret 页面：

//secret.tpl<p>Loremipsumdolorsitametconsecteturadipisicingelit.Inventoreacumquesuntpariaturnihildoloremquetempore,consecteturipsumsapienteidexcepturienimvelit,quisnisiessedoloribusaliquid.Incidunt,dolore.</p><p>Youhavevisitedthispage{%.Count%}times.</p>

显示访问了该页面多少次。

SecretHandler如下：

funcSecretHandler(whttp.ResponseWriter,r*http.Request){u:=GetSessionUser(r)ifu==nil{http.Redirect(w,r,"/login",http.StatusFound)return}u.Count++SaveSessionUser(w,r,u)ptTemplate.ExecuteTemplate(w,"secret.tpl",u)}

如果没有 session，则重定向到登录页面。反之显示该页面。这里每次成功访问 secret 页面，都会增加计数器，保存在 session 中。

上面代码中需要注意一点，由于 session 内容的序列化使用了标准库中的encoding/gob，所以不支持直接序列化结构体，我封装了两个函数，将User对象序列化为 JSON，然后保存到 session 中和从 session 中取出字符串反序列化为User对象：

funcGetSessionUser(r*http.Request)*User{session,_:=store.Get(r,"user")s,ok:=session.Values["user"]if!ok{returnnil}u:=&User{}json.Unmarshal([]byte(s.(string)),u)returnu}funcSaveSessionUser(whttp.ResponseWriter,r*http.Request,u*User){session,_:=store.Get(r,"user")data,_:=json.Marshal(u)session.Values["user"]=string(data)store.Save(r,w,session)}

现在运行我们的程序，首先访问localhost:8080，由于没有登录，显示欢迎陌生人，去登录：

点击去登录，跳转到登录界面，输入用户名和密码：

点击登录，跳转到主页，这时由于记录了登录状态，会显示欢迎 darjun：

点击去隐秘链接：

不停刷新页面，发现访问次数一直累加。

如果未登录时，直接访问localhost:8080/secret，会直接重定向到登录界面。

上面程序有一个缺点，程序重启启动后，就需要重新登录。因为每次启动我们都重新随机 hashKey 和 blockKey，只需要固定这两个值即可实现重启也能保存登录状态。

登录验证类的功能非常适合放在中间件中处理，之前的文章已经介绍过如何编写中间件了，这里就不赘述了。

第三方后端存储

将 session 存储在本地文件系统，不利于水平扩展。一般稍微上点规模的网站，Web 服务器都会部署很多个实例，请求通过 Nginx 之类的反向代理转发到一个后端实例处理。不能保证后面的请求与之前的请求在同一个实例中处理，故 session 一般需要存储在一个公共的地方，例如 redis。

sessions提供了扩展接口，方便扩展使用其他的后端存储 session 内容。目前 GitHub 上已经有很多的第三方后端扩展了，详细 list 见sessions库的 GitHub 首页：

我们只介绍基于 redis 的后端存储，其他的扩展感兴趣可自行研究。首先安装扩展：

$gogetgopkg.in/boj/redistore.v1

创建一个 redistore 的实例：

store,_=redistore.NewRediStore(10,"tcp",":6379","",[]byte("redis-key"))

参数依次为：

size：最大空闲连接数；

network：连接类型，一般是 TCP；

addr：网络地址+端口；

password：redis 的密码，如果未启用，填空；

keyPairs：依次是 hashKey 和 blockKey（可省略），不再赘述。

为了验证，我们开启多个服务器，所以将端口通过命令行参数传入，使用标准库flag：

port=flag.Int("port",8080,"porttolisten")funcinit(){flag.Parse()}funcmain(){//...log.Fatal(http.ListenAndServe(fmt.Sprintf(":%d",*port),nil))}

为了运行服务器，我们需要先开启一个 redis-server。redis 的安装就不多说了，在 windows 下，建议使用 chocolatey 安装，chocolatey 类似于 Ubutnu 的 apt-get，Mac 的 brew，非常方便，强烈推荐。

为了演示反向代理的效果，即通过一个地址可以随机访问部署的多个 Web 服务器，我们开启 3 个 Web 服务器。终端1：

$gobuild$./redis-port8080

终端2:

$./redis-port8081

终端3:

$./redis-port8082

可以使用nginx做反向代理，安装 nginx，配置：

upstreammysvr{serverlocalhost:8080;serverlocalhost:8081;serverlocalhost:8082;}server{listen80;server_namelocalhost;location/{proxy_passhttp://mysvr;}}

这里表示将localhost随机转发到mysvr这个组中的 3 个服务器上，启动 nginx：

$nginx-cnginx.conf

万事俱备，现在使用浏览器访问localhost，通过控制台日志发现是 server3 处理了这个请求：

点击去登录，server1 处理了展示页面的请求：

点击登录，server3 处理了 POST 类型的登录请求：

登录成功之后，重定向到主界面的请求又是 server1 处理的：

点击私密链接，展示页面的请求是 server2 处理的：

虽然每次处理的 server 不同，但是登录状态一直保存着。因为我们使用了 redis 保存 session。

注意，我这里每次都是随机一个 server 去处理，你运行的结果不一定一样。

以上就是关于“Gogorilla/sessions库安装使用的方法”这篇文章的内容，相信大家都有了一定的了解，希望小编分享的内容对大家有帮助，若想了解更多相关的知识内容，请关注亿速云行业资讯频道。