一,安装用到的库:
1,库的地址:
GitHub - gin-contrib/sessions: Gin middleware for session management
2,从命令行安装:
liuhongdi@ku:~$ go get -u github.com/gin-contrib/sessions
说明:刘宏缔的go森林是一个专注golang的博客,
网站:https://blog.imgtouch.com
原文: go语言web开发系列之二十九:gin框架用gin-contrib/sessions库管理session(基于cookie) – 架构森林
说明:作者:刘宏缔 邮箱: 371125307@qq.com
二,演示项目的相关信息
1,地址:
GitHub - liuhongdi/digv29: gin框架用gin-contrib/sessions库管理session(基于cookie)
2,功能说明:演示了在gin框架下对session的访问
3,项目结构:如图:
三,go代码说明
1,router/router.go
package router
import (
// 导入session包
"github.com/gin-contrib/sessions"
// 导入session存储引擎
"github.com/gin-contrib/sessions/cookie"
"github.com/gin-gonic/gin"
"github.com/liuhongdi/digv29/controller"
"github.com/liuhongdi/digv29/global"
"log"
"net/http"
"runtime/debug"
)
func Router() *gin.Engine {
router := gin.Default()
//处理异常
router.NoRoute(HandleNotFound)
router.NoMethod(HandleNotFound)
//use middleware
router.Use(Recover)
// 基于cookie创建session的存储引擎,传递一个参数,用来做加密时的密钥
store := cookie.NewStore([]byte("secret1234"))
//session中间件生效,参数mysession,是浏览器端cookie的名字
router.Use(sessions.Sessions("mysession", store))
//static
router.StaticFS("/static", http.Dir("/data/liuhongdi/digv29/static"))
// 路径映射:index
userc:=controller.NewUserController()
router.POST("/user/login", userc.Login);
router.GET("/user/session", userc.Session);
router.GET("/user/logout", userc.Logout);
return router
}
func HandleNotFound(c *gin.Context) {
global.NewResult(c).Error(404,"资源未找到")
return
}
func Recover(c *gin.Context) {
defer func() {
if r := recover(); r != nil {
//打印错误堆栈信息
log.Printf("panic: %v\n", r)
debug.PrintStack()
global.NewResult(c).Error(500,"服务器内部错误")
}
}()
//加载完 defer recover,继续后续接口调用
c.Next()
}
2,controller/userController.go
package controller
import (
"github.com/gin-contrib/sessions"
"github.com/gin-gonic/gin"
"github.com/liuhongdi/digv29/global"
)
type UserController struct{}
func NewUserController() UserController {
return UserController{}
}
//登录
func (g *UserController) Login(c *gin.Context) {
username := c.PostForm("username")
password := c.PostForm("password")
result := global.NewResult(c)
if (username == "lhd" && password=="123") {
//set session
session := sessions.Default(c)
session.Set("username", username)
session.Save()
result.Success("success");
} else {
result.Error(1,"用户名密码错误");
}
return
}
//读session
func (g *UserController) Session(c *gin.Context) {
//get session
session := sessions.Default(c)
username := session.Get("username")
result := global.NewResult(c)
result.Success(username);
return
}
//logout
func (g *UserController) Logout(c *gin.Context) {
//clear session
session := sessions.Default(c)
session.Clear()
session.Save()
result := global.NewResult(c)
result.Success("success");
return
}
3,global/result.go
package global
import (
"github.com/gin-gonic/gin"
"net/http"
)
type Result struct {
Ctx *gin.Context
}
type ResultCont struct {
Code int `json:"code"` // 自增
Msg string `json:"msg"` //
Data interface{} `json:"data"`
}
func NewResult(ctx *gin.Context) *Result {
return &Result{Ctx: ctx}
}
//返回成功
func (r *Result) Success(data interface{}) {
if (data == nil) {
data = gin.H{}
}
res := ResultCont{}
res.Code = 0
res.Msg = ""
res.Data = data
r.Ctx.JSON(http.StatusOK,res)
}
//返回失败
func (r *Result)Error(code int,msg string) {
res := ResultCont{}
res.Code = code
res.Msg = msg
res.Data = gin.H{}
r.Ctx.JSON(http.StatusOK,res)
r.Ctx.Abort()
}
4,static/login.html
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title >标题</title>
<meta charset="utf-8" />
<script type="text/javascript" language="JavaScript" src="jquery-1.6.2.min.js"></script>
</head>
<body>
<div id="content" style="width:800px;">
<div style="width:250px;float:left;font-size: 16px;" ></div>
<div style="width:550px;float:left;">
<!--====================main begin=====================-->
<input type="text" id="username" placeholder="请输入用户名" /><br/><br/>
<input type="password" id="password" placeholder="请输入密码" /><br/><br/>
<input type="button" value="登录" onclick="goLogin()"/>
<!--====================main end=====================-->
</div>
</div>
<script>
//访问8080:/home/home
function goLogin(){
var postdata = {
username:document.getElementById("username").value,
password:document.getElementById("password").value,
}
$.ajax({
type:"POST",
url:"http://127.0.0.1:8080/user/login",
data:postdata,
//返回数据的格式
datatype: "json",//"xml", "html", "script", "json", "jsonp", "text".
//成功返回之后调用的函数
success:function(data){
//alert(data);
if (data.code == 0){
alert("访问成功");
} else {
alert("出错:"+data.msg);
}
},
//调用执行后调用的函数
complete: function(XMLHttpRequest, textStatus){
},
//调用出错执行的函数
error:function(jqXHR,textStatus,errorThrown){
console.log(jqXHR);
console.log(textStatus);
console.log(errorThrown);
}
});
}
</script>
</body>
</html>
四,测试效果
1,登录:访问:
http://127.0.0.1:8080/static/login.html
在下面的页面输入lhd/123后点登录:
可以看到登录成功后,session在cookie端写入了一个id
2,读取session内容:
访问:
http://127.0.0.1:8080/user/session
返回:
3,退出登录:
访问:
http://127.0.0.1:8080/user/logout
返回:
再次查看/usr/session页面:
用户的session已经被清除
五,查看库的版本:
module github.com/liuhongdi/digv29
go 1.15
require (
github.com/gin-gonic/gin v1.6.3
github.com/gin-contrib/sessions v0.0.3
)