landaiqing/voidraft
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

♻️ Refactor and clean up the code

Browse Source
This commit is contained in:
landaiqing
2025-06-22 21:30:45 +08:00
parent eb9b037f8e
commit d6dd34db87
22 changed files with 357 additions and 843 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
internal/models/config.go
View File

@@ -84,7 +84,7 @@ type AppearanceConfig struct {
// UpdatesConfig 更新设置配置
type UpdatesConfig struct {
Version string `json:"Version"` // 当前版本号
Version string `json:"version"` // 当前版本号
AutoUpdate bool `json:"autoUpdate"` // 是否自动更新
BetaChannel bool `json:"betaChannel"` // 是否启用测试版
}
@@ -101,6 +101,7 @@ type AppConfig struct {
// ConfigMetadata 配置元数据
type ConfigMetadata struct {
LastUpdated string `json:"lastUpdated"` // 最后更新时间
Version string `json:"version"` // 配置版本号
}
// NewDefaultAppConfig 创建默认应用配置
@@ -148,6 +149,7 @@ func NewDefaultAppConfig() *AppConfig {
},
Metadata: ConfigMetadata{
LastUpdated: time.Now().Format(time.RFC3339),
Version: "1.0.0",
},
}
}

22
internal/services/config_notification_service.go
View File

