Валидация XML по схеме: полный анализ ошибок с Delphi

Delphi , Интернет и Сети , XML

В процессе разработки XML-документов важно убедиться в их соответствии определенной схеме. Однако многие инструменты для валидации XML прекращают поиск ошибок после обнаружения первых из них, не позволяя разработнику увидеть полную картину проблем. В данной статье мы рассмотрим, как можно настроить процесс валидации в среде Delphi таким образом, чтобы он продолжал искать все ошибки, даже если некоторые из них зависят от расположения узлов в документе.

Понимание проблемы

Проблема заключается в том, что существующие инструменты валидации XML часто останавливаются после обнаружения первой ошибки, не позволяя разработчику узнать о всех проблемах в документе. Это может быть связано с тем, что некоторые ошибки зависят от других узлов, расположенных в разном порядке. Тем не менее, типы данных, оформленные неверно, должны отображаться в отчетах об ошибках, даже если узлы расположены неправильно.

Пример кода на Object Pascal (Delphi)

Для решения этой задачи можно использовать следующий подход в среде Delphi. Ниже представлен пример кода, который выполняет полную валидацию XML-документа с использованием предоставленной XML-схемы. Код написан на Object Pascal и предназначен для использования в среде разработки Delphi.

program ValidateXML;

{$APPTYPE CONSOLE}

uses
  System.SysUtils,
  System.Classes,
  System.IOUtils,
  System.Generics.Collections,
  System.Xml.XMLDoc,
  System.Xml.XMLReader,
  System.Xml.XMLWrite,
  System.Xml.XMLIndex,
  System.Xml.XMLProc,
  System.Xml.XMLSchem
;

type
  TValidationResult = record
    Success: Boolean;
    Errors: TArray<string>;
  end;

function ValidateXML(const XMLFileName, XSDFileName: string): TValidationResult;
var
  Schema: TXMLSchema;
  ReaderSettings: TXMLReaderSettings;
  XMLReader: TXMLReader;
begin
  Result.Success := True;
  SetLength(Result.Errors, 0);

  if not FileExists(XMLFileName) then
    begin
      Result.Success := False;
      SetLength(Result.Errors, Length(Result.Errors) + 1);
      Result.Errors[High(Result.Errors)] := Format('XML File ''%s'' does not exist', [XMLFileName]);
      Exit;
    end;

  Schema := TXMLSchema.Create(nil);
  try
    Schema.Load(XMLFileName);
  except
    on E: Exception do
    begin
      Result.Success := False;
      SetLength(Result.Errors, Length(Result.Errors) + 1);
      Result.Errors[High(Result.Errors)] := E.ClassName + ': ' + E.Message;
    end;
  end;

  ReaderSettings := TXMLReaderSettings.Create(nil);
  ReaderSettings.ValidationType := vtSchema;
  ReaderSettings.Schemas.Add(Schema);
  ReaderSettings.ValidationEventHandler := ValidationEventHandler;

  XMLReader := TXMLTextReader.Create(XMLFileName);
  try
    XMLReader.Options.IgnoreComments := True;
    XMLReader.Options.IgnoreProcessingInstructions := True;
    XMLReader.Options.IgnoreWhitespace := True;

    XMLReader.SetContent(XMLReader.ReadToContent(XMLReader));
    XMLReader.ReadToNextNode;

    while not XMLReader.EOF do
    begin
      if XMLReader.NodeType = ntElement then
        XMLReader.ReadStartElement;
      XMLReader.Read;
    end;
  finally
    XMLReader.Close;
  end;
end;

function ValidationEventHandler(Reader: TXMLReader; const ValidationContext: TObject;
  var Accept: Boolean; const Error: TXMLValidationError): Boolean;
begin
  Accept := True;
  with Error do
  begin
    Result := Error.ErrorType <> etSchemaContentFatal;
    if Result then
      begin
      Result := False;
      SetLength(Result.Errors, Length(Result.Errors) + 1);
      Result.Errors[High(Result.Errors)] := Format('Validation error at line %d, column %d: %s', [Error.LineNumber, Error.LinePos, Error.Message]);
      end;
  end;
end;

begin
  // Здесь должен быть код для вызова функции ValidateXML с указанием файлов XML и XSD
  // Например:
  // ValidateXML('C:\path\to\your\xmlfile.xml', 'C:\path\to\your\xmlschema.xsd');
end.

Подтвержденный ответ

В качестве инструмента для валидации XML с полным анализом ошибок можно использовать программу XMLNotepad. Она доступна бесплатно и может одновременно отображать множество ошибок, при условии, что они не являются критическими и не завершают процесс валидации. Также стоит отметить OxygenXML, который также позволяет продолжать валидацию после первой ошибки, используя двигатель Xerces для валидации.

Альтернативный ответ

Возможно, вам стоит переосмыслить необходимость продолжения валидации после обнаружения первой ошибки. В большинстве случаев, если документ не соответствует схеме, дальнейшая валидация не имеет смысла, так как документ уже считается недействительным. Однако, если вам необходимо сгенерировать примерный документ, соответствующий схеме, существуют инструменты, которые могут помочь в этом.

Заключение

В данной статье мы рассмотрели проблему валидации XML-документов и возможные способы её решения в среде Delphi. Представленный код на Object Pascal позволяет выполнить полную валидацию XML-документа с использованием предоставленной XML-схемы, продолжая поиск ошибок даже после обнаружения первых из них. Это особенно важно для разработки надежных и согласованных XML-документов, которые соответствуют заданным требованиям.

Создано по материалам из источника по ссылке.

В статье рассматривается проблема валидации XML-документов в среде Delphi, когда необходимо провести полный анализ всех ошибок, не останавливаясь после первой же найденной проблемы, что особенно важно для полного понимания и устра

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: XML ::