Golang Web会话管理库jeff使用指南

jeff是一个简单、灵活且安全的Golang Web会话管理库，它提供了轻量级的会话管理功能，适合各种规模的Web应用。

安装jeff

go get github.com/abraithwaite/jeff

基本使用

初始化jeff会话管理器

package main

import (
	"net/http"
	
	"github.com/abraithwaite/jeff"
)

func main() {
	// 创建jeff会话管理器
	session := jeff.New(
		jeff.Insecure, // 开发环境使用Insecure，生产环境应使用Secure
		jeff.RotateKeys("my-secret-key"), // 设置密钥
	)
	
	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		// 获取或创建会话
		sess, err := session.Get(r, "my-session")
		if err != nil {
			http.Error(w, err.Error(), http.StatusInternalServerError)
			return
		}
		
		// 设置会话值
		sess.Set("username", "john_doe")
		
		// 保存会话
		if err := session.Save(w, sess); err != nil {
			http.Error(w, err.Error(), http.StatusInternalServerError)
			return
		}
		
		w.Write([]byte("Session created!"))
	})
	
	http.ListenAndServe(":8080", nil)
}

核心功能

1. 设置和获取会话值

// 设置会话值
sess.Set("user_id", 123)
sess.Set("is_admin", true)

// 获取会话值
userID := sess.Get("user_id").(int) // 类型断言
isAdmin := sess.Get("is_admin").(bool)

// 检查值是否存在
if val, ok := sess.GetOk("user_id"); ok {
	// 值存在
}

2. 删除会话值

// 删除单个值
sess.Delete("user_id")

// 清除所有会话值
sess.Clear()

3. 会话过期设置

// 创建带过期时间的会话管理器
session := jeff.New(
	jeff.Secure, // 生产环境使用Secure
	jeff.RotateKeys("my-secret-key"),
	jeff.WithExpiry(24 * time.Hour), // 设置24小时过期
)

4. 自定义存储后端

jeff默认使用内存存储，但可以自定义存储后端：

// 使用Redis存储
import "github.com/abraithwaite/jeff/redis"

func main() {
	client := redis.NewClient(&redis.Options{
		Addr: "localhost:6379",
	})
	
	store := redis.New(client)
	
	session := jeff.New(
		jeff.Secure,
		jeff.RotateKeys("my-secret-key"),
		jeff.WithStore(store),
	)
}

安全最佳实践

1. 生产环境使用Secure模式：

   session := jeff.New(jeff.Secure, ...)
   

2. 定期轮换密钥：

   session := jeff.New(
       jeff.Secure,
       jeff.RotateKeys("current-secret", "previous-secret"),
   )
   

3. 设置合理的过期时间：

   session := jeff.New(
       jeff.Secure,
       jeff.WithExpiry(2 * time.Hour), // 2小时过期
   )
   

4. 使用HTTP-only和Secure cookies：

   session := jeff.New(
       jeff.Secure,
       jeff.WithHTTPOnly(true),
       jeff.WithSecure(true),
   )
   

完整示例

package main

import (
	"fmt"
	"net/http"
	"time"
	
	"github.com/abraithwaite/jeff"
)

func main() {
	// 初始化会话管理器
	session := jeff.New(
		jeff.Secure,
		jeff.RotateKeys("my-secret-key-1", "my-secret-key-2"),
		jeff.WithExpiry(2 * time.Hour),
		jeff.WithHTTPOnly(true),
		jeff.WithSecure(true),
	)
	
	// 登录处理器
	http.HandleFunc("/login", func(w http.ResponseWriter, r *http.Request) {
		sess, _ := session.Get(r, "user-session")
		
		// 模拟用户认证
		username := r.FormValue("username")
		password := r.FormValue("password")
		
		if username == "admin" && password == "password" {
			sess.Set("authenticated", true)
			sess.Set("username", username)
			sess.Set("login_time", time.Now())
			
			if err := session.Save(w, sess); err != nil {
				http.Error(w, err.Error(), http.StatusInternalServerError)
				return
			}
			
			fmt.Fprintf(w, "Login successful! Welcome %s", username)
		} else {
			http.Error(w, "Invalid credentials", http.StatusUnauthorized)
		}
	})
	
	// 主页处理器
	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		sess, _ := session.Get(r, "user-session")
		
		if auth, ok := sess.GetOk("authenticated"); ok && auth.(bool) {
			username := sess.Get("username").(string)
			loginTime := sess.Get("login_time").(time.Time)
			
			fmt.Fprintf(w, "Welcome back %s! You logged in at %s", 
				username, loginTime.Format(time.RFC1123))
		} else {
			http.Redirect(w, r, "/login", http.StatusSeeOther)
		}
	})
	
	// 登出处理器
	http.HandleFunc("/logout", func(w http.ResponseWriter, r *http.Request) {
		sess, _ := session.Get(r, "user-session")
		sess.Clear()
		
		if err := session.Save(w, sess); err != nil {
			http.Error(w, err.Error(), http.StatusInternalServerError)
			return
		}
		
		fmt.Fprint(w, "Logged out successfully")
	})
	
	http.ListenAndServe(":8080", nil)
}

jeff是一个轻量级但功能强大的会话管理库，适合需要简单会话管理的Golang Web应用。它的设计哲学是保持简单和安全，避免过度复杂的功能，同时提供足够的灵活性来满足大多数Web应用的需求。