← 中文资源

简体中文版本

构建 CSV 流式解析器

构建 CSV 流式解析器:完整覆盖 streaming csv parsing,含 Byte chunker、Line splitter 与测试的端到端实现。

阅读英文原文

项目概述

本项目实现一个面向 streaming csv parsing 的完整系统,核心要解决的问题是 parsing arbitrarily large CSV files in constant memory while handling quoted fields and embedded newlines。整体由 Byte chunker、Line splitter、Field parser、Header mapper、Row emitter 五个模块组成,每个模块单一职责、可独立测试,最后通过集成测试验证端到端正确性。设计上把 a quoted field with an embedded newline that a naive line splitter breaks in half 作为第一类需求先行处理,而非事后再补。

架构与关键决策

数据模型为 a state machine over a byte buffer that emits rows as soon as a record terminator is seen, without buffering the whole file。Byte chunker 定义其余阶段共同依赖的数据形状并在边界处校验输入;Line splitter 承载 streaming csv parsing 的正确性逻辑;Field parser 专门处理 a quoted field with an embedded newline that a naive line splitter breaks in half,在失败路径上给出明确的拒绝、重试或降级策略;Header mapper 提供可观测性,每次操作输出带关联 id 的结构化事件;Row emitter 在过载时按既定方式降级,避免过载演变为数据损坏。配置与代码分离,使风险变更可经 diff 审阅。

实施与测试

按五个阶段依次实现 Byte chunker、Line splitter、Field parser、Header mapper、Row emitter,每阶段配套聚焦单测。集成测试组合各模块并驱动真实 streaming csv parsing 场景:先验证正常路径,再刻意触发 a quoted field with an embedded newline that a naive line splitter breaks in half 并断言系统降级而非损坏。所有依赖均在进程内或被桩替换,用例在 CI 中确定可复现。

限制与后续

  • 单区域设计,多区域复制超出范围。
  • Byte chunker 默认进程内,未水平共享。
  • 无鉴权层,假定部署在强制身份的边缘之后。

代码示例

# setup for csv-streaming-parser
pnpm init
pnpm add csv-parse fastify
pnpm add -D typescript tsx vitest
csv_streaming_parser/
├── src/index.ts
├── src/byte-chunker.ts
├── src/line-splitter.ts
├── tests/csv_streaming_parser.test.ts
└── package.json
// Byte chunker: streaming csv parsing core
export function bytechunker(input: BytechunkerInput): BytechunkerResult {
  // Build the byte chunker that anchors streaming csv parsing and defines the core data shape.
  return processBytechunker(input);
}
// Line splitter — handles streaming csv parsing Add the line splitter so
export class Linesplitter {
  constructor(private opts: LinesplitterOptions) {}
  async run(ctx: Context): Promise<LinesplitterOutput> {
    return this.execute(ctx);
  }
}
// Field parser: streaming csv parsing stage
export const fieldparser = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};
// Header mapper for streaming csv parsing
export async function headermapper(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}
// Row emitter: streaming csv parsing finalization
export function rowemitter(state: State): Result {
  validate(state);
  return finalize(state);
}
# run the streaming csv parsing test suite
pnpm vitest run