feat: 支持从 config.yaml 读取 MySQL 配置 (#83)

This commit is contained in:
chengma
2026-08-10 09:24:04 +08:00
parent ad44c3ee86
commit 04a777dc8e
9 changed files with 222 additions and 35 deletions
+76 -24
View File
@@ -31,14 +31,16 @@ const (
databasePasswordEnv = "CMAUTOBUY_DB_PASSWORD"
)
// DatabaseConfig 是生产 MySQL 8 的连接配置。
// 密码只从环境变量读取,不能写进 config.yaml、日志或工单。
// DatabaseConfig 是 MySQL 8 的连接配置。
//
// 本地运行可以从被 Git 忽略的 config.yaml 读取;线上部署仍建议使用
// CMAUTOBUY_DB_* 环境变量。无论来源是什么,密码都不能写进日志或工单。
type DatabaseConfig struct {
Host string
Port string
Name string
User string
Password string
Host string `yaml:"host"`
Port string `yaml:"port"`
Name string `yaml:"name"`
User string `yaml:"user"`
Password string `yaml:"password"`
}
// String 永远隐藏密码,防止排错时用 %v 把凭据写进日志。
@@ -51,16 +53,66 @@ func (c DatabaseConfig) String() string {
c.Host, c.Port, c.Name, c.User, password)
}
// LoadDatabaseFromEnv 读取生产数据库配置。
// Host/Port 使用线上同机部署的安全默认值;库名、账号和密码必须显式提供。
func LoadDatabaseFromEnv() (DatabaseConfig, error) {
cfg := DatabaseConfig{
Host: strings.TrimSpace(os.Getenv(databaseHostEnv)),
Port: strings.TrimSpace(os.Getenv(databasePortEnv)),
Name: strings.TrimSpace(os.Getenv(databaseNameEnv)),
User: strings.TrimSpace(os.Getenv(databaseUserEnv)),
Password: os.Getenv(databasePasswordEnv),
// LoadDatabase 读取 MySQL 配置。config.yaml 适合本地双击 run_admin.bat;
// CMAUTOBUY_DB_* 环境变量按字段覆盖文件配置,供线上 systemd 安全注入。
//
// config.yaml 不存在时仍可完全依靠环境变量启动,保持线上部署兼容。
func LoadDatabase() (DatabaseConfig, error) {
path, err := ConfigPath()
if err != nil {
return DatabaseConfig{}, fmt.Errorf("无法确定 config.yaml 应该在的位置: %w", err)
}
return loadDatabaseFromPath(path)
}
// loadDatabaseFromPath 把文件读取单独抽出来,方便单元测试使用临时配置文件,
// 不依赖测试可执行文件所在的临时目录。
func loadDatabaseFromPath(path string) (DatabaseConfig, error) {
var fileConfig DatabaseConfig
raw, err := os.ReadFile(path)
if err == nil {
cfg, parseErr := parseConfig(raw, path)
if parseErr != nil {
return DatabaseConfig{}, parseErr
}
fileConfig = cfg.Database
} else if !os.IsNotExist(err) {
return DatabaseConfig{}, fmt.Errorf("读取配置文件 %s 失败: %w", path, err)
}
return mergeDatabaseConfig(fileConfig)
}
// LoadDatabaseFromEnv 只读取环境变量,供集成测试创建隔离的 _test 数据库。
// 生产入口和迁移命令应使用 LoadDatabase。
func LoadDatabaseFromEnv() (DatabaseConfig, error) {
return mergeDatabaseConfig(DatabaseConfig{})
}
// mergeDatabaseConfig 把环境变量合并到文件配置上。环境变量只要非空,
// 就覆盖对应 YAML 字段,避免线上误读部署目录里遗留的本地配置。
func mergeDatabaseConfig(cfg DatabaseConfig) (DatabaseConfig, error) {
overrides := map[string]*string{
databaseHostEnv: &cfg.Host,
databasePortEnv: &cfg.Port,
databaseNameEnv: &cfg.Name,
databaseUserEnv: &cfg.User,
databasePasswordEnv: &cfg.Password,
}
for envName, target := range overrides {
value := os.Getenv(envName)
if envName != databasePasswordEnv {
value = strings.TrimSpace(value)
}
if value != "" {
*target = value
}
}
cfg.Host = strings.TrimSpace(cfg.Host)
cfg.Port = strings.TrimSpace(cfg.Port)
cfg.Name = strings.TrimSpace(cfg.Name)
cfg.User = strings.TrimSpace(cfg.User)
if cfg.Host == "" {
cfg.Host = "127.0.0.1"
}
@@ -69,16 +121,16 @@ func LoadDatabaseFromEnv() (DatabaseConfig, error) {
}
var missing []string
if cfg.Name == "" {
missing = append(missing, databaseNameEnv)
missing = append(missing, "database.name / "+databaseNameEnv)
}
if cfg.User == "" {
missing = append(missing, databaseUserEnv)
missing = append(missing, "database.user / "+databaseUserEnv)
}
if cfg.Password == "" {
missing = append(missing, databasePasswordEnv)
missing = append(missing, "database.password / "+databasePasswordEnv)
}
if len(missing) > 0 {
return DatabaseConfig{}, fmt.Errorf("缺少 MySQL 配置环境变量:%s", strings.Join(missing, "、"))
return DatabaseConfig{}, fmt.Errorf("缺少 MySQL 配置:%s", strings.Join(missing, "、"))
}
return cfg, nil
}
@@ -180,10 +232,10 @@ func (c SybConfig) String() string {
c.BaseURL, c.Username, pw, c.PageSize, c.MaxMatches, c.SyncFrom, c.OcrURL, c.OcrMaxAttempts)
}
// Config 是 config.yaml 的顶层结构。目前只有顺运宝一节,
// 后续如果要给别的模块加配置,在这里加新的字段即可。
// Config 是 config.yaml 的顶层结构。
type Config struct {
Syb SybConfig `yaml:"syb"`
Database DatabaseConfig `yaml:"database"`
Syb SybConfig `yaml:"syb"`
}
// configFileName 是 config.yaml 相对 exe(或 go run 时相对工作目录)的文件名。
@@ -236,7 +288,7 @@ func Load() (*Config, error) {
func missingConfigError(path string) error {
return fmt.Errorf(
"没有找到配置文件 %s。\n"+
"请复制 config.example.yaml 为 config.yaml,并填入顺运宝账号密码:\n"+
"请复制 config.example.yaml 为 config.yaml,并填入 MySQL 和顺运宝账号密码:\n"+
" Windows: copy admin\\config.example.yaml admin\\config.yaml\n"+
" Linux: cp admin/config.example.yaml admin/config.yaml",
path)