refactor: standardize code comments

This commit is contained in:
tinkle-community
2025-12-08 01:40:48 +08:00
parent 0636ced476
commit a12c0ae8c9
103 changed files with 5466 additions and 5468 deletions
+3 -3
View File
@@ -1,11 +1,11 @@
package logger
// Config 日志配置(简化版)
// Config is the logger configuration (simplified version)
type Config struct {
Level string `json:"level"` // 日志级别: debug, info, warn, error (默认: info)
Level string `json:"level"` // Log level: debug, info, warn, error (default: info)
}
// SetDefaults 设置默认值
// SetDefaults sets default values
func (c *Config) SetDefaults() {
if c.Level == "" {
c.Level = "info"
+22 -22
View File
@@ -7,12 +7,12 @@ import (
)
var (
// Log 全局logger实例
// Log is the global logger instance
Log *logrus.Logger
)
func init() {
// 自动初始化默认 logger,确保在 Init 被调用前也能使用
// Auto-initialize default logger to ensure it works before Init is called
Log = logrus.New()
Log.SetLevel(logrus.InfoLevel)
Log.SetFormatter(&logrus.TextFormatter{
@@ -24,66 +24,66 @@ func init() {
}
// ============================================================================
// 初始化函数
// Initialization functions
// ============================================================================
// Init 初始化全局logger
// 如果config为nil,使用默认配置(console输出,info级别)
// Init initializes the global logger
// If config is nil, uses default configuration (console output, info level)
func Init(cfg *Config) error {
Log = logrus.New()
// 如果没有配置,使用默认值
// Use default values if no config provided
if cfg == nil {
cfg = &Config{Level: "info"}
}
// 设置默认值
// Set default values
cfg.SetDefaults()
// 设置日志级别
// Set log level
level, err := logrus.ParseLevel(cfg.Level)
if err != nil {
level = logrus.InfoLevel
}
Log.SetLevel(level)
// 设置格式化器(固定使用彩色文本格式)
// Set formatter (always use colored text format)
Log.SetFormatter(&logrus.TextFormatter{
FullTimestamp: true,
TimestampFormat: "2006-01-02 15:04:05",
ForceColors: true,
})
// 设置输出目标(默认stdout
// Set output target (default stdout)
Log.SetOutput(os.Stdout)
// 启用调用位置信息
// Enable caller location info
Log.SetReportCaller(true)
return nil
}
// InitWithSimpleConfig 使用简化配置初始化logger
// 适用于只需要基本功能的场景
// InitWithSimpleConfig initializes logger with simplified config
// Suitable for scenarios that only need basic functionality
func InitWithSimpleConfig(level string) error {
return Init(&Config{Level: level})
}
// Shutdown 优雅关闭logger
// Shutdown gracefully shuts down the logger
func Shutdown() {
// 预留用于未来扩展
// Reserved for future extensions
}
// ============================================================================
// 日志记录函数
// Logging functions
// ============================================================================
// WithFields 创建带字段的logger entry
// WithFields creates logger entry with fields
func WithFields(fields logrus.Fields) *logrus.Entry {
return Log.WithFields(fields)
}
// WithField 创建带单个字段的logger entry
// WithField creates logger entry with a single field
func WithField(key string, value interface{}) *logrus.Entry {
return Log.WithField(key, value)
}
@@ -138,14 +138,14 @@ func Panicf(format string, args ...interface{}) {
}
// ============================================================================
// MCP Logger 适配器
// MCP Logger adapter
// ============================================================================
// MCPLogger 适配器,使 MCP 包使用全局 logger
// 实现 mcp.Logger 接口
// MCPLogger adapter that allows MCP package to use the global logger
// Implements mcp.Logger interface
type MCPLogger struct{}
// NewMCPLogger 创建 MCP 日志适配器
// NewMCPLogger creates MCP log adapter
func NewMCPLogger() *MCPLogger {
return &MCPLogger{}
}