Optimize the output of sensitive log information

This commit is contained in:
2025-10-31 09:38:36 +08:00
parent 5aacb88c22
commit b61d8aae8f
6 changed files with 151 additions and 20 deletions

View File

@@ -81,8 +81,16 @@ func setupLogrusForNonHTTP() {
// 使用命令行指定的配置文件 // 使用命令行指定的配置文件
config.Init(cfgFile) config.Init(cfgFile)
} else { } else {
// 使用默认配置文件路径 // 使用默认配置文件路径,基于可执行文件所在目录
config.Init("./config.json") execPath, err := os.Executable()
if err != nil {
// 如果获取可执行文件路径失败,使用当前工作目录
config.Init("./config.json")
} else {
execDir := filepath.Dir(execPath)
configPath := filepath.Join(execDir, "config.json")
config.Init(configPath)
}
} }
// 根据配置文件进一步配置logrus // 根据配置文件进一步配置logrus
@@ -92,7 +100,7 @@ func setupLogrusForNonHTTP() {
logger.InitLogger() logger.InitLogger()
// 记录配置加载完成 // 记录配置加载完成
logrus.WithField("config_file", viper.ConfigFileUsed()).Info("配置文件加载完成") logrus.Info("配置文件加载完成")
} }
// initConfig 读取配置文件和环境变量 // initConfig 读取配置文件和环境变量

View File

