Merge remote-tracking branch 'origin/main'

piexlmax · piexlmax · commit 670df8c0cb61 · 2022-05-24T21:24:31.000+08:00
diff --git a/server/api/v1/system/sys_api.go b/server/api/v1/system/sys_api.go
@@ -110,7 +110,7 @@ func (s *SystemApiApi) GetApiById(c *gin.Context) {
 		global.GVA_LOG.Error("获取失败!", zap.Error(err))
 		response.FailWithMessage("获取失败", c)
 	} else {
-		response.OkWithData(systemRes.SysAPIResponse{Api: api}, c)
+		response.OkWithDetailed(systemRes.SysAPIResponse{Api: api}, "获取成功", c)
 	}
 }
 
diff --git a/server/api/v1/system/sys_initdb.go b/server/api/v1/system/sys_initdb.go
@@ -35,7 +35,7 @@ func (i *DBApi) InitDB(c *gin.Context) {
 		response.FailWithMessage("自动创建数据库失败，请查看后台日志，检查后在进行初始化", c)
 		return
 	}
-	response.OkWithData("自动创建数据库成功", c)
+	response.OkWithMessage("自动创建数据库成功", c)
 }
 
 // CheckDB
diff --git a/server/api/v1/system/sys_system.go b/server/api/v1/system/sys_system.go
@@ -42,7 +42,7 @@ func (s *SystemApi) SetSystemConfig(c *gin.Context) {
 		global.GVA_LOG.Error("设置失败!", zap.Error(err))
 		response.FailWithMessage("设置失败", c)
 	} else {
-		response.OkWithData("设置成功", c)
+		response.OkWithMessage("设置成功", c)
 	}
 }
 
