feat 包命名规范

This commit is contained in:
2026-02-11 14:49:44 +08:00
parent fc9b32b115
commit 14cb2f3270
22 changed files with 137 additions and 135 deletions

View File

@@ -0,0 +1,155 @@
package httphandler
import (
"git.hlsq.asia/mmorpg/service-common/db/redis"
"git.hlsq.asia/mmorpg/service-common/log"
"git.hlsq.asia/mmorpg/service-common/net/grpc/grpcclient"
"git.hlsq.asia/mmorpg/service-common/net/http/httpresp"
"git.hlsq.asia/mmorpg/service-common/proto/rs/rspb"
"git.hlsq.asia/mmorpg/service-common/utils"
"git.hlsq.asia/mmorpg/service-gateway/internal/global"
"github.com/gin-gonic/gin"
)
// 这个模块处理用户登录
type LoginReq struct {
Phone string `json:"phone"` // 手机号
Code string `json:"code"` // 验证码
WxMiniCode string `json:"wxMiniCode"` // 微信小程序登录
}
type LoginResp struct {
USN int64 `json:"usn"`
Name string `json:"name"`
AccessToken string `json:"accessToken"`
RefreshToken string `json:"refreshToken"`
}
func Login(c *gin.Context) {
req := &LoginReq{}
if err := c.ShouldBindJSON(req); err != nil {
httpresp.JsonBadRequest(c)
return
}
client, err := grpcclient.UserNewClientLB()
if err != nil {
log.Errorf("Login UserNewClientLB error: %v", err)
httpresp.JsonOK(c, httpresp.Error(httpresp.Failed))
return
}
usn, name := int64(0), ""
if req.Phone != "" {
// TODO 校验验证码
login, err := client.PhoneLogin(c, &rspb.PhoneLoginReq{
Phone: req.Phone,
Code: req.Code,
})
if err != nil {
log.Errorf("Login PhoneLogin error: %v", err)
httpresp.JsonOK(c, httpresp.Error(httpresp.Failed))
return
}
usn, name = login.USN, login.Name
} else if req.WxMiniCode != "" {
login, err := client.WxMiniLogin(c, &rspb.WxMiniLoginReq{
Code: req.WxMiniCode,
})
if err != nil {
log.Errorf("Login WxMiniLogin error: %v", err)
httpresp.JsonOK(c, httpresp.Error(httpresp.Failed))
return
}
usn, name = login.USN, login.Name
} else {
httpresp.JsonBadRequest(c)
return
}
at, rt, err := sessionLogin(c, usn)
if err != nil {
log.Errorf("Login sessionLogin error: %v, usn: %v", err, usn)
httpresp.JsonOK(c, httpresp.Error(httpresp.Failed))
return
}
httpresp.JsonOK(c, httpresp.Success(&LoginResp{
USN: usn,
Name: name,
AccessToken: at,
RefreshToken: rt,
}))
}
type RefreshTokenReq struct {
RefreshToken string `json:"refreshToken"`
}
type RefreshTokenResp struct {
AccessToken string `json:"accessToken"`
RefreshToken string `json:"refreshToken"`
}
func RefreshToken(c *gin.Context) {
req := &RefreshTokenReq{}
if err := c.ShouldBindJSON(req); err != nil {
httpresp.JsonBadRequest(c)
return
}
if req.RefreshToken == "" {
cookie, err := c.Cookie("refresh_token")
if err != nil {
httpresp.JsonUnauthorized(c)
return
}
req.RefreshToken = cookie
}
usn, _ := redis.GetClient().HGet(c, global.KeyGatewayRefreshToken+req.RefreshToken, (&utils.UserSession{}).GetUsnKey()).Int64()
if usn == 0 {
httpresp.JsonUnauthorized(c)
return
}
if err := sessionLogout(c, req.RefreshToken); err != nil {
log.Errorf("RefreshToken sessionLogout error: %v, usn: %v", err, usn)
}
at, rt, err := sessionLogin(c, usn)
if err != nil {
log.Errorf("RefreshToken sessionLogin error: %v, usn: %v", err, usn)
httpresp.JsonOK(c, httpresp.Error(httpresp.Failed))
return
}
httpresp.JsonOK(c, httpresp.Success(&RefreshTokenResp{
AccessToken: at,
RefreshToken: rt,
}))
}
type LogoutReq struct {
RefreshToken string `json:"refreshToken"`
}
type LogoutResp struct {
}
func Logout(c *gin.Context) {
req := &LogoutReq{}
if err := c.ShouldBindJSON(req); err != nil {
httpresp.JsonBadRequest(c)
return
}
if req.RefreshToken == "" {
cookie, err := c.Cookie("refresh_token")
if err != nil {
httpresp.JsonUnauthorized(c)
return
}
req.RefreshToken = cookie
}
if err := sessionLogout(c, req.RefreshToken); err != nil {
log.Errorf("Logout sessionLogout error: %v", err)
}
httpresp.JsonOK(c, httpresp.Success(&LogoutResp{}))
}