@@ -174,6 +174,8 @@ func startServer(server *http.Server) {
// 等待中断信号 // 等待中断信号
<-sigChan <-sigChan
// 清除终端上的 ^C 字符并移动光标到行首
fmt.Print("\r\033[K")
logger.Info("收到关闭信号,正在优雅关闭服务器...") logger.Info("收到关闭信号,正在优雅关闭服务器...")
// 创建一个带超时的上下文 // 创建一个带超时的上下文

View File

@@ -6,9 +6,11 @@ import (
"errors" "errors"
"io/fs" "io/fs"
"os" "os"
"path/filepath"
log "github.com/sirupsen/logrus" log "github.com/sirupsen/logrus"
"github.com/spf13/viper" "github.com/spf13/viper"
"networkDev/utils"
) )
// ============================================================================ // ============================================================================
@@ -115,9 +117,9 @@ func GetDefaultAppConfig() *AppConfig {
MySQL: MySQLConfig{ MySQL: MySQLConfig{
Host: "localhost", Host: "localhost",
Port: 3306, Port: 3306,
Username: "root", Username: "",
Password: "password", Password: "",
Database: "networkdev", Database: "",
Charset: "utf8mb4", Charset: "utf8mb4",
MaxIdleConns: 10, MaxIdleConns: 10,
MaxOpenConns: 100, MaxOpenConns: 100,
@@ -172,7 +174,17 @@ func GetSecureDefaultAppConfig() (*AppConfig, error) {
// Init 初始化配置文件 // Init 初始化配置文件
func Init(cfgFilePath string) { func Init(cfgFilePath string) {
viper.SetConfigFile(cfgFilePath) // 确保配置文件路径为绝对路径
absoluteConfigPath, err := utils.EnsureAbsolutePath(cfgFilePath)
if err != nil {
log.WithFields(
log.Fields{
"err": err,
"path": cfgFilePath,
},
).Fatal("转换配置文件路径为绝对路径失败")
}
viper.SetConfigFile(absoluteConfigPath)
viper.SetConfigType("json") viper.SetConfigType("json")
viper.AddConfigPath(".") viper.AddConfigPath(".")
@@ -203,8 +215,8 @@ func Init(cfgFilePath string) {
return return
} }
// 写入配置文件 // 写入配置文件,使用绝对路径
err = os.WriteFile(cfgFilePath, configBytes, 0o644) err = os.WriteFile(absoluteConfigPath, configBytes, 0o644)
if err != nil { if err != nil {
log.WithFields( log.WithFields(
log.Fields{ log.Fields{
@@ -212,9 +224,11 @@ func Init(cfgFilePath string) {
}, },
).Error("写入默认配置文件失败") ).Error("写入默认配置文件失败")
} else { } else {
// 只显示配置文件名,不显示完整路径
fileName := filepath.Base(cfgFilePath)
log.WithFields( log.WithFields(
log.Fields{ log.Fields{
"file": cfgFilePath, "file": fileName,
}, },
).Info("写入默认配置文件成功(已生成安全密钥)") ).Info("写入默认配置文件成功(已生成安全密钥)")
} }
@@ -238,11 +252,20 @@ func Init(cfgFilePath string) {
).Fatal("配置文件解析错误") ).Fatal("配置文件解析错误")
} }
} }
log.WithFields(
log.Fields{ // 只显示配置文件名,不显示完整路径
"file": viper.ConfigFileUsed(), configFile := viper.ConfigFileUsed()
}, if configFile != "" {
).Info("使用配置文件") // 提取文件名
fileName := filepath.Base(configFile)
log.WithFields(
log.Fields{
"file": fileName,
},
).Info("使用配置文件")
} else {
log.Info("使用默认配置")
}
// 验证配置 // 验证配置
if _, err := ValidateConfig(); err != nil { if _, err := ValidateConfig(); err != nil {
@@ -250,12 +273,18 @@ func Init(cfgFilePath string) {
log.Fields{ log.Fields{
"err": err, "err": err,
}, },
).Fatal("配置验证失败") ).Fatal("配置内容验证失败")
} }
} }
// CreateDefaultConfig 创建默认配置文件 // CreateDefaultConfig 创建默认配置文件
func CreateDefaultConfig(filePath string) error { func CreateDefaultConfig(filePath string) error {
// 确保文件路径为绝对路径
absoluteFilePath, err := utils.EnsureAbsolutePath(filePath)
if err != nil {
return err
}
// 生成带有安全密钥的默认配置 // 生成带有安全密钥的默认配置
defaultConfig, err := GetSecureDefaultAppConfig() defaultConfig, err := GetSecureDefaultAppConfig()
if err != nil { if err != nil {
@@ -273,5 +302,5 @@ func CreateDefaultConfig(filePath string) error {
return err return err
} }
return os.WriteFile(filePath, configBytes, 0o644) return os.WriteFile(absoluteFilePath, configBytes, 0o644)
} }

View File

@@ -11,6 +11,7 @@ import (
log "github.com/sirupsen/logrus" log "github.com/sirupsen/logrus"
"github.com/spf13/viper" "github.com/spf13/viper"
"networkDev/utils"
) )
// ============================================================================ // ============================================================================
@@ -31,7 +32,7 @@ func ValidateConfig() (*AppConfig, error) {
return nil, fmt.Errorf("配置验证失败: %w", err) return nil, fmt.Errorf("配置验证失败: %w", err)
} }
log.Info("配置验证通过") log.Info("配置内容验证通过")
return &config, nil return &config, nil
} }
@@ -134,6 +135,15 @@ func validateSQLiteConfig(config *SQLiteConfig) error {
return errors.New("SQLite数据库路径不能为空") return errors.New("SQLite数据库路径不能为空")
} }
// 确保数据库路径为绝对路径
absolutePath, err := utils.EnsureAbsolutePath(config.Path)
if err != nil {
return fmt.Errorf("转换SQLite数据库路径为绝对路径失败: %w", err)
}
// 更新配置中的路径为绝对路径
config.Path = absolutePath
// 检查目录是否存在,不存在则创建 // 检查目录是否存在,不存在则创建
dir := filepath.Dir(config.Path) dir := filepath.Dir(config.Path)
if _, err := os.Stat(dir); os.IsNotExist(err) { if _, err := os.Stat(dir); os.IsNotExist(err) {

View File

@@ -3,6 +3,7 @@ package database
import ( import (
"fmt" "fmt"
"networkDev/utils" "networkDev/utils"
"path/filepath"
"sync" "sync"
"github.com/glebarez/sqlite" "github.com/glebarez/sqlite"
@@ -91,7 +92,15 @@ func initSQLite() error {
if path == "" { if path == "" {
path = "./database.db" path = "./database.db"
} }
dsn := fmt.Sprintf("file:%s?cache=shared&_busy_timeout=5000&_fk=1", path)
// 确保数据库路径为绝对路径
absolutePath, err := utils.EnsureAbsolutePath(path)
if err != nil {
logrus.WithError(err).Error("转换SQLite数据库路径为绝对路径失败")
return err
}
dsn := fmt.Sprintf("file:%s?cache=shared&_busy_timeout=5000&_fk=1", absolutePath)
db, err := gorm.Open(sqlite.Open(dsn), &gorm.Config{}) db, err := gorm.Open(sqlite.Open(dsn), &gorm.Config{})
if err != nil { if err != nil {
logrus.WithError(err).Error("SQLite 初始化失败") logrus.WithError(err).Error("SQLite 初始化失败")
@@ -106,7 +115,9 @@ func initSQLite() error {
} }
dbInstance = db dbInstance = db
logrus.WithField("path", path).Info("SQLite 连接已建立") // 记录连接成功信息(只显示文件名,不泄露完整路径)
fileName := filepath.Base(absolutePath)
logrus.WithField("file", fileName).Info("SQLite 连接已建立")
return nil return nil
} }

71
utils/filepath.go Executable file
View File

@@ -0,0 +1,71 @@
package utils
import (
"errors"
"os"
"path/filepath"
)
// EnsureAbsolutePath 确保路径为绝对路径
// 如果传入的路径已经是绝对路径,直接返回
// 如果是相对路径,则基于当前工作目录转换为绝对路径
func EnsureAbsolutePath(path string) (string, error) {
if filepath.IsAbs(path) {
return path, nil
}
// 获取当前工作目录
currentDir, err := os.Getwd()
if err != nil {
return "", errors.New("获取当前工作目录失败")
}
// 将相对路径转换为绝对路径
return filepath.Join(currentDir, path), nil
}
// EnsureAbsolutePathWithBase 基于指定基础目录确保路径为绝对路径
// 如果传入的路径已经是绝对路径,直接返回
// 如果是相对路径,则基于指定的基础目录转换为绝对路径
func EnsureAbsolutePathWithBase(path, baseDir string) (string, error) {
if filepath.IsAbs(path) {
return path, nil
}
// 确保基础目录是绝对路径
absBaseDir, err := EnsureAbsolutePath(baseDir)
if err != nil {
return "", errors.New("基础目录路径处理失败")
}
// 将相对路径转换为绝对路径
return filepath.Join(absBaseDir, path), nil
}
// GetExecutableDir 获取可执行文件所在目录的绝对路径
func GetExecutableDir() (string, error) {
execPath, err := os.Executable()
if err != nil {
return "", errors.New("获取可执行文件路径失败")
}
return filepath.Dir(execPath), nil
}
// EnsureAbsolutePathFromExecutable 基于可执行文件目录确保路径为绝对路径
// 如果传入的路径已经是绝对路径,直接返回
// 如果是相对路径,则基于可执行文件所在目录转换为绝对路径
func EnsureAbsolutePathFromExecutable(path string) (string, error) {
if filepath.IsAbs(path) {
return path, nil
}
// 获取可执行文件目录
execDir, err := GetExecutableDir()
if err != nil {
// 如果获取可执行文件目录失败,回退到当前工作目录
return EnsureAbsolutePath(path)
}
// 将相对路径转换为绝对路径
return filepath.Join(execDir, path), nil
}