XmlWriter 클래스

정의

public ref class XmlWriter abstract : IDisposable

public ref class XmlWriter abstract : IAsyncDisposable, IDisposable

public ref class XmlWriter abstract

public abstract class XmlWriter : IDisposable

public abstract class XmlWriter : IAsyncDisposable, IDisposable

public abstract class XmlWriter

type XmlWriter = class
    interface IDisposable

type XmlWriter = class
    interface IAsyncDisposable
    interface IDisposable

type XmlWriter = class

Public MustInherit Class XmlWriter
Implements IDisposable

Public MustInherit Class XmlWriter
Implements IAsyncDisposable, IDisposable

Public MustInherit Class XmlWriter

상속

Object

XmlWriter

파생

System.Xml.XmlDictionaryWriter

System.Xml.XmlTextWriter

System.Xml.Xsl.Runtime.XmlQueryOutput

구현

IDisposable IAsyncDisposable

예제

다음 예제 코드에서는 비동기 API를 사용하여 XML을 생성하는 방법을 보여줍니다.

async Task TestWriter(Stream stream)
{
    XmlWriterSettings settings = new XmlWriterSettings();
    settings.Async = true;

    using (XmlWriter writer = XmlWriter.Create(stream, settings)) {
        await writer.WriteStartElementAsync("pf", "root", "http://ns");
        await writer.WriteStartElementAsync(null, "sub", null);
        await writer.WriteAttributeStringAsync(null, "att", null, "val");
        await writer.WriteStringAsync("text");
        await writer.WriteEndElementAsync();
        await writer.WriteProcessingInstructionAsync("pName", "pValue");
        await writer.WriteCommentAsync("cValue");
        await writer.WriteCDataAsync("cdata value");
        await writer.WriteEndElementAsync();
        await writer.FlushAsync();
    }
}

설명

클래스는 XmlWriter 스트림, 파일, 텍스트 또는 문자열에 XML 데이터를 씁니다. W3C XML(Extensible Markup Language) 1.0(네 번째 버전) 및 XML 1.0(세 번째 버전) 권장 사항의 네임스페이스를 지원합니다.

XmlWriter 클래스의 멤버를 사용하여 다음 작업을 수행할 수 있습니다.

• 문자가 유효한 XML 문자이고 해당 요소 및 특성 이름이 유효한 XML 이름인지 확인합니다.
• XML 문서가 올바른 형식인지 확인합니다.
• 이진 바이트를 Base64 또는 BinHex로 인코딩하고 결과 텍스트를 작성합니다.
• 값 변환을 수동으로 수행할 필요가 없도록 문자열 대신 공용 언어 런타임 형식을 사용하여 값을 전달합니다.
• 하나의 출력 스트림에 여러 문서를 씁니다.
• 유효한 이름, 정규화된 이름 및 이름 토큰을 작성합니다.

XML 작성기 만들기

인스턴스를 XmlWriter 만들려면 메서드를 XmlWriter.Create 사용합니다. XML 기록기에서 사용하도록 설정할 기능 집합을 지정하려면 메서드에 XmlWriterSettingsCreate 전달합니다. 그렇지 않으면 기본 설정이 사용됩니다. Create 자세한 내용은 참조 페이지를 참조하세요.

출력 형식 지정

XmlWriterSettings 클래스에는 XmlWriter 출력의 형식을 제어하는 여러 속성이 포함되어 있습니다.

Indent 및 IndentChars 속성은 중요하지 않은 공백의 서식을 제어합니다. 예를 들어 요소 노드를 들여쓰기하려면:

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.IndentChars = "\t";
XmlWriter writer = XmlWriter.Create("books.xml", settings);

Dim settings As New XmlWriterSettings()
settings.Indent = True
settings.IndentChars = vbTab
Dim writer As XmlWriter = XmlWriter.Create("books.xml", settings)

NewLineOnAttributes 들여쓰기 수준을 한 개 더 사용하여 새 줄에 각 특성을 작성합니다.

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.NewLineOnAttributes = true;
XmlWriter writer = XmlWriter.Create("books.xml", settings);

Dim settings As New XmlWriterSettings()
settings.Indent = True
settings.NewLineOnAttributes = True
Dim writer As XmlWriter = XmlWriter.Create("books.xml", settings)

데이터 준수

XML 작성기는 클래스의 XmlWriterSettings 두 속성을 사용하여 데이터 규격을 확인합니다.

• 이 CheckCharacters 속성은 XML 작성기에게 문자를 확인하고 XmlException 예외를 throw 하며, 문자가 법적 범위를 벗어나는지 여부를 W3C에서 정의한 대로 지시합니다.

• 이 속성은 ConformanceLevel 작성 중인 스트림이 W3C에서 정의한 대로 올바른 형식의 XML 1.0 문서 또는 문서 조각에 대한 규칙을 준수하는지 확인하도록 XML 기록기를 구성합니다. 다음 표에서는 세 가지 적합성 수준을 설명합니다. 기본값은 Document입니다. 자세한 내용은 XmlWriterSettings.ConformanceLevel 속성과 System.Xml.ConformanceLevel 열거형을 참조하세요.

  Level	Description
  Document	XML 출력은 올바른 형식의 XML 1.0 문서에 대한 규칙을 준수하며 모든 준수 프로세서에서 처리할 수 있습니다.
  Fragment	XML 출력은 올바른 형식의 XML 1.0 문서 조각에 대한 규칙을 준수합니다.
  Auto	XML 작성기는 들어오는 데이터에 따라 적용할 규칙 검사 수준(문서 또는 조각)을 결정합니다.

