refactor(setting): 集中管理环境配置并新增启动日志汇总
1. 将所有环境变量读取逻辑迁移至setting包统一管理，移除各模块直接os.Getenv调用 2. 新增全局配置结构体统一管理服务端口、鉴权、跨域等配置 3. 添加启动期配置汇总日志，方便运维核对环境配置生效情况 4. 重构鉴权和CORS中间件，改为读取全局配置而非直接读取环境变量 5. 优化health端点的环境变量检查逻辑，使用已加载的全局配置而非重复读取环境
This commit is contained in:
+135
-13
@@ -4,17 +4,111 @@ import (
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/volcano-tts/tts-api/common"
|
||||
"github.com/volcano-tts/tts-api/dto"
|
||||
)
|
||||
|
||||
// 全部环境变量读取的单一入口:其它包不允许直接 os.Getenv,只读这里的全局 Config。
|
||||
|
||||
// TTSConfig 上游火山 TTS 配置(由 InitTTSConfig 填充)。
|
||||
var (
|
||||
TTSConfig dto.ByteDanceTTSConfig
|
||||
TTSConfigErr error
|
||||
)
|
||||
|
||||
// AuthConfig OpenAI 兼容接口的客户端 API Key 鉴权配置。
|
||||
type AuthConfig struct {
|
||||
APIKeys []string
|
||||
}
|
||||
|
||||
var Auth AuthConfig
|
||||
|
||||
// CORSConfig 跨域白名单配置。
|
||||
type CORSConfig struct {
|
||||
Origins []string
|
||||
AllowAll bool
|
||||
}
|
||||
|
||||
var CORS CORSConfig
|
||||
|
||||
// ServerConfig HTTP 服务监听配置。
|
||||
type ServerConfig struct {
|
||||
Port string
|
||||
}
|
||||
|
||||
var Server ServerConfig
|
||||
|
||||
// InitAllConfigs 集中初始化所有配置,启动期调用一次。
|
||||
// 返回 TTSConfigErr(火山 TTS 必填项缺失时为非 nil);其它 Config 缺失时不返回 error,
|
||||
// 各自有合理兜底(Auth 放行 / CORS 拒绝跨域 / Server 默认 8080)。
|
||||
func InitAllConfigs() {
|
||||
InitServerConfig()
|
||||
InitAuthConfig()
|
||||
InitCORSConfig()
|
||||
TTSConfigErr = InitTTSConfig()
|
||||
}
|
||||
|
||||
// InitServerConfig 读取 PORT,缺省 common.DefaultPort。
|
||||
func InitServerConfig() {
|
||||
Server.Port = os.Getenv("PORT")
|
||||
if Server.Port == "" {
|
||||
Server.Port = common.DefaultPort
|
||||
}
|
||||
}
|
||||
|
||||
// InitAuthConfig 读取 OPENAI_TTS_API_KEY,支持逗号分隔多个 key。
|
||||
// 留空时 Auth.APIKeys 为空,ValidateAPIKey 会放行所有请求。
|
||||
func InitAuthConfig() {
|
||||
raw := os.Getenv("OPENAI_TTS_API_KEY")
|
||||
if raw == "" {
|
||||
Auth.APIKeys = nil
|
||||
return
|
||||
}
|
||||
parts := strings.Split(raw, ",")
|
||||
keys := make([]string, 0, len(parts))
|
||||
for _, p := range parts {
|
||||
k := strings.TrimSpace(p)
|
||||
if k != "" {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
}
|
||||
Auth.APIKeys = keys
|
||||
}
|
||||
|
||||
// InitCORSConfig 读取 ALLOWED_ORIGINS,按逗号分隔;支持 * 通配(AllowAll=true)。
|
||||
// 留空时 CORS.Origins 为空,跨域请求会被拒绝。
|
||||
func InitCORSConfig() {
|
||||
raw := os.Getenv("ALLOWED_ORIGINS")
|
||||
CORS.Origins = nil
|
||||
CORS.AllowAll = false
|
||||
if raw == "" {
|
||||
return
|
||||
}
|
||||
for _, p := range strings.Split(raw, ",") {
|
||||
o := strings.TrimSpace(p)
|
||||
if o == "" {
|
||||
continue
|
||||
}
|
||||
if o == "*" {
|
||||
CORS.AllowAll = true
|
||||
continue
|
||||
}
|
||||
CORS.Origins = append(CORS.Origins, normalizeOrigin(o))
|
||||
}
|
||||
}
|
||||
|
||||
// normalizeOrigin 复制自原 middleware/cors.go:小写 + 去尾斜杠。
|
||||
func normalizeOrigin(origin string) string {
|
||||
origin = strings.TrimSpace(origin)
|
||||
origin = strings.TrimRight(origin, "/")
|
||||
return strings.ToLower(origin)
|
||||
}
|
||||
|
||||
// InitTTSConfig 读取火山 TTS 必填和可选配置,填充 TTSConfig。
|
||||
// 必填项缺失时返回 error,服务可继续运行但 TTS 功能不可用。
|
||||
func InitTTSConfig() error {
|
||||
apiKey := os.Getenv("BYTEDANCE_TTS_API_KEY")
|
||||
resourceId := os.Getenv("BYTEDANCE_TTS_RESOURCE_ID")
|
||||
@@ -50,13 +144,13 @@ func InitTTSConfig() error {
|
||||
}
|
||||
}
|
||||
|
||||
// 音频格式，默认 mp3（文档默认值，流式场景下 wav 会多次返回 header，不推荐）
|
||||
// 音频格式,默认 mp3(文档默认值,流式场景中 wav 会多次返回 header,不推荐)
|
||||
format := os.Getenv("BYTEDANCE_TTS_FORMAT")
|
||||
if format == "" {
|
||||
format = "mp3"
|
||||
}
|
||||
|
||||
// 采样率，默认 24000
|
||||
// 采样率,默认 24000
|
||||
sampleRate := 24000
|
||||
if srStr := os.Getenv("BYTEDANCE_TTS_SAMPLE_RATE"); srStr != "" {
|
||||
if sr, err := fmt.Sscanf(srStr, "%d", &sampleRate); err != nil || sr != 1 {
|
||||
@@ -83,11 +177,38 @@ func InitTTSConfig() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// LogStartupSummary 在启动期打印所有 Config 的最终状态。
|
||||
// 调用时机:InitAllConfigs 之后,ListenAndServe 之前。
|
||||
func LogStartupSummary() {
|
||||
log.Printf("=== 环境配置汇总 ===")
|
||||
log.Printf("服务端口: %s", Server.Port)
|
||||
if len(Auth.APIKeys) == 0 {
|
||||
log.Printf("OPENAI_TTS_API_KEY: 未设置(所有请求无需鉴权)")
|
||||
} else {
|
||||
log.Printf("OPENAI_TTS_API_KEY: 已设置 %d 个有效密钥", len(Auth.APIKeys))
|
||||
}
|
||||
if CORS.AllowAll {
|
||||
log.Printf("ALLOWED_ORIGINS: *(允许所有跨域,不可与凭据共用)")
|
||||
} else if len(CORS.Origins) == 0 {
|
||||
log.Printf("ALLOWED_ORIGINS: 未设置(跨域请求将被拒绝)")
|
||||
} else {
|
||||
log.Printf("ALLOWED_ORIGINS: 已配置 %d 个允许的跨域来源白名单", len(CORS.Origins))
|
||||
}
|
||||
if TTSConfigErr != nil {
|
||||
log.Printf("火山 TTS 配置: 初始化失败 - %v (TTS 功能不可用)", TTSConfigErr)
|
||||
} else {
|
||||
log.Printf("火山 TTS 配置: 初始化成功 (model=%s, format=%s, sample_rate=%d, timeout=%v)",
|
||||
TTSConfig.Model, TTSConfig.Format, TTSConfig.SampleRate, TTSConfig.Timeout)
|
||||
}
|
||||
}
|
||||
|
||||
// CheckEnvironmentVariables 返回环境变量状态,供 /health 端点使用。
|
||||
// 不再直接 os.Getenv,改为读已初始化的全局 Config(单一数据源)。
|
||||
func CheckEnvironmentVariables() map[string]interface{} {
|
||||
requiredVars := map[string]bool{
|
||||
"BYTEDANCE_TTS_API_KEY": os.Getenv("BYTEDANCE_TTS_API_KEY") != "",
|
||||
"BYTEDANCE_TTS_RESOURCE_ID": os.Getenv("BYTEDANCE_TTS_RESOURCE_ID") != "",
|
||||
"BYTEDANCE_TTS_SPEAKER": os.Getenv("BYTEDANCE_TTS_SPEAKER") != "",
|
||||
"BYTEDANCE_TTS_API_KEY": TTSConfig.ApiKey != "",
|
||||
"BYTEDANCE_TTS_RESOURCE_ID": TTSConfig.ResourceId != "",
|
||||
"BYTEDANCE_TTS_SPEAKER": TTSConfig.Speaker != "",
|
||||
}
|
||||
|
||||
missingVars := []string{}
|
||||
@@ -98,13 +219,13 @@ func CheckEnvironmentVariables() map[string]interface{} {
|
||||
}
|
||||
|
||||
optionalVars := map[string]bool{
|
||||
"BYTEDANCE_TTS_TIMEOUT": os.Getenv("BYTEDANCE_TTS_TIMEOUT") != "",
|
||||
"BYTEDANCE_TTS_MODEL": os.Getenv("BYTEDANCE_TTS_MODEL") != "",
|
||||
"BYTEDANCE_TTS_FORMAT": os.Getenv("BYTEDANCE_TTS_FORMAT") != "",
|
||||
"BYTEDANCE_TTS_SAMPLE_RATE": os.Getenv("BYTEDANCE_TTS_SAMPLE_RATE") != "",
|
||||
"OPENAI_TTS_API_KEY": os.Getenv("OPENAI_TTS_API_KEY") != "",
|
||||
"ALLOWED_ORIGINS": os.Getenv("ALLOWED_ORIGINS") != "",
|
||||
"PORT": os.Getenv("PORT") != "",
|
||||
|
||||
"BYTEDANCE_TTS_MODEL": TTSConfig.Model != "" && TTSConfig.Model != "seed-tts-2.0-standard",
|
||||
"BYTEDANCE_TTS_FORMAT": TTSConfig.Format != "" && TTSConfig.Format != "mp3",
|
||||
"BYTEDANCE_TTS_SAMPLE_RATE": TTSConfig.SampleRate != 24000,
|
||||
"OPENAI_TTS_API_KEY": len(Auth.APIKeys) > 0,
|
||||
"ALLOWED_ORIGINS": CORS.AllowAll || len(CORS.Origins) > 0,
|
||||
"PORT": Server.Port != common.DefaultPort,
|
||||
}
|
||||
|
||||
return map[string]interface{}{
|
||||
@@ -115,8 +236,9 @@ func CheckEnvironmentVariables() map[string]interface{} {
|
||||
}
|
||||
}
|
||||
|
||||
// CheckStaticFiles 静态文件存在性检查,/dashboard 路由需要 health.html。
|
||||
func CheckStaticFiles() {
|
||||
if _, err := os.Stat("health.html"); os.IsNotExist(err) {
|
||||
log.Println("警告: health.html 不存在，/dashboard 路由将返回 404")
|
||||
log.Println("警告: health.html 不存在,/dashboard 路由将返回 404")
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user