Artigo técnico

HotXLS: streaming write and server batch jobs in Delphi

Crie, edite, inspecione, calcule e exporte pastas Excel diretamente de codigo Delphi ou C++Builder. HotXLS e uma biblioteca nativa Object Pascal para XLS e XLSX, projetada para ferramentas desktop, lotes, relatorios e geracao de documentos sem automacao do Microsoft Excel.

Este artigo é para teams producing many workbooks from services, schedulers, APIs, or report farms. Ele trata streaming write and server batch jobs como engenharia documental de produção, não como uma chamada isolada de componente.

O risco prático é que batch generation can overload memory, leave temporary files, retry unsafe stages, or hide partial output unless job boundaries are explicit. Por isso o fluxo precisa de contrato escrito, diagnósticos observáveis e arquivos de regressão representativos.

Decisões de arquitetura

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

Fluxo de implementação

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

Evidências de validação

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.

Notas de implementação para produção

Trate HotXLS: streaming write and server batch jobs in Delphi como um contrato de serviço explícito em torno das chamadas HotXLS, separando validação de entrada, gravação da pasta de trabalho, verificação da saída e evidências para suporte

  • Defina fonte de dados, intervalos de células e formato de saída antes de criar a pasta de trabalho
  • Registre linhas, planilhas, avisos e caminho de saída em evidências revisáveis
  • Encapsule detalhes da aplicação em helpers testáveis, não em eventos de interface
  • Reabra ou inspecione o arquivo salvo antes de entregá-lo a outro sistema ou ao cliente

Falhas que devem ser ensaiadas

  • SaveAs com sucesso não prova que o contrato de negócio continua correto
  • Fontes, permissões e configurações regionais podem variar entre servidor e máquina de desenvolvimento
  • Logs não devem expor senhas, dados de clientes nem links internos

Exemplo Delphi detalhado

O exemplo Delphi a seguir mostra uma fronteira de serviço prática para este tema, mantendo política, logs e validação em uma camada testável

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;

Checklist de produção

  • 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