요소 쓰기

다음 XmlWriter 메서드를 사용하여 요소 노드를 작성할 수 있습니다. 예제는 나열된 메서드를 참조하세요.

특성 쓰기

다음 XmlWriter 메서드를 사용하여 요소 노드에 특성을 작성할 수 있습니다. 다음 섹션에서 설명한 대로 이러한 메서드를 사용하여 요소에 네임스페이스 선언을 만들 수도 있습니다.

네임스페이스 처리

네임스페이스는 XML 문서의 요소 및 특성 이름을 한정하는 데 사용됩니다. 네임스페이스 접두사는 요소와 특성을 네임스페이스와 연결하며, 이 네임스페이스는 URI 참조와 연결됩니다. 네임스페이스는 XML 문서에서 요소 및 특성 이름 고유성을 만듭니다.

현재 XmlWriter 네임스페이스 범위에 정의된 모든 네임스페이스에 해당하는 네임스페이스 스택을 유지 관리합니다. 요소 및 특성을 작성할 때 다음과 같은 방법으로 네임스페이스를 활용할 수 있습니다.

• 메서드를 사용하여 네임스페이스를 수동으로 선언합니다 WriteAttributeString . 이 방법은 네임스페이스 선언 수를 가장 잘 최적화하는 방법을 알고 있는 경우에 유용할 수 있습니다. 예를 들어 메서드를 참조하세요 WriteAttributeString(String, String, String, String) .

• 현재 네임스페이스 선언을 새 네임스페이스로 덮어씁니다. 다음 코드에서 WriteAttributeString 메서드는 "x" 접두사의 네임스페이스 URI를 "123"에서 "abc"로 변경합니다.

  writer.WriteStartElement("x", "root", "123");
  writer.WriteStartElement("item");
  writer.WriteAttributeString("xmlns", "x", null, "abc");
  writer.WriteEndElement();
  writer.WriteEndElement();
  

  writer.WriteStartElement("x", "root", "123")
  writer.WriteStartElement("item")
  writer.WriteAttributeString("xmlns", "x", Nothing, "abc")
  writer.WriteEndElement()
  writer.WriteEndElement()
  

  코드는 다음 XML 문자열을 생성합니다.

  <x:root xmlns:x="123">
    <item xmlns:x="abc" />
  </x:root>
  

• 특성 또는 요소를 작성할 때 네임스페이스 접두사를 지정합니다. 요소 및 특성을 작성하는 데 사용되는 많은 메서드를 사용하면 이 작업을 수행할 수 있습니다. 예를 들어 메서드는 WriteStartElement(String, String, String) 시작 태그를 작성하고 지정된 네임스페이스 및 접두사에 연결합니다.

형식화된 데이터 쓰기

이 메서드는 WriteValue CLR(공용 언어 런타임) 개체를 허용하고, XSD(XML 스키마 정의 언어) 데이터 형식 변환 규칙에 따라 입력 값을 문자열 표현으로 변환하고, 메서드를 사용하여 WriteString 작성합니다. 이 방법은 클래스의 메서드 XmlConvert 를 사용하여 입력된 데이터를 문자열 값으로 변환한 후 작성하는 것보다 쉽습니다.

텍스트에 쓸 때 입력된 값은 해당 스키마 유형에 대한 XmlConvert 규칙을 사용하여 텍스트로 직렬화됩니다.

CLR 형식에 해당하는 기본 XSD 데이터 형식은 메서드를 WriteValue 참조하세요.

XML XmlWriter 데이터 저장소에 쓰는 데 사용할 수도 있습니다. 예를 들어 XPathNavigator 클래스는 XmlWriter 객체를 만들어 XmlDocument 객체에 대한 노드를 생성할 수 있습니다. 데이터 저장소에 사용할 수 있는 WriteValue 스키마 정보가 있는 경우 허용되지 않는 형식으로 변환하려고 하면 메서드가 예외를 throw합니다. 데이터 저장소에 사용할 수 있는 스키마 정보가 없는 경우 메서드는 WriteValue 모든 값을 형식으로 xsd:anySimpleType 처리합니다.

XML 작성기 닫기

XML을 출력하기 위해 XmlWriter 메서드를 사용할 때, Close 메서드를 호출하기 전에는 요소와 속성이 작성되지 않습니다. 예를 들어, XmlWriter 개체를 채우는 데 XmlDocument를 사용하는 경우, XmlWriter 인스턴스를 닫을 때까지 대상 문서에서 작성된 요소와 속성을 볼 수 없습니다.

비동기 프로그래밍

XmlWriter 대부분의 메서드에는 메서드 이름의 끝에 "Async"가 있는 비동기 대응 항목이 있습니다. 예를 들어, WriteAttributeString의 비동기식 대응은 WriteAttributeStringAsync입니다.

WriteValue 비동기 값이 없는 메서드의 경우 반환 값을 문자열로 변환하고 대신 메서드를 WriteStringAsync 사용합니다.

보안 고려 사항

클래스를 사용할 때 다음을 고려합니다 XmlWriter .

• XmlWriter에 의해 던져진 예외는 앱에 전달되기를 원하지 않는 경로 정보를 노출할 수 있습니다. 앱은 예외를 포착하고 적절하게 처리해야 합니다.

• XmlWriter는 WriteDocType 또는 WriteRaw 메서드에 전달되는 데이터의 유효성을 검사하지 않습니다. 이러한 메서드에 임의의 데이터를 전달해서는 안 됩니다.

추가 정보

• XML 문서 및 데이터