View File

@@ -0,0 +1,156 @@
package httphandler
import (
"bou.ke/monkey"
"fmt"
"git.hlsq.asia/mmorpg/service-common/net/grpc/grpcclient"
"git.hlsq.asia/mmorpg/service-common/net/http/httpresp"
"git.hlsq.asia/mmorpg/service-common/proto/rs/rspb"
"git.hlsq.asia/mmorpg/service-common/proto/rs/rspb/mocks"
"git.hlsq.asia/mmorpg/service-common/utils"
"git.hlsq.asia/mmorpg/service-gateway/internal/testutil"
"github.com/gin-gonic/gin"
"github.com/golang/mock/gomock"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
"net/http"
"testing"
)
type LoginTestSuite struct {
testutil.TestSuite
}
func (ts *LoginTestSuite) TestLogin() {
gin.SetMode(gin.TestMode)
ts.Run("ShouldBindJSON Failed", func() {
w, c := utils.CreateTestContext("POST", "/", &LoginReq{
Phone: "",
Code: "",
})
Login(c)
utils.AssertResponse(&ts.Suite, w, http.StatusBadRequest, httpresp.ParamError)
})
ts.Run("UserNewClientLB Failed", func() {
monkey.Patch(grpcclient.UserNewClientLB, func() (rspb.UserClient, error) {
return nil, assert.AnError
})
defer monkey.Unpatch(grpcclient.UserNewClientLB)
w, c := utils.CreateTestContext("POST", "/", &LoginReq{
Phone: "13800000000",
Code: "1234",
})
Login(c)
utils.AssertResponse(&ts.Suite, w, http.StatusOK, httpresp.Failed)
})
ts.Run("Login Failed", func() {
ctrl := gomock.NewController(ts.T())
defer ctrl.Finish()
client := mocks.NewMockUserClient(ctrl)
client.EXPECT().
PhoneLogin(gomock.Any(), gomock.Any()).
Return(nil, fmt.Errorf("gRPC failed"))
monkey.Patch(grpcclient.UserNewClientLB, func() (rspb.UserClient, error) {
return client, nil
})
defer monkey.Unpatch(grpcclient.UserNewClientLB)
w, c := utils.CreateTestContext("POST", "/", &LoginReq{
Phone: "13800000000",
Code: "1234",
})
Login(c)
utils.AssertResponse(&ts.Suite, w, http.StatusOK, httpresp.Failed)
})
ts.Run("OK", func() {
ctrl := gomock.NewController(ts.T())
defer ctrl.Finish()
client := mocks.NewMockUserClient(ctrl)
client.EXPECT().
PhoneLogin(gomock.Any(), gomock.Any()).
Return(&rspb.PhoneLoginResp{USN: 1, Name: "hh"}, nil)
monkey.Patch(grpcclient.UserNewClientLB, func() (rspb.UserClient, error) {
return client, nil
})
defer monkey.Unpatch(grpcclient.UserNewClientLB)
w, c := utils.CreateTestContext("POST", "/", &LoginReq{
Phone: "13800000000",
Code: "1234",
})
Login(c)
utils.AssertResponse(&ts.Suite, w, http.StatusOK, httpresp.OK)
})
}
func (ts *LoginTestSuite) TestRefreshToken() {
gin.SetMode(gin.TestMode)
ts.Run("ShouldBindJSON Failed", func() {
w, c := utils.CreateTestContext("POST", "/", &RefreshTokenReq{
RefreshToken: "",
})
RefreshToken(c)
utils.AssertResponse(&ts.Suite, w, http.StatusBadRequest, httpresp.ParamError)
})
ts.Run("ParseToken Failed", func() {
monkey.Patch(utils.ParseToken, func(tokenString string, secret string) (*utils.Claims, error) {
return nil, assert.AnError
})
defer monkey.Unpatch(utils.ParseToken)
w, c := utils.CreateTestContext("POST", "/", &RefreshTokenReq{
RefreshToken: "abc",
})
RefreshToken(c)
utils.AssertResponse(&ts.Suite, w, http.StatusOK, httpresp.TokenInvalid)
})
//ts.Run("Redis Get Failed", func() {
// monkey.Patch(utils.ParseToken, func(tokenString string, secret string) (*utils.Claims, error) {
// if tokenString == "abc" {
// return &utils.Claims{USN: 1}, nil
// }
// return nil, assert.AnError
// })
// defer monkey.Unpatch(utils.ParseToken)
//
// redis.GetClient().Set(context.Background(), global.KeyGatewayRefreshToken+1, "ab", redis2.KeepTTL)
//
// w, c := utils.CreateTestContext("POST", "/", &RefreshTokenReq{
// RefreshToken: "abc",
// })
// RefreshToken(c)
// utils.AssertResponse(&ts.Suite, w, http.StatusOK, http_resp.TokenInvalid)
//})
//
//ts.Run("OK", func() {
// monkey.Patch(utils.ParseToken, func(tokenString string, secret string) (*utils.Claims, error) {
// if tokenString == "abc" {
// return &utils.Claims{USN: 1}, nil
// }
// return nil, assert.AnError
// })
// defer monkey.Unpatch(utils.ParseToken)
//
// redis.GetClient().Set(context.Background(), fmt.Sprintf(global.KeyGatewayRefreshToken, 1), "abc", redis2.KeepTTL)
//
// w, c := utils.CreateTestContext("POST", "/", &RefreshTokenReq{
// RefreshToken: "abc",
// })
// RefreshToken(c)
// utils.AssertResponse(&ts.Suite, w, http.StatusOK, http_resp.OK)
//})
}
func TestLoginTestSuite(t *testing.T) {
suite.Run(t, &LoginTestSuite{})
}