@@ -9,7 +9,7 @@ import (
"time"
"voidraft/internal/models"
"github.com/spf13/viper"
"github.com/knadh/koanf/v2"
"github.com/wailsapp/wails/v3/pkg/services/log"
)
@@ -32,7 +32,7 @@ type ConfigListener struct {
ChangeType ConfigChangeType // 监听的配置变更类型
Callback ConfigChangeCallback // 回调函数（现在包含新旧配置）
DebounceDelay time.Duration // 防抖延迟时间
GetConfigFunc func(*viper.Viper) *models.AppConfig // 获取相关配置的函数
GetConfigFunc func(*koanf.Koanf) *models.AppConfig // 获取相关配置的函数
// 内部状态
mu sync.RWMutex // 监听器状态锁
@@ -47,18 +47,18 @@ type ConfigListener struct {
type ConfigNotificationService struct {
listeners sync.Map // 使用sync.Map替代普通map+锁
logger *log.LoggerService // 日志服务
viper *viper.Viper // Viper实例
koanf *koanf.Koanf // koanf实例
ctx context.Context
cancel context.CancelFunc
wg sync.WaitGroup
}
// NewConfigNotificationService 创建配置通知服务
func NewConfigNotificationService(viper *viper.Viper, logger *log.LoggerService) *ConfigNotificationService {
func NewConfigNotificationService(k *koanf.Koanf, logger *log.LoggerService) *ConfigNotificationService {
ctx, cancel := context.WithCancel(context.Background())
return &ConfigNotificationService{
logger: logger,
viper: viper,
koanf: k,
ctx: ctx,
cancel: cancel,
}
@@ -90,7 +90,7 @@ func (cns *ConfigNotificationService) initializeListenerState(listener *ConfigLi
return fmt.Errorf("GetConfigFunc is required")
}
if config := listener.GetConfigFunc(cns.viper); config != nil {
if config := listener.GetConfigFunc(cns.koanf); config != nil {
listener.mu.Lock()
listener.lastConfig = deepCopyConfig(config)
listener.lastConfigHash = computeConfigHash(config)
@@ -125,7 +125,7 @@ func (cns *ConfigNotificationService) checkAndNotify(listener *ConfigListener) {
return
}
currentConfig := listener.GetConfigFunc(cns.viper)
currentConfig := listener.GetConfigFunc(cns.koanf)
listener.mu.RLock()
lastHash := listener.lastConfigHash
@@ -268,9 +268,9 @@ func CreateHotkeyListener(callback func(enable bool, hotkey *models.HotkeyCombo)
return callback(defaultConfig.General.EnableGlobalHotkey, &defaultConfig.General.GlobalHotkey)
},
DebounceDelay: 200 * time.Millisecond,
GetConfigFunc: func(v *viper.Viper) *models.AppConfig {
GetConfigFunc: func(k *koanf.Koanf) *models.AppConfig {
var config models.AppConfig
if err := v.Unmarshal(&config); err != nil {
if err := k.Unmarshal("", &config); err != nil {
return nil
}
return &config
@@ -303,9 +303,9 @@ func CreateDataPathListener(callback func(oldPath, newPath string) error) *Confi
return nil
},
DebounceDelay: 100 * time.Millisecond,
GetConfigFunc: func(v *viper.Viper) *models.AppConfig {
GetConfigFunc: func(k *koanf.Koanf) *models.AppConfig {
var config models.AppConfig
if err := v.Unmarshal(&config); err != nil {
if err := k.Unmarshal("", &config); err != nil {
return nil
}
return &config

240
internal/services/config_service.go
View File

@@ -1,7 +1,6 @@
package services
import (
"encoding/json"
"errors"
"fmt"
"os"
@@ -9,17 +8,20 @@ import (
"time"
"voidraft/internal/models"
"github.com/fsnotify/fsnotify"
"github.com/spf13/viper"
jsonparser "github.com/knadh/koanf/parsers/json"
"github.com/knadh/koanf/providers/file"
"github.com/knadh/koanf/providers/structs"
"github.com/knadh/koanf/v2"
"github.com/wailsapp/wails/v3/pkg/services/log"
)
// ConfigService 提供基于 Viper 的配置管理功能
// ConfigService 应用配置服务
type ConfigService struct {
viper *viper.Viper // Viper 实例
logger *log.LoggerService // 日志服务
pathManager *PathManager // 路径管理器
mu sync.RWMutex // 读写锁
koanf *koanf.Koanf // koanf 实例
logger *log.LoggerService // 日志服务
pathManager *PathManager // 路径管理器
mu sync.RWMutex // 读写锁
fileProvider *file.File // 文件提供器，用于监听
// 配置通知服务
notificationService *ConfigNotificationService
@@ -60,34 +62,22 @@ func NewConfigService(logger *log.LoggerService, pathManager *PathManager) *Conf
pathManager = NewPathManager()
}
// 创建 Viper 实例
v := viper.New()
// 配置 Viper
v.SetConfigName(pathManager.GetConfigName())
v.SetConfigType("json")
v.AddConfigPath(pathManager.GetConfigDir())
// 设置环境变量前缀
v.SetEnvPrefix("VOIDRAFT")
v.AutomaticEnv()
// 设置默认值
setDefaults(v)
// 使用"."作为键路径分隔符
k := koanf.New(".")
// 构造配置服务实例
service := &ConfigService{
viper: v,
koanf: k,
logger: logger,
pathManager: pathManager,
}
// 初始化配置通知服务
service.notificationService = NewConfigNotificationService(v, logger)
service.notificationService = NewConfigNotificationService(k, logger)
// 初始化配置
if err := service.initConfig(); err != nil {
service.logger.Error("Failed to initialize config", "error", err)
panic(err)
}
// 启动配置文件监听
@@ -96,37 +86,15 @@ func NewConfigService(logger *log.LoggerService, pathManager *PathManager) *Conf
return service
}
// setDefaults 设置默认配置值
func setDefaults(v *viper.Viper) {
// setDefaults 设置默认配置
func (cs *ConfigService) setDefaults() error {
defaultConfig := models.NewDefaultAppConfig()
// 通用设置默认值
v.SetDefault("general.alwaysOnTop", defaultConfig.General.AlwaysOnTop)
v.SetDefault("general.dataPath", defaultConfig.General.DataPath)
v.SetDefault("general.enableSystemTray", defaultConfig.General.EnableSystemTray)
v.SetDefault("general.enableGlobalHotkey", defaultConfig.General.EnableGlobalHotkey)
v.SetDefault("general.globalHotkey.ctrl", defaultConfig.General.GlobalHotkey.Ctrl)
v.SetDefault("general.globalHotkey.shift", defaultConfig.General.GlobalHotkey.Shift)
v.SetDefault("general.globalHotkey.alt", defaultConfig.General.GlobalHotkey.Alt)
v.SetDefault("general.globalHotkey.win", defaultConfig.General.GlobalHotkey.Win)
v.SetDefault("general.globalHotkey.key", defaultConfig.General.GlobalHotkey.Key)
if err := cs.koanf.Load(structs.Provider(defaultConfig, "json"), nil); err != nil {
return &ConfigError{Operation: "load_defaults", Err: err}
}
// 编辑设置默认值
v.SetDefault("editing.fontSize", defaultConfig.Editing.FontSize)
v.SetDefault("editing.fontFamily", defaultConfig.Editing.FontFamily)
v.SetDefault("editing.fontWeight", defaultConfig.Editing.FontWeight)
v.SetDefault("editing.lineHeight", defaultConfig.Editing.LineHeight)
v.SetDefault("editing.enableTabIndent", defaultConfig.Editing.EnableTabIndent)
v.SetDefault("editing.tabSize", defaultConfig.Editing.TabSize)
v.SetDefault("editing.tabType", defaultConfig.Editing.TabType)
v.SetDefault("editing.autoSaveDelay", defaultConfig.Editing.AutoSaveDelay)
// 外观设置默认值
v.SetDefault("appearance.language", defaultConfig.Appearance.Language)
v.SetDefault("appearance.systemTheme", defaultConfig.Appearance.SystemTheme)
// 元数据默认值
v.SetDefault("metadata.lastUpdated", defaultConfig.Metadata.LastUpdated)
return nil
}
// initConfig 初始化配置
@@ -134,15 +102,16 @@ func (cs *ConfigService) initConfig() error {
cs.mu.Lock()
defer cs.mu.Unlock()
// 尝试读取配置文件
if err := cs.viper.ReadInConfig(); err != nil {
var configFileNotFoundError viper.ConfigFileNotFoundError
if errors.As(err, &configFileNotFoundError) {
// 配置文件不存在，创建默认配置文件
return cs.createDefaultConfig()
}
// 配置文件存在但读取失败
return &ConfigError{Operation: "read_config", Err: err}
// 检查配置文件是否存在
configPath := cs.pathManager.GetSettingsPath()
if _, err := os.Stat(configPath); os.IsNotExist(err) {
return cs.createDefaultConfig()
}
// 配置文件存在，直接加载
cs.fileProvider = file.Provider(configPath)
if err := cs.koanf.Load(cs.fileProvider, jsonparser.Parser()); err != nil {
return &ConfigError{Operation: "load_config_file", Err: err}
}
return nil
@@ -155,38 +124,50 @@ func (cs *ConfigService) createDefaultConfig() error {
return &ConfigError{Operation: "create_config_dir", Err: err}
}
// 获取默认配置
defaultConfig := models.NewDefaultAppConfig()
// 使用 JSON marshal 方式设置完整的默认配置
configBytes, err := json.MarshalIndent(defaultConfig, "", " ")
if err != nil {
return &ConfigError{Operation: "marshal_default_config", Err: err}
if err := cs.setDefaults(); err != nil {
return err
}
// 写入配置文件
if err := os.WriteFile(cs.pathManager.GetSettingsPath(), configBytes, 0644); err != nil {
return &ConfigError{Operation: "write_default_config", Err: err}
if err := cs.writeConfigToFile(); err != nil {
return err
}
// 重新读取配置文件到viper
if err := cs.viper.ReadInConfig(); err != nil {
return &ConfigError{Operation: "read_created_config", Err: err}
}
// 创建文件提供器
cs.fileProvider = file.Provider(cs.pathManager.GetSettingsPath())
if err := cs.koanf.Load(cs.fileProvider, jsonparser.Parser()); err != nil {
return &ConfigError{Operation: "load_config_file", Err: err}
}
return nil
}
// startWatching 启动配置文件监听
func (cs *ConfigService) startWatching() {
// 设置配置变化回调
cs.viper.OnConfigChange(func(e fsnotify.Event) {
if cs.fileProvider == nil {
return
}
err := cs.fileProvider.Watch(func(event interface{}, err error) {
if err != nil {
return
}
cs.koanf.Load(cs.fileProvider, jsonparser.Parser())
// 使用配置通知服务检查所有已注册的配置变更
cs.notificationService.CheckConfigChanges()
if cs.notificationService != nil {
cs.notificationService.CheckConfigChanges()
}
})
// 启动配置文件监听
cs.viper.WatchConfig()
if err != nil {
cs.logger.Error("Failed to setup config file watcher", "error", err)
}
}
// stopWatching 停止配置文件监听
func (cs *ConfigService) stopWatching() {
if cs.fileProvider != nil {
cs.fileProvider.Unwatch()
}
}
// GetConfig 获取完整应用配置
@@ -195,7 +176,7 @@ func (cs *ConfigService) GetConfig() (*models.AppConfig, error) {
defer cs.mu.RUnlock()
var config models.AppConfig
if err := cs.viper.Unmarshal(&config); err != nil {
if err := cs.koanf.Unmarshal("", &config); err != nil {
return nil, &ConfigError{Operation: "unmarshal_config", Err: err}
}
@@ -207,70 +188,80 @@ func (cs *ConfigService) Set(key string, value interface{}) error {
cs.mu.Lock()
defer cs.mu.Unlock()
// 设置值到viper
cs.viper.Set(key, value)
// 直接从viper获取配置并构建AppConfig结构
var config models.AppConfig
if err := cs.viper.Unmarshal(&config); err != nil {
return &ConfigError{Operation: "unmarshal_config_for_set", Err: err}
}
// 设置值到koanf
cs.koanf.Set(key, value)
// 更新时间戳
config.Metadata.LastUpdated = time.Now().Format(time.RFC3339)
cs.koanf.Set("metadata.lastUpdated", time.Now().Format(time.RFC3339))
// 直接写入JSON文件
if err := cs.writeConfigToFile(&config); err != nil {
return &ConfigError{Operation: "set_config", Err: err}
}
return nil
// 将配置写回文件
return cs.writeConfigToFile()
}
// Get 获取配置项
func (cs *ConfigService) Get(key string) interface{} {
cs.mu.RLock()
defer cs.mu.RUnlock()
return cs.viper.Get(key)
return cs.koanf.Get(key)
}
// ResetConfig 强制重置所有配置为默认值
func (cs *ConfigService) ResetConfig() {
func (cs *ConfigService) ResetConfig() error {
cs.mu.Lock()
defer cs.mu.Unlock()
defaultConfig := models.NewDefaultAppConfig()
// 直接写入JSON文件
if err := cs.writeConfigToFile(defaultConfig); err != nil {
return
// 停止文件监听
if cs.fileProvider != nil {
cs.fileProvider.Unwatch()
cs.fileProvider = nil
}
// 重新读取配置文件到viper
if err := cs.viper.ReadInConfig(); err != nil {
return
// 设置默认配置
if err := cs.setDefaults(); err != nil {
return &ConfigError{Operation: "reset_set_defaults", Err: err}
}
// 写入配置文件
if err := cs.writeConfigToFile(); err != nil {
return &ConfigError{Operation: "reset_write_config", Err: err}
}
// 重新创建koanf实例
cs.koanf = koanf.New(".")
// 重新加载默认配置到koanf
if err := cs.setDefaults(); err != nil {
return &ConfigError{Operation: "reset_reload_defaults", Err: err}
}
// 重新创建文件提供器
cs.fileProvider = file.Provider(cs.pathManager.GetSettingsPath())
// 重新加载配置文件
if err := cs.koanf.Load(cs.fileProvider, jsonparser.Parser()); err != nil {
return &ConfigError{Operation: "reset_reload_config", Err: err}
}
// 重新启动文件监听
cs.startWatching()
// 手动触发配置变更检查，确保通知系统能感知到变更
cs.notificationService.CheckConfigChanges()
if cs.notificationService != nil {
cs.notificationService.CheckConfigChanges()
}
return nil
}
// writeConfigToFile 直接写入配置到JSON文件
func (cs *ConfigService) writeConfigToFile(config *models.AppConfig) error {
// 序列化为JSON
configBytes, err := json.MarshalIndent(config, "", " ")
// writeConfigToFile 将配置写回JSON文件
func (cs *ConfigService) writeConfigToFile() error {
configBytes, err := cs.koanf.Marshal(jsonparser.Parser())
if err != nil {
return fmt.Errorf("failed to marshal config: %v", err)
return &ConfigError{Operation: "marshal_config", Err: err}
}
// 写入文件
if err := os.WriteFile(cs.pathManager.GetSettingsPath(), configBytes, 0644); err != nil {
return fmt.Errorf("failed to write config file: %v", err)
}
// 重新读取到viper中
if err := cs.viper.ReadInConfig(); err != nil {
return fmt.Errorf("failed to reload config: %v", err)
return &ConfigError{Operation: "write_config_file", Err: err}
}
return nil
@@ -295,3 +286,12 @@ func (cs *ConfigService) SetDataPathChangeCallback(callback func(oldPath, newPat
dataPathListener := CreateDataPathListener(callback)
return cs.notificationService.RegisterListener(dataPathListener)
}
// ServiceShutdown 关闭服务
func (cs *ConfigService) ServiceShutdown() error {
cs.stopWatching()
if cs.notificationService != nil {
cs.notificationService.Cleanup()
}
return nil
}

83
internal/services/keybinding_service.go
View File

@@ -2,23 +2,25 @@ package services
import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
"sync"
"voidraft/internal/models"
"github.com/fsnotify/fsnotify"
"github.com/spf13/viper"
jsonparser "github.com/knadh/koanf/parsers/json"
"github.com/knadh/koanf/providers/file"
"github.com/knadh/koanf/providers/structs"
"github.com/knadh/koanf/v2"
"github.com/wailsapp/wails/v3/pkg/services/log"
)
// KeyBindingService 快捷键管理服务
type KeyBindingService struct {
viper *viper.Viper
logger *log.LoggerService
pathManager *PathManager
koanf *koanf.Koanf
logger *log.LoggerService
pathManager *PathManager
fileProvider *file.File
mu sync.RWMutex
ctx context.Context
@@ -60,16 +62,10 @@ func NewKeyBindingService(logger *log.LoggerService, pathManager *PathManager) *
ctx, cancel := context.WithCancel(context.Background())
// 创建并配置 Viper
v := viper.New()
v.SetConfigName(pathManager.GetKeybindsName())
v.SetConfigType("json")
v.AddConfigPath(pathManager.GetConfigDir())
v.SetEnvPrefix("VOIDRAFT_KEYBINDING")
v.AutomaticEnv()
k := koanf.New(".")
service := &KeyBindingService{
viper: v,
koanf: k,
logger: logger,
pathManager: pathManager,
ctx: ctx,
@@ -85,21 +81,21 @@ func NewKeyBindingService(logger *log.LoggerService, pathManager *PathManager) *
// initialize 初始化配置
func (kbs *KeyBindingService) initialize() {
kbs.initOnce.Do(func() {
kbs.setDefaults()
if err := kbs.initConfig(); err != nil {
kbs.logger.Error("failed to initialize keybinding config", "error", err)
}
kbs.startWatching()
})
}
// setDefaults 设置默认值
func (kbs *KeyBindingService) setDefaults() {
func (kbs *KeyBindingService) setDefaults() error {
defaultConfig := models.NewDefaultKeyBindingConfig()
kbs.viper.SetDefault("keyBindings", defaultConfig.KeyBindings)
kbs.viper.SetDefault("metadata.lastUpdated", defaultConfig.Metadata.LastUpdated)
if err := kbs.koanf.Load(structs.Provider(defaultConfig, "json"), nil); err != nil {
return &KeyBindingError{"load_defaults", "", err}
}
return nil
}
// initConfig 初始化配置
@@ -107,13 +103,18 @@ func (kbs *KeyBindingService) initConfig() error {
kbs.mu.Lock()
defer kbs.mu.Unlock()
if err := kbs.viper.ReadInConfig(); err != nil {
var configFileNotFoundError viper.ConfigFileNotFoundError
if errors.As(err, &configFileNotFoundError) {
return kbs.createDefaultConfig()
}
return &KeyBindingError{"read_config", "", err}
// 检查配置文件是否存在
configPath := kbs.pathManager.GetKeybindsPath()
if _, err := os.Stat(configPath); os.IsNotExist(err) {
return kbs.createDefaultConfig()
}
// 配置文件存在，直接加载
kbs.fileProvider = file.Provider(configPath)
if err := kbs.koanf.Load(kbs.fileProvider, jsonparser.Parser()); err != nil {
return &KeyBindingError{"load_config_file", "", err}
}
return nil
}
@@ -123,8 +124,11 @@ func (kbs *KeyBindingService) createDefaultConfig() error {
return &KeyBindingError{"create_config_dir", "", err}
}
defaultConfig := models.NewDefaultKeyBindingConfig()
configBytes, err := json.MarshalIndent(defaultConfig, "", " ")
if err := kbs.setDefaults(); err != nil {
return err
}
configBytes, err := kbs.koanf.Marshal(jsonparser.Parser())
if err != nil {
return &KeyBindingError{"marshal_config", "", err}
}
@@ -133,15 +137,12 @@ func (kbs *KeyBindingService) createDefaultConfig() error {
return &KeyBindingError{"write_config", "", err}
}
return kbs.viper.ReadInConfig()
}
// startWatching 启动配置文件监听
func (kbs *KeyBindingService) startWatching() {
kbs.viper.OnConfigChange(func(e fsnotify.Event) {
})
kbs.viper.WatchConfig()
// 创建文件提供器
kbs.fileProvider = file.Provider(kbs.pathManager.GetKeybindsPath())
if err = kbs.koanf.Load(kbs.fileProvider, jsonparser.Parser()); err != nil {
return err
}
return nil
}
// GetKeyBindingConfig 获取完整快捷键配置
@@ -150,7 +151,7 @@ func (kbs *KeyBindingService) GetKeyBindingConfig() (*models.KeyBindingConfig, e
defer kbs.mu.RUnlock()
var config models.KeyBindingConfig
if err := kbs.viper.Unmarshal(&config); err != nil {
if err := kbs.koanf.Unmarshal("", &config); err != nil {
return nil, &KeyBindingError{"unmarshal_config", "", err}
}
return &config, nil
@@ -165,8 +166,8 @@ func (kbs *KeyBindingService) GetAllKeyBindings() ([]models.KeyBinding, error) {
return config.KeyBindings, nil
}
// Shutdown 关闭服务
func (kbs *KeyBindingService) Shutdown() error {
// ServiceShutdown 关闭服务
func (kbs *KeyBindingService) ServiceShutdown() error {
kbs.cancel()
return nil
}

15
internal/services/path_manager.go
View File

@@ -31,11 +31,6 @@ func NewPathManager() *PathManager {
}
}
// GetConfigDir 获取配置目录路径
func (pm *PathManager) GetConfigDir() string {
return pm.configDir
}
// GetSettingsPath 获取设置文件路径
func (pm *PathManager) GetSettingsPath() string {
return pm.settingsPath
@@ -50,13 +45,3 @@ func (pm *PathManager) GetKeybindsPath() string {
func (pm *PathManager) EnsureConfigDir() error {
return os.MkdirAll(pm.configDir, 0755)
}
// GetConfigName 获取配置文件
func (pm *PathManager) GetConfigName() string {
return "settings"
}
// GetKeybindsName 获取快捷键配置文件名
func (pm *PathManager) GetKeybindsName() string {
return "keybindings"
}

0
internal/services/migration_service.go → internal/services/path_migration_service.go
View File