diff --git a/server/config/config.go b/server/config/config.go
@@ -11,9 +11,9 @@ type Server struct {
 	// auto
 	AutoCode Autocode `mapstructure:"autocode" json:"autocode" yaml:"autocode"`
 	// gorm
-	Mysql  Mysql `mapstructure:"mysql" json:"mysql" yaml:"mysql"`
-	Pgsql  Pgsql `mapstructure:"pgsql" json:"pgsql" yaml:"pgsql"`
-	DBList []DB  `mapstructure:"db-list" json:"db-list" yaml:"db-list"`
+	Mysql  Mysql           `mapstructure:"mysql" json:"mysql" yaml:"mysql"`
+	Pgsql  Pgsql           `mapstructure:"pgsql" json:"pgsql" yaml:"pgsql"`
+	DBList []SpecializedDB `mapstructure:"db-list" json:"db-list" yaml:"db-list"`
 	// oss
 	Local      Local      `mapstructure:"local" json:"local" yaml:"local"`
 	Qiniu      Qiniu      `mapstructure:"qiniu" json:"qiniu" yaml:"qiniu"`
diff --git a/server/config/db_list.go b/server/config/db_list.go
@@ -1,9 +1,14 @@
 package config
 
-type DB struct {
-	Disable      bool   `mapstructure:"disable" json:"disable" yaml:"disable"`
-	Type         string `mapstructure:"type" json:"type" yaml:"type"`
-	AliasName    string `mapstructure:"alias-name" json:"alias-name" yaml:"alias-name"`
+type DsnProvider interface {
+	Dsn() string
+}
+
+// Embeded 结构体可以压平到上一层，从而保持 config 文件的结构和原来一样
+// 见 playground: https://go.dev/play/p/KIcuhqEoxmY
+
+// GeneralDB 也被 Pgsql 和 Mysql 原样使用
+type GeneralDB struct {
 	Path         string `mapstructure:"path" json:"path" yaml:"path"`                               // 服务器地址:端口
 	Port         string `mapstructure:"port" json:"port" yaml:"port"`                               //:端口
 	Config       string `mapstructure:"config" json:"config" yaml:"config"`                         // 高级配置
@@ -13,9 +18,12 @@ type DB struct {
 	MaxIdleConns int    `mapstructure:"max-idle-conns" json:"max-idle-conns" yaml:"max-idle-conns"` // 空闲中的最大连接数
 	MaxOpenConns int    `mapstructure:"max-open-conns" json:"max-open-conns" yaml:"max-open-conns"` // 打开到数据库的最大连接数
 	LogMode      string `mapstructure:"log-mode" json:"log-mode" yaml:"log-mode"`                   // 是否开启Gorm全局日志
-	LogZap       bool   `mapstructure:"log-zap" json:"log-zap" yaml:"log-zap"`
+	LogZap       bool   `mapstructure:"log-zap" json:"log-zap" yaml:"log-zap"`                      // 是否通过zap写入日志文件
 }
 
-func (m *DB) Dsn() string {
-	return m.Username + ":" + m.Password + "@tcp(" + m.Path + ":" + m.Port + ")/" + m.Dbname + "?" + m.Config
+type SpecializedDB struct {
+	Disable   bool   `mapstructure:"disable" json:"disable" yaml:"disable"`
+	Type      string `mapstructure:"type" json:"type" yaml:"type"`
+	AliasName string `mapstructure:"alias-name" json:"alias-name" yaml:"alias-name"`
+	GeneralDB `yaml:",inline" mapstructure:",squash"`
 }
diff --git a/server/config/gorm_mysql.go b/server/config/gorm_mysql.go
@@ -1,16 +1,7 @@
 package config
 
 type Mysql struct {
-	Path         string `mapstructure:"path" json:"path" yaml:"path"`                               // 服务器地址
-	Port         string `mapstructure:"port" json:"port" yaml:"port"`                               // 端口
-	Config       string `mapstructure:"config" json:"config" yaml:"config"`                         // 高级配置
-	Dbname       string `mapstructure:"db-name" json:"db-name" yaml:"db-name"`                      // 数据库名
-	Username     string `mapstructure:"username" json:"username" yaml:"username"`                   // 数据库用户名
-	Password     string `mapstructure:"password" json:"password" yaml:"password"`                   // 数据库密码
-	MaxIdleConns int    `mapstructure:"max-idle-conns" json:"max-idle-conns" yaml:"max-idle-conns"` // 空闲中的最大连接数
-	MaxOpenConns int    `mapstructure:"max-open-conns" json:"max-open-conns" yaml:"max-open-conns"` // 打开到数据库的最大连接数
-	LogMode      string `mapstructure:"log-mode" json:"log-mode" yaml:"log-mode"`                   // 是否开启Gorm全局日志
-	LogZap       bool   `mapstructure:"log-zap" json:"log-zap" yaml:"log-zap"`                      // 是否通过zap写入日志文件
+	GeneralDB `yaml:",inline" mapstructure:",squash"`
 }
 
 func (m *Mysql) Dsn() string {
diff --git a/server/config/gorm_pgsql.go b/server/config/gorm_pgsql.go
@@ -1,16 +1,7 @@
 package config
 
 type Pgsql struct {
-	Path         string `mapstructure:"path" json:"path" yaml:"path"`                               // 服务器地址:端口
-	Port         string `mapstructure:"port" json:"port" yaml:"port"`                               //:端口
-	Config       string `mapstructure:"config" json:"config" yaml:"config"`                         // 高级配置
-	Dbname       string `mapstructure:"db-name" json:"db-name" yaml:"db-name"`                      // 数据库名
-	Username     string `mapstructure:"username" json:"username" yaml:"username"`                   // 数据库用户名
-	Password     string `mapstructure:"password" json:"password" yaml:"password"`                   // 数据库密码
-	MaxIdleConns int    `mapstructure:"max-idle-conns" json:"max-idle-conns" yaml:"max-idle-conns"` // 空闲中的最大连接数
-	MaxOpenConns int    `mapstructure:"max-open-conns" json:"max-open-conns" yaml:"max-open-conns"` // 打开到数据库的最大连接数
-	LogMode      string `mapstructure:"log-mode" json:"log-mode" yaml:"log-mode"`                   // 是否开启Gorm全局日志
-	LogZap       bool   `mapstructure:"log-zap" json:"log-zap" yaml:"log-zap"`                      // 是否通过zap写入日志文件
+	GeneralDB `yaml:",inline" mapstructure:",squash"`
 }
 
 // Dsn 基于配置文件获取 dsn
diff --git a/server/initialize/db_list.go b/server/initialize/db_list.go
@@ -1,6 +1,7 @@
 package initialize
 
 import (
+	"github.com/flipped-aurora/gin-vue-admin/server/config"
 	"github.com/flipped-aurora/gin-vue-admin/server/global"
 	"gorm.io/gorm"
 )
@@ -15,9 +16,9 @@ func DBList() {
 		}
 		switch info.Type {
 		case "mysql":
-			dbMap[info.Dbname] = GormMysqlByConfig(info)
+			dbMap[info.GeneralDB.Dbname] = GormMysqlByConfig(config.Mysql{GeneralDB: info.GeneralDB})
 		case "pgsql":
-			dbMap[info.Dbname] = GormPgSqlByConfig(info)
+			dbMap[info.GeneralDB.Dbname] = GormPgSqlByConfig(config.Pgsql{GeneralDB: info.GeneralDB})
 		default:
 			continue
 		}
diff --git a/server/initialize/gorm_mysql.go b/server/initialize/gorm_mysql.go
@@ -32,7 +32,7 @@ func GormMysql() *gorm.DB {
 }
 
 // GormMysqlByConfig 初始化Mysql数据库用过传入配置
-func GormMysqlByConfig(m config.DB) *gorm.DB {
+func GormMysqlByConfig(m config.Mysql) *gorm.DB {
 	if m.Dbname == "" {
 		return nil
 	}
diff --git a/server/initialize/gorm_pgsql.go b/server/initialize/gorm_pgsql.go
@@ -31,7 +31,7 @@ func GormPgSql() *gorm.DB {
 }
 
 // GormPgSqlByConfig 初始化 Postgresql 数据库 通过参数
-func GormPgSqlByConfig(p config.DB) *gorm.DB {
+func GormPgSqlByConfig(p config.Pgsql) *gorm.DB {
 	if p.Dbname == "" {
 		return nil
 	}
diff --git a/server/model/common/response/response.go b/server/model/common/response/response.go
@@ -35,7 +35,7 @@ func OkWithMessage(message string, c *gin.Context) {
 }
 
 func OkWithData(data interface{}, c *gin.Context) {
-	Result(SUCCESS, data, "操作成功", c)
+	Result(SUCCESS, data, "查询成功", c)
 }
 
 func OkWithDetailed(data interface{}, message string, c *gin.Context) {
diff --git a/server/model/system/request/sys_init.go b/server/model/system/request/sys_init.go
@@ -43,30 +43,34 @@ func (i *InitDB) PgsqlEmptyDsn() string {
 // Author [SliverHorn](https://github.com/SliverHorn)
 func (i *InitDB) ToMysqlConfig() config.Mysql {
 	return config.Mysql{
-		Path:         i.Host,
-		Port:         i.Port,
-		Dbname:       i.DBName,
-		Username:     i.UserName,
-		Password:     i.Password,
-		MaxIdleConns: 10,
-		MaxOpenConns: 100,
-		LogMode:      "error",
-		Config:       "charset=utf8mb4&parseTime=True&loc=Local",
+		GeneralDB: config.GeneralDB{
+			Path:         i.Host,
+			Port:         i.Port,
+			Dbname:       i.DBName,
+			Username:     i.UserName,
+			Password:     i.Password,
+			MaxIdleConns: 10,
+			MaxOpenConns: 100,
+			LogMode:      "error",
+			Config:       "charset=utf8mb4&parseTime=True&loc=Local",
+		},
 	}
 }
 
 // ToPgsqlConfig 转换 config.Pgsql
 // Author [SliverHorn](https://github.com/SliverHorn)
 func (i *InitDB) ToPgsqlConfig() config.Pgsql {
 	return config.Pgsql{
-		Path:         i.Host,
-		Port:         i.Port,
-		Dbname:       i.DBName,
-		Username:     i.UserName,
-		Password:     i.Password,
-		MaxIdleConns: 10,
-		MaxOpenConns: 100,
-		LogMode:      "error",
-		Config:       "sslmode=disable TimeZone=Asia/Shanghai",
+		GeneralDB: config.GeneralDB{
+			Path:         i.Host,
+			Port:         i.Port,
+			Dbname:       i.DBName,
+			Username:     i.UserName,
+			Password:     i.Password,
+			MaxIdleConns: 10,
+			MaxOpenConns: 100,
+			LogMode:      "error",
+			Config:       "sslmode=disable TimeZone=Asia/Shanghai",
+		},
 	}
 }
diff --git a/server/plugin/email/api/sys_email.go b/server/plugin/email/api/sys_email.go
@@ -22,7 +22,7 @@ func (s *EmailApi) EmailTest(c *gin.Context) {
 		global.GVA_LOG.Error("发送失败!", zap.Error(err))
 		response.FailWithMessage("发送失败", c)
 	} else {
-		response.OkWithData("发送成功", c)
+		response.OkWithMessage("发送成功", c)
 	}
 }
 
@@ -40,6 +40,6 @@ func (s *EmailApi) SendEmail(c *gin.Context) {
 		global.GVA_LOG.Error("发送失败!", zap.Error(err))
 		response.FailWithMessage("发送失败", c)
 	} else {
-		response.OkWithData("发送成功", c)
+		response.OkWithMessage("发送成功", c)
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ func (s SystemApiApi) GetApiById(c gin.Context) {`
`110`	`110`	`global.GVA_LOG.Error("获取失败!", zap.Error(err))`
`111`	`111`	`response.FailWithMessage("获取失败", c)`
`112`	`112`	`} else {`
`113`		`- response.OkWithData(systemRes.SysAPIResponse{Api: api}, c)`
	`113`	`+ response.OkWithDetailed(systemRes.SysAPIResponse{Api: api}, "获取成功", c)`
`114`	`114`	`}`
`115`	`115`	`}`
`116`	`116`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ func (i DBApi) InitDB(c gin.Context) {`
`35`	`35`	`response.FailWithMessage("自动创建数据库失败，请查看后台日志，检查后在进行初始化", c)`
`36`	`36`	`return`
`37`	`37`	`}`
`38`		`- response.OkWithData("自动创建数据库成功", c)`
	`38`	`+ response.OkWithMessage("自动创建数据库成功", c)`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`// CheckDB`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ func (s SystemApi) SetSystemConfig(c gin.Context) {`
`42`	`42`	`global.GVA_LOG.Error("设置失败!", zap.Error(err))`
`43`	`43`	`response.FailWithMessage("设置失败", c)`
`44`	`44`	`} else {`
`45`		`- response.OkWithData("设置成功", c)`
	`45`	`+ response.OkWithMessage("设置成功", c)`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package initialize`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "github.com/flipped-aurora/gin-vue-admin/server/config"`
`4`	`5`	`"github.com/flipped-aurora/gin-vue-admin/server/global"`
`5`	`6`	`"gorm.io/gorm"`
`6`	`7`	`)`
`@@ -15,9 +16,9 @@ func DBList() {`
`15`	`16`	`}`
`16`	`17`	`switch info.Type {`
`17`	`18`	`case "mysql":`
`18`		`- dbMap[info.Dbname] = GormMysqlByConfig(info)`
	`19`	`+ dbMap[info.GeneralDB.Dbname] = GormMysqlByConfig(config.Mysql{GeneralDB: info.GeneralDB})`
`19`	`20`	`case "pgsql":`
`20`		`- dbMap[info.Dbname] = GormPgSqlByConfig(info)`
	`21`	`+ dbMap[info.GeneralDB.Dbname] = GormPgSqlByConfig(config.Pgsql{GeneralDB: info.GeneralDB})`
`21`	`22`	`default:`
`22`	`23`	`continue`
`23`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func GormMysql() *gorm.DB {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`// GormMysqlByConfig 初始化Mysql数据库用过传入配置`
`35`		`-func GormMysqlByConfig(m config.DB) *gorm.DB {`
	`35`	`+func GormMysqlByConfig(m config.Mysql) *gorm.DB {`
`36`	`36`	`if m.Dbname == "" {`
`37`	`37`	`return nil`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ func GormPgSql() *gorm.DB {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`// GormPgSqlByConfig 初始化 Postgresql 数据库通过参数`
`34`		`-func GormPgSqlByConfig(p config.DB) *gorm.DB {`
	`34`	`+func GormPgSqlByConfig(p config.Pgsql) *gorm.DB {`
`35`	`35`	`if p.Dbname == "" {`
`36`	`36`	`return nil`
`37`	`37`	`}`