✨ add internationalization configuration

2024-08-10 14:08:24 +08:00
parent 6148fc74c6
commit 54f6256c00
7 changed files with 128 additions and 12 deletions
--- a/api/auth_api/auth_api.go
+++ b/api/auth_api/auth_api.go
@@ -1,6 +1,7 @@
 package auth_api

 import (
+	ginI18n "github.com/gin-contrib/i18n"
 	"github.com/gin-gonic/gin"
 	"reflect"
 	"schisandra-cloud-album/common/result"
@@ -31,7 +32,7 @@ func (AuthAPI) QueryUserByUsername(c *gin.Context) {
 	username := c.Query("username")
 	user := authService.QueryUserByUsername(username)
 	if reflect.DeepEqual(user, model.ScaAuthUser{}) {
-		result.FailWithMessage("用户不存在！", c)
+		result.FailWithMessage(ginI18n.MustGetMessage(c, "NotFoundUser"), c)
 		return
 	}
 	result.OkWithData(user, c)
@@ -47,7 +48,7 @@ func (AuthAPI) QueryUserByUuid(c *gin.Context) {
 	uuid := c.Query("uuid")
 	user := authService.QueryUserByUuid(uuid)
 	if reflect.DeepEqual(user, model.ScaAuthUser{}) {
-		result.FailWithMessage("用户不存在！", c)
+		result.FailWithMessage(ginI18n.MustGetMessage(c, "NotFoundUser"), c)
 		return
 	}
 	result.OkWithData(user, c)
@@ -63,10 +64,10 @@ func (AuthAPI) DeleteUser(c *gin.Context) {
 	uuid := c.Query("uuid")
 	err := authService.DeleteUser(uuid)
 	if err != nil {
-		result.FailWithMessage("用户删除失败！", c)
+		result.FailWithMessage(ginI18n.MustGetMessage(c, "DeletedFailed"), c)
 		return
 	}
-	result.OkWithMessage("用户删除成功！", c)
+	result.OkWithMessage(ginI18n.MustGetMessage(c, "DeletedSuccess"), c)
 }

 // QueryUserByPhone 根据手机号查询用户
@@ -79,7 +80,7 @@ func (AuthAPI) QueryUserByPhone(c *gin.Context) {
 	phone := c.Query("phone")
 	user := authService.QueryUserByPhone(phone)
 	if reflect.DeepEqual(user, model.ScaAuthUser{}) {
-		result.FailWithMessage("用户不存在！", c)
+		result.FailWithMessage(ginI18n.MustGetMessage(c, "NotFoundUser"), c)
 		return
 	}
 	result.OkWithData(user, c)
@@ -99,13 +100,13 @@ func (AuthAPI) AccountLogin(c *gin.Context) {
 	if isPhone {
 		user := authService.QueryUserByPhone(account)
 		if reflect.DeepEqual(user, model.ScaAuthUser{}) {
-			result.FailWithMessage("手机号未注册！", c)
+			result.FailWithMessage(ginI18n.MustGetMessage(c, "PhoneNotRegister"), c)
 		} else {
 			verify := utils.Verify(password, *user.Password)
 			if verify {
 				result.OkWithData(user, c)
 			} else {
-				result.FailWithMessage("密码错误！", c)
+				result.FailWithMessage(ginI18n.MustGetMessage(c, "PasswordError"), c)
 			}
 		}
 	}
@@ -113,13 +114,13 @@ func (AuthAPI) AccountLogin(c *gin.Context) {
 	if isEmail {
 		user := authService.QueryUserByEmail(account)
 		if reflect.DeepEqual(user, model.ScaAuthUser{}) {
-			result.FailWithMessage("邮箱未注册！", c)
+			result.FailWithMessage(ginI18n.MustGetMessage(c, "EmailNotRegister"), c)
 		} else {
 			verify := utils.Verify(password, *user.Password)
 			if verify {
 				result.OkWithData(user, c)
 			} else {
-				result.FailWithMessage("密码错误！", c)
+				result.FailWithMessage(ginI18n.MustGetMessage(c, "PasswordError"), c)
 			}
 		}
 	}
@@ -127,13 +128,13 @@ func (AuthAPI) AccountLogin(c *gin.Context) {
 	if isUsername {
 		user := authService.QueryUserByUsername(account)
 		if reflect.DeepEqual(user, model.ScaAuthUser{}) {
-			result.FailWithMessage("用户名未注册！", c)
+			result.FailWithMessage(ginI18n.MustGetMessage(c, "UsernameNotRegister"), c)
 		} else {
 			verify := utils.Verify(password, *user.Password)
 			if verify {
 				result.OkWithData(user, c)
 			} else {
-				result.FailWithMessage("密码错误！", c)
+				result.FailWithMessage(ginI18n.MustGetMessage(c, "PasswordError"), c)
 			}
 		}

--- a/go.mod
+++ b/go.mod
@@ -3,7 +3,9 @@ module schisandra-cloud-album
 go 1.22.5

 require (
+	github.com/BurntSushi/toml v1.3.2
 	github.com/gin-contrib/cors v1.7.2
+	github.com/gin-contrib/i18n v1.1.3
 	github.com/gin-gonic/gin v1.10.0
 	github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0
 	github.com/redis/go-redis/v9 v9.6.1
@@ -14,6 +16,7 @@ require (
 	github.com/wenlng/go-captcha-assets v1.0.1
 	github.com/wenlng/go-captcha/v2 v2.0.0
 	golang.org/x/crypto v0.25.0
+	golang.org/x/text v0.16.0
 	gopkg.in/yaml.v3 v3.0.1
 	gorm.io/driver/mysql v1.5.7
 	gorm.io/gen v0.3.26
@@ -50,6 +53,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/nicksnyder/go-i18n/v2 v2.4.0 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/ugorji/go/codec v1.2.12 // indirect
@@ -59,7 +63,6 @@ require (
 	golang.org/x/net v0.27.0 // indirect
 	golang.org/x/sync v0.7.0 // indirect
 	golang.org/x/sys v0.22.0 // indirect
-	golang.org/x/text v0.16.0 // indirect
 	golang.org/x/tools v0.23.0 // indirect
 	google.golang.org/protobuf v1.34.2 // indirect
 	gorm.io/datatypes v1.2.1 // indirect
--- a/go.sum
+++ b/go.sum
@@ -1,5 +1,7 @@
 filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
 filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
+github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
+github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc=
 github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE=
 github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
@@ -28,6 +30,8 @@ github.com/gin-contrib/cors v1.7.2 h1:oLDHxdg8W/XDoN/8zamqk/Drgt4oVZDvaV0YmvVICQ
 github.com/gin-contrib/cors v1.7.2/go.mod h1:SUJVARKgQ40dmrzgXEVxj2m7Ig1v1qIboQkPDTQ9t2E=
 github.com/gin-contrib/gzip v0.0.6 h1:NjcunTcGAj5CO1gn4N8jHOSIeRFHIbn51z6K+xaN4d4=
 github.com/gin-contrib/gzip v0.0.6/go.mod h1:QOJlmV2xmayAjkNS2Y8NQsMneuRShOU/kjovCXNuzzk=
+github.com/gin-contrib/i18n v1.1.3 h1:tDhLDqU58Qx0K6BcBr0JugzQtWD/uiy21B9vEb8UJGo=
+github.com/gin-contrib/i18n v1.1.3/go.mod h1:NKPag9OwNdiIeiBaaRUY9ILHbq9T19NPydIAwg6xyb8=
 github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE=
 github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI=
 github.com/gin-gonic/gin v1.10.0 h1:nTuyha1TYqgedzytsKYqna+DfLos46nTv2ygFy86HFU=
@@ -103,6 +107,8 @@ github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M=
 github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
+github.com/nicksnyder/go-i18n/v2 v2.4.0 h1:3IcvPOAvnCKwNm0TB0dLDTuawWEj+ax/RERNC+diLMM=
+github.com/nicksnyder/go-i18n/v2 v2.4.0/go.mod h1:nxYSZE9M0bf3Y70gPQjN9ha7XNHX7gMc814+6wVyEI4=
 github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM=
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
--- a/i18n/language/en.toml
+++ b/i18n/language/en.toml
@@ -0,0 +1,36 @@
+welcome = "hello"
+NotFoundUser = "User not found"
+DeletedSuccess = "deleted successfully!"
+DeletedFailed = "delete failed!"
+UpdatedSuccess = "updated successfully!"
+UpdatedFailed = "update failed!"
+CreatedSuccess = "created successfully!"
+CreatedFailed = "create failed!"
+LoginSuccess = "login successfully!"
+LoginFailed = "login failed!"
+LogoutSuccess = "logout successfully!"
+LogoutFailed = "logout failed!"
+RegisterSuccess = "register successfully!"
+RegisterFailed = "register failed!"
+PhoneNotRegister = "phone number not register!"
+EmailNotRegister = "email not register!"
+UsernameNotRegister = "username not register!"
+PasswordError = "password error!"
+EmailError = "email error!"
+PhoneError = "phone error!"
+UsernameError = "username error!"
+UsernameExists = "username already exists!"
+EmailExists = "email already exists!"
+PhoneExists = "phone number already exists!"
+PasswordNotSame = "password not same!"
+PasswordTooShort = "password length must be greater than 6!"
+PasswordTooLong = "password length must be less than 20!"
+CaptchaError = "captcha error!"
+CaptchaExpired = "captcha expired!"
+CaptchaNotMatch = "captcha not match!"
+CaptchaSendFailed = "captcha send failed!"
+CaptchaSendSuccess = "captcha send successfully!"
+CaptchaTooOften = "captcha too often!"
+CaptchaTooShort = "captcha length must be greater than 6!"
+CaptchaTooLong = "captcha length must be less than 20!"
+CaptchaSendLimit = "captcha send limit!"
--- a/i18n/language/zh.toml
+++ b/i18n/language/zh.toml
@@ -0,0 +1,36 @@
+welcome = "欢迎"
+NotFoundUser = "未找到用户!"
+DeletedSuccess = "删除成功!"
+DeletedFailed = "删除失败!"
+UpdatedSuccess = "更新成功!"
+UpdatedFailed = "更新失败!"
+CreatedSuccess = "创建成功!"
+CreatedFailed = "创建失败!"
+LoginSuccess = "登录成功!"
+LoginFailed = "登录失败!"
+LogoutSuccess = "登出成功!"
+LogoutFailed = "登出失败!"
+RegisterSuccess = "注册成功!"
+RegisterFailed = "注册失败!"
+PhoneNotRegister = "该手机号未注册!"
+EmailNotRegister = "该邮箱未注册!"
+UsernameNotRegister = "该用户名未注册!"
+PasswordError = "密码错误!"
+EmailError = "邮箱错误!"
+PhoneError = "手机号错误!"
+UsernameError = "用户名错误!"
+UsernameExists = "用户名已存在!"
+EmailExists = "邮箱已存在!"
+PhoneExists = "手机号已存在!"
+PasswordNotSame = "两次密码输入不一致!"
+PasswordTooShort = "密码长度不能少于6位!"
+PasswordTooLong = "密码长度不能多于20位!"
+CaptchaError = "验证码错误!"
+CaptchaExpired = "验证码已过期!"
+CaptchaNotMatch = "验证码不匹配!"
+CaptchaSendFailed = "验证码发送失败!"
+CaptchaSendSuccess = "验证码发送成功!"
+CaptchaTooOften = "验证码发送过于频繁!"
+CaptchaTooShort = "验证码长度不能少于6位!"
+CaptchaTooLong = "验证码长度不能多于20位!"
+CaptchaSendLimit = "验证码发送次数已达上限!"
--- a/middleware/i18n.go
+++ b/middleware/i18n.go
@@ -0,0 +1,29 @@
+package middleware
+
+import (
+	"github.com/BurntSushi/toml"
+	ginI18n "github.com/gin-contrib/i18n"
+	"github.com/gin-gonic/gin"
+	"golang.org/x/text/language"
+)
+
+func I18n() gin.HandlerFunc {
+	return ginI18n.Localize(
+		ginI18n.WithBundle(&ginI18n.BundleCfg{
+			RootPath:         "i18n/language/",
+			AcceptLanguage:   []language.Tag{language.Chinese, language.English},
+			DefaultLanguage:  language.Chinese,
+			UnmarshalFunc:    toml.Unmarshal,
+			FormatBundleFile: "toml",
+		}),
+		ginI18n.WithGetLngHandle(
+			func(context *gin.Context, defaultLng string) string {
+				lang := context.Query("lang")
+				if lang == "" {
+					return defaultLng
+				}
+				return lang
+			},
+		),
+	)
+}
--- a/router/router.go
+++ b/router/router.go
@@ -4,6 +4,7 @@ import (
 	"github.com/gin-contrib/cors"
 	"github.com/gin-gonic/gin"
 	"schisandra-cloud-album/global"
+	"schisandra-cloud-album/middleware"
 	"schisandra-cloud-album/router/modules"
 )

@@ -16,7 +17,11 @@ func InitRouter() *gin.Engine {
 		return nil
 	}
 	publicGroup := router.Group("api")
+	// 跨域设置
 	publicGroup.Use(cors.Default())
+	// 国际化设置
+	publicGroup.Use(middleware.I18n())
+
 	modules.SwaggerRouter(router)   // 注册swagger路由
 	modules.AuthRouter(publicGroup) // 注册鉴权路由
 	return router