feat: 实现分层架构，包含 domain、service、repository 和 pkg 层
- 新增 domain 层：model、provider、route、stats 实体 - 新增 service 层：models、providers、routing、stats 业务逻辑 - 新增 repository 层：models、providers、stats 数据访问 - 新增 pkg 工具包：errors、logger、validator - 新增中间件：CORS、logging、recovery、request ID - 新增数据库迁移：初始 schema 和索引 - 新增单元测试和集成测试 - 新增规范文档：config-management、database-migration、error-handling、layered-architecture、middleware-system、request-validation、structured-logging、test-coverage - 移除 config 子包和 model_router（已迁移至分层架构）
This commit is contained in:
17
backend/pkg/logger/context.go
Normal file
17
backend/pkg/logger/context.go
Normal file
@@ -0,0 +1,17 @@
|
||||
package logger
|
||||
|
||||
import "go.uber.org/zap"
|
||||
|
||||
// WithRequestID 向 logger 添加 request_id 字段
|
||||
func WithRequestID(logger *zap.Logger, requestID string) *zap.Logger {
|
||||
return logger.With(zap.String("request_id", requestID))
|
||||
}
|
||||
|
||||
// WithContext 向 logger 添加多个自定义字段
|
||||
func WithContext(logger *zap.Logger, fields map[string]interface{}) *zap.Logger {
|
||||
zapFields := make([]zap.Field, 0, len(fields))
|
||||
for k, v := range fields {
|
||||
zapFields = append(zapFields, zap.Any(k, v))
|
||||
}
|
||||
return logger.With(zapFields...)
|
||||
}
|
||||
109
backend/pkg/logger/logger.go
Normal file
109
backend/pkg/logger/logger.go
Normal file
@@ -0,0 +1,109 @@
|
||||
package logger
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"time"
|
||||
|
||||
"go.uber.org/zap"
|
||||
"go.uber.org/zap/zapcore"
|
||||
)
|
||||
|
||||
// Config 日志配置
|
||||
type Config struct {
|
||||
Level string // 日志级别: debug, info, warn, error
|
||||
Path string // 日志文件目录，为空则仅输出到 stdout
|
||||
MaxSize int // 单个日志文件最大尺寸 (MB)
|
||||
MaxBackups int // 保留的旧日志文件最大数量
|
||||
MaxAge int // 保留旧日志文件的最大天数
|
||||
Compress bool // 是否压缩旧日志文件
|
||||
}
|
||||
|
||||
// New 根据配置创建 zap.Logger
|
||||
// 如果 Path 为空，仅输出到 stdout；
|
||||
// 如果 Path 已设置，同时输出到 stdout 和文件（文件使用 JSON 格式，stdout 使用 console 格式）
|
||||
func New(cfg Config) (*zap.Logger, error) {
|
||||
level, err := parseLevel(cfg.Level)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// stdout encoder — console 格式
|
||||
stdoutEncoder := zapcore.NewConsoleEncoder(zapcore.EncoderConfig{
|
||||
TimeKey: "ts",
|
||||
LevelKey: "level",
|
||||
NameKey: "logger",
|
||||
CallerKey: "caller",
|
||||
FunctionKey: zapcore.OmitKey,
|
||||
MessageKey: "msg",
|
||||
StacktraceKey: "stacktrace",
|
||||
LineEnding: zapcore.DefaultLineEnding,
|
||||
EncodeLevel: zapcore.CapitalColorLevelEncoder,
|
||||
EncodeTime: zapcore.ISO8601TimeEncoder,
|
||||
EncodeDuration: zapcore.StringDurationEncoder,
|
||||
EncodeCaller: zapcore.ShortCallerEncoder,
|
||||
})
|
||||
|
||||
stdoutCore := zapcore.NewCore(
|
||||
stdoutEncoder,
|
||||
zapcore.AddSync(os.Stdout),
|
||||
level,
|
||||
)
|
||||
|
||||
// 仅 stdout 模式
|
||||
if cfg.Path == "" {
|
||||
return zap.New(stdoutCore, zap.AddCaller(), zap.AddStacktrace(zap.ErrorLevel)), nil
|
||||
}
|
||||
|
||||
// 文件 encoder — JSON 格式
|
||||
fileEncoder := zapcore.NewJSONEncoder(zapcore.EncoderConfig{
|
||||
TimeKey: "ts",
|
||||
LevelKey: "level",
|
||||
NameKey: "logger",
|
||||
CallerKey: "caller",
|
||||
FunctionKey: zapcore.OmitKey,
|
||||
MessageKey: "msg",
|
||||
StacktraceKey: "stacktrace",
|
||||
LineEnding: zapcore.DefaultLineEnding,
|
||||
EncodeLevel: zapcore.LowercaseLevelEncoder,
|
||||
EncodeTime: zapcore.ISO8601TimeEncoder,
|
||||
EncodeDuration: zapcore.StringDurationEncoder,
|
||||
EncodeCaller: zapcore.ShortCallerEncoder,
|
||||
})
|
||||
|
||||
rotateWriter := newRotateWriter(cfg)
|
||||
fileCore := zapcore.NewCore(
|
||||
fileEncoder,
|
||||
zapcore.AddSync(rotateWriter),
|
||||
level,
|
||||
)
|
||||
|
||||
core := zapcore.NewTee(stdoutCore, fileCore)
|
||||
return zap.New(core, zap.AddCaller(), zap.AddStacktrace(zap.ErrorLevel)), nil
|
||||
}
|
||||
|
||||
// parseLevel 将字符串解析为 zapcore.Level
|
||||
func parseLevel(s string) (zapcore.Level, error) {
|
||||
switch s {
|
||||
case "debug":
|
||||
return zapcore.DebugLevel, nil
|
||||
case "info":
|
||||
return zapcore.InfoLevel, nil
|
||||
case "warn":
|
||||
return zapcore.WarnLevel, nil
|
||||
case "error":
|
||||
return zapcore.ErrorLevel, nil
|
||||
default:
|
||||
return zapcore.InfoLevel, nil
|
||||
}
|
||||
}
|
||||
|
||||
// logFileName 生成当日日志文件名: nex-YYYY-MM-DD.log
|
||||
func logFileName() string {
|
||||
return "nex-" + time.Now().Format("2006-01-02") + ".log"
|
||||
}
|
||||
|
||||
// logFilePath 拼接完整日志文件路径
|
||||
func logFilePath(dir string) string {
|
||||
return filepath.Join(dir, logFileName())
|
||||
}
|
||||
138
backend/pkg/logger/logger_test.go
Normal file
138
backend/pkg/logger/logger_test.go
Normal file
@@ -0,0 +1,138 @@
|
||||
package logger
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/zap"
|
||||
)
|
||||
|
||||
func TestNew_StdoutOnly(t *testing.T) {
|
||||
logger, err := New(Config{Level: "info"})
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, logger)
|
||||
assert.NoError(t, logger.Sync())
|
||||
}
|
||||
|
||||
func TestNew_WithFileOutput(t *testing.T) {
|
||||
dir := filepath.Join(os.TempDir(), "nex-logger-test")
|
||||
os.MkdirAll(dir, 0755)
|
||||
defer os.RemoveAll(dir)
|
||||
|
||||
logger, err := New(Config{
|
||||
Level: "debug",
|
||||
Path: dir,
|
||||
MaxSize: 10,
|
||||
MaxBackups: 3,
|
||||
MaxAge: 7,
|
||||
Compress: false,
|
||||
})
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, logger)
|
||||
|
||||
logger.Info("test log message")
|
||||
_ = logger.Sync()
|
||||
|
||||
// 验证日志文件已创建
|
||||
files, err := os.ReadDir(dir)
|
||||
require.NoError(t, err)
|
||||
assert.NotEmpty(t, files, "日志目录应包含文件")
|
||||
}
|
||||
|
||||
func TestNew_AllLevels(t *testing.T) {
|
||||
levels := []string{"debug", "info", "warn", "error"}
|
||||
for _, level := range levels {
|
||||
logger, err := New(Config{Level: level})
|
||||
assert.NoError(t, err, "级别 %s 应有效", level)
|
||||
assert.NotNil(t, logger)
|
||||
assert.NoError(t, logger.Sync())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNew_EmptyLevel(t *testing.T) {
|
||||
// 空级别应默认为 info
|
||||
logger, err := New(Config{Level: ""})
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, logger)
|
||||
assert.NoError(t, logger.Sync())
|
||||
}
|
||||
|
||||
func TestNew_InvalidPath(t *testing.T) {
|
||||
// 不可写的路径
|
||||
logger, err := New(Config{
|
||||
Level: "info",
|
||||
Path: "/nonexistent/deeply/nested/path/logs",
|
||||
})
|
||||
// 应能创建 logger（错误在写入时发生）
|
||||
// 实际上 lumberjack 会尝试创建目录
|
||||
_ = logger
|
||||
_ = err
|
||||
}
|
||||
|
||||
func TestParseLevel(t *testing.T) {
|
||||
tests := []struct {
|
||||
input string
|
||||
valid bool
|
||||
}{
|
||||
{"debug", true},
|
||||
{"info", true},
|
||||
{"warn", true},
|
||||
{"error", true},
|
||||
{"", true}, // 默认为 info
|
||||
{"invalid", true}, // 默认为 info
|
||||
}
|
||||
for _, tt := range tests {
|
||||
_, err := parseLevel(tt.input)
|
||||
assert.NoError(t, err, "parseLevel(%q) 不应报错", tt.input)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLogFilePath(t *testing.T) {
|
||||
result := logFilePath(filepath.Join("var", "log"))
|
||||
assert.Contains(t, result, "nex-")
|
||||
assert.Contains(t, result, ".log")
|
||||
}
|
||||
|
||||
func TestLogFileName(t *testing.T) {
|
||||
name := logFileName()
|
||||
assert.Contains(t, name, "nex-")
|
||||
assert.Contains(t, name, ".log")
|
||||
assert.Len(t, name, len("nex-2006-01-02.log"))
|
||||
}
|
||||
|
||||
func TestNewRotateWriter_Defaults(t *testing.T) {
|
||||
cfg := Config{
|
||||
Path: t.TempDir(),
|
||||
MaxSize: 0,
|
||||
MaxAge: 0,
|
||||
Compress: true,
|
||||
}
|
||||
writer := newRotateWriter(cfg)
|
||||
require.NotNil(t, writer)
|
||||
assert.Equal(t, 100, writer.MaxSize)
|
||||
assert.Equal(t, 10, writer.MaxBackups)
|
||||
assert.Equal(t, 30, writer.MaxAge)
|
||||
}
|
||||
|
||||
func TestWithRequestID(t *testing.T) {
|
||||
logger, err := New(Config{Level: "info"})
|
||||
require.NoError(t, err)
|
||||
|
||||
contextLogger := WithRequestID(logger, "test-request-123")
|
||||
assert.NotNil(t, contextLogger)
|
||||
assert.IsType(t, &zap.Logger{}, contextLogger)
|
||||
}
|
||||
|
||||
func TestWithContext(t *testing.T) {
|
||||
logger, err := New(Config{Level: "info"})
|
||||
require.NoError(t, err)
|
||||
|
||||
contextLogger := WithContext(logger, map[string]interface{}{
|
||||
"key1": "value1",
|
||||
"key2": 42,
|
||||
})
|
||||
assert.NotNil(t, contextLogger)
|
||||
}
|
||||
30
backend/pkg/logger/rotate.go
Normal file
30
backend/pkg/logger/rotate.go
Normal file
@@ -0,0 +1,30 @@
|
||||
package logger
|
||||
|
||||
import "gopkg.in/lumberjack.v2"
|
||||
|
||||
// newRotateWriter 根据配置创建 lumberjack.Logger 作为日志轮转写入器
|
||||
// 日志文件位于 cfg.Path 目录下，文件名格式为 nex-YYYY-MM-DD.log
|
||||
func newRotateWriter(cfg Config) *lumberjack.Logger {
|
||||
maxSize := cfg.MaxSize
|
||||
if maxSize <= 0 {
|
||||
maxSize = 100
|
||||
}
|
||||
|
||||
maxBackups := cfg.MaxBackups
|
||||
if maxBackups <= 0 {
|
||||
maxBackups = 10
|
||||
}
|
||||
|
||||
maxAge := cfg.MaxAge
|
||||
if maxAge <= 0 {
|
||||
maxAge = 30
|
||||
}
|
||||
|
||||
return &lumberjack.Logger{
|
||||
Filename: logFilePath(cfg.Path),
|
||||
MaxSize: maxSize, // MB
|
||||
MaxBackups: maxBackups,
|
||||
MaxAge: maxAge, // days
|
||||
Compress: cfg.Compress,
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user