View File

@@ -0,0 +1,108 @@
package httphandler
import (
"git.hlsq.asia/mmorpg/service-common/db/redis"
"git.hlsq.asia/mmorpg/service-common/utils"
"git.hlsq.asia/mmorpg/service-gateway/config"
"git.hlsq.asia/mmorpg/service-gateway/internal/global"
"github.com/gin-gonic/gin"
"github.com/google/uuid"
)
var (
scriptLoginSha1 string
scriptLogin = `
local at_key = KEYS[1] .. ARGV[1]
local rt_key = KEYS[2] .. ARGV[2]
local session_key = KEYS[3] .. ARGV[3]
redis.call("HSET", at_key,
"usn", ARGV[3],
"ip", ARGV[6],
"ua", ARGV[7],
"rt", ARGV[2]
)
redis.call("EXPIRE", at_key, tonumber(ARGV[4]))
redis.call("HSET", rt_key,
"usn", ARGV[3],
"ip", ARGV[6],
"ua", ARGV[7],
"at", ARGV[1]
)
redis.call("EXPIRE", rt_key, tonumber(ARGV[5]))
local all_rts = redis.call("SMEMBERS", session_key)
-- 只允许最大10个会话,多了的随机踢掉
if #all_rts >= 10 then
local rk = KEYS[2] .. all_rts[1]
local ak = KEYS[1] .. redis.call("HGET", rk, "at")
redis.call("DEL", rk)
redis.call("DEL", ak)
end
-- 清理已经失效的会话
for i, rt in ipairs(all_rts) do
if redis.call("EXISTS", KEYS[2] .. rt) == 0 then
redis.call("SREM", session_key, rt)
end
end
redis.call("SADD", session_key, ARGV[2])
redis.call("EXPIRE", session_key, tonumber(ARGV[5]) + 600)
return 1
`
)
func sessionLogin(c *gin.Context, usn int64) (string, string, error) {
if scriptLoginSha1 == "" {
scriptLoginSha1 = redis.GetClient().ScriptLoad(c, scriptLogin).Val()
}
at := uuid.New().String()
rt := uuid.New().String()
err := redis.GetClient().EvalSha(
c, scriptLoginSha1,
[]string{global.KeyGatewayAccessToken, global.KeyGatewayRefreshToken, global.KeyGatewaySession},
at,
rt,
usn,
config.Get().Auth.ShortExpire,
config.Get().Auth.LongExpire,
c.RemoteIP(),
c.GetHeader("User-Agent"),
).Err()
if err != nil {
return "", "", utils.ErrorsWrap(err)
}
c.SetCookie("refresh_token", rt, int(config.Get().Auth.LongExpire), "/", ".hlsq.asia", true, true)
return at, rt, nil
}
var (
scriptLogoutSha1 string
scriptLogout = `
local rt_key = KEYS[2] .. ARGV[1]
local usn = redis.call("HGET", rt_key, "usn")
local at = redis.call("HGET", rt_key, "at")
local at_key = KEYS[1] .. at
local session_key = KEYS[3] .. usn
redis.call("DEL", at_key)
redis.call("DEL", rt_key)
redis.call("SREM", session_key, ARGV[1])
return 1
`
)
func sessionLogout(c *gin.Context, rt string) error {
if scriptLogoutSha1 == "" {
scriptLogoutSha1 = redis.GetClient().ScriptLoad(c, scriptLogout).Val()
}
return redis.GetClient().EvalSha(
c, scriptLogoutSha1,
[]string{global.KeyGatewayAccessToken, global.KeyGatewayRefreshToken, global.KeyGatewaySession},
rt,
).Err()
}