主要功能:
- 定义哨兵错误(Sentinel Errors):ErrNilParameter, ErrInvalidCount,
ErrInvalidRange, ErrAlreadyRunning, ErrNotFound, ErrCRCMismatch 等
- 实现结构化错误类型:TopicError, FileError, IndexError, ValidationError
- 提供错误检查辅助函数:IsTopicNotFound, IsIndexOutOfRange, IsCRCMismatch
- 支持 errors.Is 和 errors.As 进行错误判断
更新相关文件使用新错误类型:
- cursor.go: 使用 ValidationError 和 ErrCRCMismatch
- index.go: 使用 IndexError 处理索引越界
- query.go: 使用 ValidationError 验证参数
- seqlog_manager.go: 使用 TopicError 和 ErrAlreadyRegistered
- topic_processor.go: 使用 ErrAlreadyRunning 和 ErrInvalidConfig
测试覆盖:
- errors_test.go 提供完整的错误类型测试
- 所有现有测试继续通过
使用示例:
```go
// 检查 topic 是否存在
if IsTopicNotFound(err) {
// 处理 topic 不存在的情况
}
// 检查索引越界
if IsIndexOutOfRange(err) {
var indexErr *IndexError
errors.As(err, &indexErr)
fmt.Printf("index %d out of range\n", indexErr.Index)
}
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
220 lines
5.4 KiB
Go
220 lines
5.4 KiB
Go
package seqlog
|
||
|
||
import (
|
||
"encoding/binary"
|
||
"fmt"
|
||
"io"
|
||
"os"
|
||
)
|
||
|
||
// RecordStatus 记录处理状态
|
||
type RecordStatus int
|
||
|
||
const (
|
||
StatusProcessed RecordStatus = iota // 已处理
|
||
StatusProcessing // 处理中(当前位置)
|
||
StatusPending // 待处理
|
||
StatusUnavailable // 不可用(尚未写入)
|
||
)
|
||
|
||
// String 返回状态的字符串表示
|
||
func (s RecordStatus) String() string {
|
||
switch s {
|
||
case StatusProcessed:
|
||
return "StatusProcessed"
|
||
case StatusProcessing:
|
||
return "StatusProcessing"
|
||
case StatusPending:
|
||
return "StatusPending"
|
||
case StatusUnavailable:
|
||
return "StatusUnavailable"
|
||
default:
|
||
return "StatusUnknown"
|
||
}
|
||
}
|
||
|
||
// RecordWithStatus 带状态的记录
|
||
type RecordWithStatus struct {
|
||
Record *Record
|
||
Status RecordStatus
|
||
}
|
||
|
||
// RecordQuery 记录查询器
|
||
type RecordQuery struct {
|
||
logPath string
|
||
fd *os.File
|
||
rbuf []byte // 复用读缓冲区
|
||
index *RecordIndex // 索引文件管理器(来自外部)
|
||
}
|
||
|
||
// NewRecordQuery 创建记录查询器
|
||
// index 参数必须由外部提供,确保所有组件使用同一个索引实例
|
||
func NewRecordQuery(logPath string, index *RecordIndex) (*RecordQuery, error) {
|
||
if index == nil {
|
||
return nil, NewValidationError("index", "index cannot be nil", ErrNilParameter)
|
||
}
|
||
|
||
fd, err := os.Open(logPath)
|
||
if err != nil {
|
||
return nil, fmt.Errorf("open log file: %w", err)
|
||
}
|
||
|
||
rq := &RecordQuery{
|
||
logPath: logPath,
|
||
fd: fd,
|
||
rbuf: make([]byte, 8<<20), // 8 MiB 缓冲区
|
||
index: index,
|
||
}
|
||
|
||
return rq, nil
|
||
}
|
||
|
||
// readRecordsForward 从指定索引位置向前顺序读取记录
|
||
// startIndex: 起始记录索引
|
||
// count: 读取数量
|
||
func (rq *RecordQuery) readRecordsForward(startIndex, count int) ([]*Record, error) {
|
||
// 获取起始 offset
|
||
startOffset, err := rq.index.GetOffset(startIndex)
|
||
if err != nil {
|
||
return nil, fmt.Errorf("get start offset: %w", err)
|
||
}
|
||
|
||
if _, err := rq.fd.Seek(startOffset, 0); err != nil {
|
||
return nil, fmt.Errorf("seek to offset %d: %w", startOffset, err)
|
||
}
|
||
|
||
results := make([]*Record, 0, count)
|
||
currentOffset := startOffset
|
||
|
||
for len(results) < count {
|
||
// 读取头部:[4B len][4B CRC][16B UUID] = 24 字节
|
||
hdr := rq.rbuf[:24]
|
||
if _, err := io.ReadFull(rq.fd, hdr); err != nil {
|
||
if err == io.EOF {
|
||
break
|
||
}
|
||
return nil, fmt.Errorf("read header at offset %d: %w", currentOffset, err)
|
||
}
|
||
|
||
rec := &Record{
|
||
Len: binary.LittleEndian.Uint32(hdr[0:4]),
|
||
CRC: binary.LittleEndian.Uint32(hdr[4:8]),
|
||
}
|
||
copy(rec.UUID[:], hdr[8:24])
|
||
|
||
// 读取数据
|
||
rec.Data = make([]byte, rec.Len)
|
||
if _, err := io.ReadFull(rq.fd, rec.Data); err != nil {
|
||
return nil, fmt.Errorf("read data at offset %d: %w", currentOffset, err)
|
||
}
|
||
|
||
results = append(results, rec)
|
||
currentOffset += 24 + int64(rec.Len)
|
||
}
|
||
|
||
return results, nil
|
||
}
|
||
|
||
// QueryOldest 从指定索引开始查询记录(向前读取)
|
||
// startIndex: 查询起始索引
|
||
// count: 查询数量
|
||
// 返回的记录按时间顺序(索引递增方向)
|
||
func (rq *RecordQuery) QueryOldest(startIndex, count int) ([]*Record, error) {
|
||
if count <= 0 {
|
||
return nil, NewValidationError("count", "count must be greater than 0", ErrInvalidCount)
|
||
}
|
||
|
||
totalCount := rq.index.Count()
|
||
if totalCount == 0 {
|
||
return []*Record{}, nil
|
||
}
|
||
|
||
// 校验起始索引
|
||
if startIndex < 0 {
|
||
startIndex = 0
|
||
}
|
||
if startIndex >= totalCount {
|
||
return []*Record{}, nil
|
||
}
|
||
|
||
// 限制查询数量
|
||
remainCount := totalCount - startIndex
|
||
if count > remainCount {
|
||
count = remainCount
|
||
}
|
||
|
||
return rq.readRecordsForward(startIndex, count)
|
||
}
|
||
|
||
// QueryNewest 从指定索引开始向后查询记录(索引递减方向)
|
||
// endIndex: 查询结束索引(包含,最新的记录)
|
||
// count: 查询数量
|
||
// 返回结果按时间倒序(最新在前,即 endIndex 对应的记录在最前)
|
||
func (rq *RecordQuery) QueryNewest(endIndex, count int) ([]*Record, error) {
|
||
if count <= 0 {
|
||
return nil, NewValidationError("count", "count must be greater than 0", ErrInvalidCount)
|
||
}
|
||
|
||
totalCount := rq.index.Count()
|
||
if totalCount == 0 {
|
||
return []*Record{}, nil
|
||
}
|
||
|
||
// 校验结束索引
|
||
if endIndex < 0 {
|
||
return []*Record{}, nil
|
||
}
|
||
if endIndex >= totalCount {
|
||
endIndex = totalCount - 1
|
||
}
|
||
|
||
// 计算实际起始索引(向前推 count-1 条)
|
||
queryStartIdx := endIndex - count + 1
|
||
if queryStartIdx < 0 {
|
||
queryStartIdx = 0
|
||
count = endIndex + 1 // 调整实际数量
|
||
}
|
||
|
||
// 向前读取
|
||
results, err := rq.readRecordsForward(queryStartIdx, count)
|
||
if err != nil {
|
||
return nil, err
|
||
}
|
||
|
||
// 反转结果,使最新的在前
|
||
for i, j := 0, len(results)-1; i < j; i, j = i+1, j-1 {
|
||
results[i], results[j] = results[j], results[i]
|
||
}
|
||
|
||
return results, nil
|
||
}
|
||
|
||
// GetRecordCount 获取记录总数
|
||
func (rq *RecordQuery) GetRecordCount() (int, error) {
|
||
return rq.index.Count(), nil
|
||
}
|
||
|
||
// GetRecordStatus 根据游标窗口索引位置获取记录状态
|
||
// recordIndex: 记录索引
|
||
// startIdx: 窗口开始索引(已处理位置)
|
||
// endIdx: 窗口结束索引(当前读取位置)
|
||
func GetRecordStatus(recordIndex, startIdx, endIdx int) RecordStatus {
|
||
if recordIndex < startIdx {
|
||
return StatusProcessed
|
||
} else if recordIndex >= startIdx && recordIndex < endIdx {
|
||
return StatusProcessing
|
||
} else {
|
||
return StatusPending
|
||
}
|
||
}
|
||
|
||
// Close 关闭查询器
|
||
// 注意:不关闭 index,因为 index 是外部管理的
|
||
func (rq *RecordQuery) Close() error {
|
||
// 只关闭日志文件
|
||
if rq.fd != nil {
|
||
return rq.fd.Close()
|
||
}
|
||
return nil
|
||
}
|