Teknisk artikel

HotXLS: streaming write and server batch jobs in Delphi

Skapa, redigera, granska, beräkna och exportera Excel-arbetsböcker direkt från Delphi- eller C++Builder-kod. HotXLS är ett nativt Object Pascal-bibliotek med källkod för XLS- och XLSX-flöden, avsett för skrivbordsverktyg, batchjobb, rapportsystem och serversidig dokumentgenerering utan Microsoft Excel-automatisering.

Den här artikeln är skriven för teams producing many workbooks from services, schedulers, APIs, or report farms. Den behandlar streaming write and server batch jobs som produktionsnära dokumentteknik, inte som ett isolerat komponentanrop.

Den praktiska risken är att batch generation can overload memory, leave temporary files, retry unsafe stages, or hide partial output unless job boundaries are explicit. Därför behöver flödet ett skrivet kontrakt, observerbar diagnostik och realistiska regressionsfiler.

Arkitekturbeslut

Treat every workbook as an isolated job. job identifier, output destination, retry policy, timeout, and cancellation behavior / temporary file location, cleanup, quota, and retention for failed workbooks

  • job identifier, output destination, retry policy, timeout, and cancellation behavior
  • temporary file location, cleanup, quota, and retention for failed workbooks
  • batch size, concurrency level, progress reporting, and back-pressure
  • which validation can run before final upload or delivery

Implementeringsflöde

Stream output only after validation checkpoints are defined. The order below keeps the workflow reviewable for Delphi and C++Builder teams.

  1. assign a job identifier and output boundary before opening the workbook writer
  2. prepare styles, sheets, and headers before streaming row data
  3. write rows in batches and checkpoint progress for operators
  4. validate size, sheet count, row count, and key formulas before final delivery
  5. clean or retain temporary files according to success, cancellation, or failure

Valideringsbevis

Batch evidence for operators. Keep these fields with the output or support record.

  • job identifier, batch item count, row count, output size, elapsed time, and memory peak
  • stage timings for data load, workbook write, validation, save, and upload
  • temporary path, cleanup status, retry count, and cancellation reason
  • operator-facing failure reason and whether retry is safe

Streaming is a resource policy

Streaming write helps scale workbook generation, but it also limits which parts of the workbook can be revisited later. The job design should decide what must be known before streaming begins.

Implementeringsanteckningar för produktion

Behandla HotXLS: streaming write and server batch jobs in Delphi som ett tydligt servicekontrakt runt HotXLS-anropen, med separerad indatavalidering, arbetsboksskrivning, utdata kontroll och supportbevis

  • Bestäm datakälla, cellområden och utdataformat innan arbetsboken skapas
  • Logga rader, blad, varningar och utdata sökväg i granskningsbar supportevidens
  • Kapsla applikationsdetaljer i testbara helpers i stället för UI-händelser
  • Öppna eller inspektera den sparade filen innan den lämnas till ett annat system eller kunden

Felmoder att öva

  • En lyckad SaveAs bevisar inte att affärskontraktet fortfarande är korrekt
  • Typsnitt, behörigheter och regionala inställningar kan skilja mellan server och utvecklingsdator
  • Loggar får inte exponera lösenord, kunddata eller interna länkar

Detaljerat Delphi-exempel

Följande Delphi-exempel visar en praktisk servicegräns för ämnet och håller policy, loggning och validering testbart separerade

procedure RunWorkbookBatch(const Jobs: TArray<TWorkbookJob>);
var
  Job: TWorkbookJob;
  JobResult: TWorkbookJobResult;
begin
  for Job in Jobs do
  begin
    StartJobAudit(Job.Id, Job.OutputFile);
    try
      RequireWritableDestination(Job.OutputFile);
      RequireTempQuota(Job.TempFolder, Job.ExpectedRows);
      JobResult := WriteWorkbookJob(Job);
      ValidateWorkbookForDelivery(JobResult.OutputFile, JobResult.ExpectedRows);
      CompleteJobAudit(Job.Id, JobResult);
    except
      on E: Exception do
      begin
        MarkJobFailed(Job.Id, E.Message, CanRetryWorkbookJob(Job));
        CleanupOrRetainTempFiles(Job, E);
        raise;
      end;
    end;
  end;
end;

function WriteWorkbookJob(const Job: TWorkbookJob): TWorkbookJobResult;
var
  Wb: TXLSXWorkbook;
  Sh: IXLSWorksheet;
begin
  Wb := TXLSXWorkbook.Create;
  try
    Sh := Wb.Sheets[0];
    Sh.Name := 'Batch Output';
    StreamRowsIntoWorksheet(Sh, Job.Reader, Job.Progress);
    WriteBatchMetricsSheet(Wb, Job);
    if Wb.SaveAs(Job.OutputFile) <> 1 then
      RaiseWorkbookSaveError(Job.OutputFile);
    Result := BuildWorkbookJobResult(Job);
  finally
    Wb.Free;
  end;
end;

Produktionschecklista

  • Run the workflow on an empty workbook, a normal customer workbook, and a worst-case workbook
  • Open the output with the target spreadsheet application or downstream importer
  • Log product version, template version, profile, row count, output path, elapsed time, and warning count
  • Keep passwords, temporary files, customer data, and support bundles under explicit retention rules
  • Add regression workbooks when a customer file exposes a new edge case

Product documentation

HotXLS Component