字節(jié)跳動(dòng) Golang 微服務(wù)框架 Hertz 集成 Session
今天我們將探討如何在字節(jié)跳動(dòng)的 Golang 微服務(wù)框架 Hertz 中集成 session 功能。
通過(guò)實(shí)踐，我們會(huì)逐步了解如何在項(xiàng)目中完成從環(huán)境搭建到接口調(diào)試的流程。
一、Hertz 項(xiàng)目目錄結(jié)構(gòu)
以下是 Hertz 項(xiàng)目的基本目錄結(jié)構(gòu)，展示了如何集成 session：
├── Makefile # 定義項(xiàng)目的自動(dòng)化任務(wù)腳本
├── README.md
├── biz
│ ├── dal
│ │ ├── init.go
│ │ └── mysql
│ │ ├── init.go # 連接信息
│ │ └── user.go # 包含對(duì)用戶(hù)數(shù)據(jù)在 MySQL 中的操作
│ ├── handler
│ │ ├── ping.go
│ │ └── user
│ │ └── user_service.go
│ ├── model
│ │ └── user
│ │ └── user.go
│ ├── mw
│ │ ├── csrf.go # 跨域
│ │ └── session.go
│ └── router
│ ├── register.go
│ └── user
│ ├── middleware.go
│ └── user.go
├── docker-compose.yml # 定義和運(yùn)行多個(gè) Docker 容器的配置文件
├── go.mod
├── go.sum
├── idl
│ └── user.thrift
├── images
│ ├── index-page.png
│ ├── login-page.png
│ └── register-page.png
├── main.go
├── pkg
│ ├── consts
│ │ └── consts.go
│ ├── render
│ │ └── render.go
│ └── utils
│ └── utils.go
├── router.go
├── router_gen.go二、運(yùn)行項(xiàng)目
Step 1：?jiǎn)?dòng) MySQL 容器
首先，使用 Docker 啟動(dòng) MySQL 容器：
cd bizdemo/hertz_session && docker-compose up運(yùn)行后，您會(huì)看到如下輸出：
docker運(yùn)行mysql
Step 2：編譯并運(yùn)行項(xiàng)目
在終端運(yùn)行以下命令來(lái)啟動(dòng)項(xiàng)目：
cd bizdemo/hertz_session && go run main.go看到以下日志就說(shuō)明啟動(dòng)成功了：
2024/11/12 23:51:05.802956 engine.go:396: [Info] HERTZ: Using network library=netpoll
2024/11/12 23:51:05.807942 transport.go:115: [Info] HERTZ: HTTP server listening on address=[::]:8888
項(xiàng)目啟動(dòng)
三、API 接口調(diào)試
1. /register 用戶(hù)注冊(cè)接口
請(qǐng)求 URL: http://localhost:8888/register.html
請(qǐng)求參數(shù)：
{
"username": "hertz_session",
"email": "1122@qq.com",
"password": "password"
}響應(yīng)結(jié)果：
圖片
注冊(cè)成功后，在數(shù)據(jù)庫(kù)中可以看到新用戶(hù)記錄：
數(shù)據(jù)庫(kù)查詢(xún)
2. /login 用戶(hù)登錄接口
請(qǐng)求 URL: http://localhost:8888/login.html
輸入用戶(hù)名和密碼，成功后返回登錄結(jié)果：
登錄成功
3. /ping 接口
請(qǐng)求 URL: http://localhost:8888/ping
響應(yīng)結(jié)果：
{
"message": "pong"
}
接口響應(yīng)
四、代碼解析
4.1 根據(jù) user.thrift 生成接口代碼
以下是定義的 UserService 服務(wù)接口代碼：
namespace go user
struct BaseResp {
1: i64 code
2: string message
}
struct RegisterRequest {
1: string username (api.form="username", api.vd="(len($) > 0 && len($) < 128); msg:'Illegal format'")
2: string password (api.form="password", api.vd="(len($) > 0 && len($) < 128); msg:'Illegal format'")
3: string email (api.form="email", api.vd="(len($) > 0 && len($) < 128) && email($); msg:'Illegal format'")
}
struct RegisterResponse {
1: BaseResp baseresp
}
service UserService {
RegisterResponse register(1: RegisterRequest req) (api.post="/register")
LoginResponse login(1: LoginRequest req) (api.post="/login")
}4.2 實(shí)現(xiàn)用戶(hù)注冊(cè)接口
在 router.go 中配置路由：
func Register(r *server.Hertz) {
root := r.Group("/", rootMw()...)
root.POST("/login", append(_loginMw(), user.Login)...)
root.POST("/register", append(_registerMw(), user.Register)...)
}在 user_service.go 中實(shí)現(xiàn) Register 處理函數(shù)：
func Register(ctx context.Context, c *app.RequestContext) {
// 接收注冊(cè)參數(shù)并驗(yàn)證
var registerStruct struct {
Username string `form:"username" json:"username"`
Email string `form:"email" json:"email"`
Password string `form:"password" json:"password"`
}
// 綁定參數(shù)并驗(yàn)證
if err := c.BindAndValidate(?isterStruct); err != nil {
c.JSON(http.StatusOK, utils.H{"message": err.Error(), "code": http.StatusBadRequest})
return
}
// 檢查用戶(hù)名和郵箱是否存在
users, err := mysql.FindUserByNameOrEmail(registerStruct.Username, registerStruct.Email)
if err != nil || len(users) != 0 {
c.JSON(http.StatusOK, utils.H{"message": "user already exists", "code": http.StatusBadRequest})
return
}
// 創(chuàng)建用戶(hù)
err = mysql.CreateUsers([]*model.User{{
UserName: registerStruct.Username,
Email: registerStruct.Email,
Password: utils.MD5(registerStruct.Password),
}})
if err != nil {
c.JSON(http.StatusOK, utils.H{"message": err.Error(), "code": http.StatusBadRequest})
return
}
c.JSON(http.StatusOK, utils.H{"message": "success", "code": http.StatusOK})
}4.3 登錄實(shí)現(xiàn)
在 user_service.go 中實(shí)現(xiàn) Login 函數(shù)：
func Login(_ context.Context, c *app.RequestContext) {
var req user.LoginRequest
if err := c.BindAndValidate(&req); err != nil {
c.HTML(http.StatusOK, "login.html", hutils.H{"message": err.Error()})
return
}
users, err := mysql.CheckUser(req.Username, utils.MD5(req.Password))
if err != nil || len(users) == 0 {
c.HTML(http.StatusOK, "login.html", hutils.H{"message": consts.LoginErr})
return
}
session := sessions.Default(c)
session.Set(consts.Username, req.Username)
_ = session.Save()
c.Redirect(http.StatusMovedPermanently, []byte("/index.html"))
}總結(jié)：
通過(guò)詳細(xì)的代碼示例，逐步實(shí)現(xiàn)了基于 Hertz 框架的用戶(hù)會(huì)話(huà)管理功能。我們配置了目錄結(jié)構(gòu)、引入了數(shù)據(jù)庫(kù)存儲(chǔ)用戶(hù)數(shù)據(jù)，并提供了注冊(cè)和登錄接口，演示了完整的會(huì)話(huà)創(chuàng)建與管理流程。
通過(guò) session 實(shí)現(xiàn)的用戶(hù)認(rèn)證邏輯，確保了登錄用戶(hù)的持續(xù)訪(fǎng)問(wèn)控制，提升了項(xiàng)目的安全性和用戶(hù)體驗(yàn)。這一套流程幫助開(kāi)發(fā)者更深入理解 Hertz 框架在實(shí)際場(chǎng)景中的應(yīng)用。
