feat: disk request body cache (#2780)
* feat: 引入通用 HTTP BodyStorage/DiskCache 缓存配置与管理 - 新增 common/body_storage.go 提供 HTTP 请求体存储抽象和文件缓存能力 - 增加 common/disk_cache_config.go 支持全局磁盘缓存配置 - main.go 挂载缓存初始化流程 - 新增和补充 controller/performance.go (及 unix/windows) 用于缓存性能监控接口 - middleware/body_cleanup.go 自动清理缓存文件 - router 挂载相关接口 - 前端 settings 页面新增性能监控设置 PerformanceSetting - 优化缓存开关状态和模块热插拔能力 - 其他相关文件同步适配缓存扩展 * fix: 修复 BodyStorage 并发安全和错误处理问题 - 修复 diskStorage.Close() 竞态条件,先获取锁再执行 CAS - 为 memoryStorage 添加互斥锁和 closed 状态检查 - 修复 CreateBodyStorageFromReader 在磁盘存储失败时的回退逻辑 - 添加缓存命中统计调用 (IncrementDiskCacheHits/IncrementMemoryCacheHits) - 修复 gin.go 中 Seek 错误被忽略的问题 - 在 api-router 添加 BodyStorageCleanup 中间件 - 修复前端 formatBytes 对异常值的处理 Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -0,0 +1,365 @@
|
||||
package common
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"github.com/google/uuid"
|
||||
)
|
||||
|
||||
// BodyStorage 请求体存储接口
|
||||
type BodyStorage interface {
|
||||
io.ReadSeeker
|
||||
io.Closer
|
||||
// Bytes 获取全部内容
|
||||
Bytes() ([]byte, error)
|
||||
// Size 获取数据大小
|
||||
Size() int64
|
||||
// IsDisk 是否是磁盘存储
|
||||
IsDisk() bool
|
||||
}
|
||||
|
||||
// ErrStorageClosed 存储已关闭错误
|
||||
var ErrStorageClosed = fmt.Errorf("body storage is closed")
|
||||
|
||||
// memoryStorage 内存存储实现
|
||||
type memoryStorage struct {
|
||||
data []byte
|
||||
reader *bytes.Reader
|
||||
size int64
|
||||
closed int32
|
||||
mu sync.Mutex
|
||||
}
|
||||
|
||||
func newMemoryStorage(data []byte) *memoryStorage {
|
||||
size := int64(len(data))
|
||||
IncrementMemoryBuffers(size)
|
||||
return &memoryStorage{
|
||||
data: data,
|
||||
reader: bytes.NewReader(data),
|
||||
size: size,
|
||||
}
|
||||
}
|
||||
|
||||
func (m *memoryStorage) Read(p []byte) (n int, err error) {
|
||||
m.mu.Lock()
|
||||
defer m.mu.Unlock()
|
||||
if atomic.LoadInt32(&m.closed) == 1 {
|
||||
return 0, ErrStorageClosed
|
||||
}
|
||||
return m.reader.Read(p)
|
||||
}
|
||||
|
||||
func (m *memoryStorage) Seek(offset int64, whence int) (int64, error) {
|
||||
m.mu.Lock()
|
||||
defer m.mu.Unlock()
|
||||
if atomic.LoadInt32(&m.closed) == 1 {
|
||||
return 0, ErrStorageClosed
|
||||
}
|
||||
return m.reader.Seek(offset, whence)
|
||||
}
|
||||
|
||||
func (m *memoryStorage) Close() error {
|
||||
m.mu.Lock()
|
||||
defer m.mu.Unlock()
|
||||
if atomic.CompareAndSwapInt32(&m.closed, 0, 1) {
|
||||
DecrementMemoryBuffers(m.size)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *memoryStorage) Bytes() ([]byte, error) {
|
||||
m.mu.Lock()
|
||||
defer m.mu.Unlock()
|
||||
if atomic.LoadInt32(&m.closed) == 1 {
|
||||
return nil, ErrStorageClosed
|
||||
}
|
||||
return m.data, nil
|
||||
}
|
||||
|
||||
func (m *memoryStorage) Size() int64 {
|
||||
return m.size
|
||||
}
|
||||
|
||||
func (m *memoryStorage) IsDisk() bool {
|
||||
return false
|
||||
}
|
||||
|
||||
// diskStorage 磁盘存储实现
|
||||
type diskStorage struct {
|
||||
file *os.File
|
||||
filePath string
|
||||
size int64
|
||||
closed int32
|
||||
mu sync.Mutex
|
||||
}
|
||||
|
||||
func newDiskStorage(data []byte, cachePath string) (*diskStorage, error) {
|
||||
// 确定缓存目录
|
||||
dir := cachePath
|
||||
if dir == "" {
|
||||
dir = os.TempDir()
|
||||
}
|
||||
dir = filepath.Join(dir, "new-api-body-cache")
|
||||
|
||||
// 确保目录存在
|
||||
if err := os.MkdirAll(dir, 0755); err != nil {
|
||||
return nil, fmt.Errorf("failed to create cache directory: %w", err)
|
||||
}
|
||||
|
||||
// 创建临时文件
|
||||
filename := fmt.Sprintf("body-%s-%d.tmp", uuid.New().String()[:8], time.Now().UnixNano())
|
||||
filePath := filepath.Join(dir, filename)
|
||||
|
||||
file, err := os.OpenFile(filePath, os.O_CREATE|os.O_RDWR|os.O_EXCL, 0600)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create temp file: %w", err)
|
||||
}
|
||||
|
||||
// 写入数据
|
||||
n, err := file.Write(data)
|
||||
if err != nil {
|
||||
file.Close()
|
||||
os.Remove(filePath)
|
||||
return nil, fmt.Errorf("failed to write to temp file: %w", err)
|
||||
}
|
||||
|
||||
// 重置文件指针
|
||||
if _, err := file.Seek(0, io.SeekStart); err != nil {
|
||||
file.Close()
|
||||
os.Remove(filePath)
|
||||
return nil, fmt.Errorf("failed to seek temp file: %w", err)
|
||||
}
|
||||
|
||||
size := int64(n)
|
||||
IncrementDiskFiles(size)
|
||||
|
||||
return &diskStorage{
|
||||
file: file,
|
||||
filePath: filePath,
|
||||
size: size,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func newDiskStorageFromReader(reader io.Reader, maxBytes int64, cachePath string) (*diskStorage, error) {
|
||||
// 确定缓存目录
|
||||
dir := cachePath
|
||||
if dir == "" {
|
||||
dir = os.TempDir()
|
||||
}
|
||||
dir = filepath.Join(dir, "new-api-body-cache")
|
||||
|
||||
// 确保目录存在
|
||||
if err := os.MkdirAll(dir, 0755); err != nil {
|
||||
return nil, fmt.Errorf("failed to create cache directory: %w", err)
|
||||
}
|
||||
|
||||
// 创建临时文件
|
||||
filename := fmt.Sprintf("body-%s-%d.tmp", uuid.New().String()[:8], time.Now().UnixNano())
|
||||
filePath := filepath.Join(dir, filename)
|
||||
|
||||
file, err := os.OpenFile(filePath, os.O_CREATE|os.O_RDWR|os.O_EXCL, 0600)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create temp file: %w", err)
|
||||
}
|
||||
|
||||
// 从 reader 读取并写入文件
|
||||
written, err := io.Copy(file, io.LimitReader(reader, maxBytes+1))
|
||||
if err != nil {
|
||||
file.Close()
|
||||
os.Remove(filePath)
|
||||
return nil, fmt.Errorf("failed to write to temp file: %w", err)
|
||||
}
|
||||
|
||||
if written > maxBytes {
|
||||
file.Close()
|
||||
os.Remove(filePath)
|
||||
return nil, ErrRequestBodyTooLarge
|
||||
}
|
||||
|
||||
// 重置文件指针
|
||||
if _, err := file.Seek(0, io.SeekStart); err != nil {
|
||||
file.Close()
|
||||
os.Remove(filePath)
|
||||
return nil, fmt.Errorf("failed to seek temp file: %w", err)
|
||||
}
|
||||
|
||||
IncrementDiskFiles(written)
|
||||
|
||||
return &diskStorage{
|
||||
file: file,
|
||||
filePath: filePath,
|
||||
size: written,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (d *diskStorage) Read(p []byte) (n int, err error) {
|
||||
d.mu.Lock()
|
||||
defer d.mu.Unlock()
|
||||
if atomic.LoadInt32(&d.closed) == 1 {
|
||||
return 0, ErrStorageClosed
|
||||
}
|
||||
return d.file.Read(p)
|
||||
}
|
||||
|
||||
func (d *diskStorage) Seek(offset int64, whence int) (int64, error) {
|
||||
d.mu.Lock()
|
||||
defer d.mu.Unlock()
|
||||
if atomic.LoadInt32(&d.closed) == 1 {
|
||||
return 0, ErrStorageClosed
|
||||
}
|
||||
return d.file.Seek(offset, whence)
|
||||
}
|
||||
|
||||
func (d *diskStorage) Close() error {
|
||||
d.mu.Lock()
|
||||
defer d.mu.Unlock()
|
||||
if atomic.CompareAndSwapInt32(&d.closed, 0, 1) {
|
||||
d.file.Close()
|
||||
os.Remove(d.filePath)
|
||||
DecrementDiskFiles(d.size)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (d *diskStorage) Bytes() ([]byte, error) {
|
||||
d.mu.Lock()
|
||||
defer d.mu.Unlock()
|
||||
|
||||
if atomic.LoadInt32(&d.closed) == 1 {
|
||||
return nil, ErrStorageClosed
|
||||
}
|
||||
|
||||
// 保存当前位置
|
||||
currentPos, err := d.file.Seek(0, io.SeekCurrent)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// 移动到开头
|
||||
if _, err := d.file.Seek(0, io.SeekStart); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// 读取全部内容
|
||||
data := make([]byte, d.size)
|
||||
_, err = io.ReadFull(d.file, data)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// 恢复位置
|
||||
if _, err := d.file.Seek(currentPos, io.SeekStart); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return data, nil
|
||||
}
|
||||
|
||||
func (d *diskStorage) Size() int64 {
|
||||
return d.size
|
||||
}
|
||||
|
||||
func (d *diskStorage) IsDisk() bool {
|
||||
return true
|
||||
}
|
||||
|
||||
// CreateBodyStorage 根据数据大小创建合适的存储
|
||||
func CreateBodyStorage(data []byte) (BodyStorage, error) {
|
||||
size := int64(len(data))
|
||||
threshold := GetDiskCacheThresholdBytes()
|
||||
|
||||
// 检查是否应该使用磁盘缓存
|
||||
if IsDiskCacheEnabled() &&
|
||||
size >= threshold &&
|
||||
IsDiskCacheAvailable(size) {
|
||||
storage, err := newDiskStorage(data, GetDiskCachePath())
|
||||
if err != nil {
|
||||
// 如果磁盘存储失败,回退到内存存储
|
||||
SysError(fmt.Sprintf("failed to create disk storage, falling back to memory: %v", err))
|
||||
return newMemoryStorage(data), nil
|
||||
}
|
||||
return storage, nil
|
||||
}
|
||||
|
||||
return newMemoryStorage(data), nil
|
||||
}
|
||||
|
||||
// CreateBodyStorageFromReader 从 Reader 创建存储(用于大请求的流式处理)
|
||||
func CreateBodyStorageFromReader(reader io.Reader, contentLength int64, maxBytes int64) (BodyStorage, error) {
|
||||
threshold := GetDiskCacheThresholdBytes()
|
||||
|
||||
// 如果启用了磁盘缓存且内容长度超过阈值,直接使用磁盘存储
|
||||
if IsDiskCacheEnabled() &&
|
||||
contentLength > 0 &&
|
||||
contentLength >= threshold &&
|
||||
IsDiskCacheAvailable(contentLength) {
|
||||
storage, err := newDiskStorageFromReader(reader, maxBytes, GetDiskCachePath())
|
||||
if err != nil {
|
||||
if IsRequestBodyTooLargeError(err) {
|
||||
return nil, err
|
||||
}
|
||||
// 磁盘存储失败,reader 已被消费,无法安全回退
|
||||
// 直接返回错误而非尝试回退(因为 reader 数据已丢失)
|
||||
return nil, fmt.Errorf("disk storage creation failed: %w", err)
|
||||
}
|
||||
IncrementDiskCacheHits()
|
||||
return storage, nil
|
||||
}
|
||||
|
||||
// 使用内存读取
|
||||
data, err := io.ReadAll(io.LimitReader(reader, maxBytes+1))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if int64(len(data)) > maxBytes {
|
||||
return nil, ErrRequestBodyTooLarge
|
||||
}
|
||||
|
||||
storage, err := CreateBodyStorage(data)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// 如果最终使用内存存储,记录内存缓存命中
|
||||
if !storage.IsDisk() {
|
||||
IncrementMemoryCacheHits()
|
||||
} else {
|
||||
IncrementDiskCacheHits()
|
||||
}
|
||||
return storage, nil
|
||||
}
|
||||
|
||||
// CleanupOldCacheFiles 清理旧的缓存文件(用于启动时清理残留)
|
||||
func CleanupOldCacheFiles() {
|
||||
cachePath := GetDiskCachePath()
|
||||
if cachePath == "" {
|
||||
cachePath = os.TempDir()
|
||||
}
|
||||
dir := filepath.Join(cachePath, "new-api-body-cache")
|
||||
|
||||
entries, err := os.ReadDir(dir)
|
||||
if err != nil {
|
||||
return // 目录不存在或无法读取
|
||||
}
|
||||
|
||||
now := time.Now()
|
||||
for _, entry := range entries {
|
||||
if entry.IsDir() {
|
||||
continue
|
||||
}
|
||||
info, err := entry.Info()
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
// 删除超过 5 分钟的旧文件
|
||||
if now.Sub(info.ModTime()) > 5*time.Minute {
|
||||
os.Remove(filepath.Join(dir, entry.Name()))
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user