VB.NET XMLWriter: come cambiare cosa c'è nell'intestazione?
Domanda
Ho l'obbligo di creare un file XML e il partner è piuttosto appiccicoso riguardo l'intestazione. Apparentemente, l'intestazione deve essere esattamente questa:
<?xml version="1.0"?>
Ma ogni volta che creo un file XML ottengo proprietà estranee come questa:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
L'hacker in me vuole smettere di usare XMLWriter per creare il file in modo da avere un maggiore controllo sull'intestazione; " nessun problema, scriverò solo un ciclo che crea i propri tag XML come StreamWriter o qualcosa del genere, dimentica questo oggetto XMLWriter ... " ma devo ammettere che finora XMLWriter è stato piuttosto elegante da usare; sicuramente ci deve essere qualcosa in cui posso cambiare l'oggetto XMLWriterSettings per dire "smetti di mettere le tue proprietà personalizzate nell'intestazione XML per favore", giusto?
Ecco il codice VB pertinente:
Dim settings As New XmlWriterSettings()
settings.Indent = True
settings.IndentChars = " "
settings.NewLineChars = "\n"
Using writer As XmlWriter = XmlWriter.Create(strFileName, settings)
writer.WriteStartDocument(True)
For Each kvp As KeyValuePair(Of String, String) In dictArguments
Dim key As String = kvp.Key
Dim value As String = kvp.Value
writer.WriteStartElement(key)
writer.WriteString(value)
writer.WriteEndElement()
Next
End Using
Funziona perfettamente; ma non riesco a trovare un modo per controllare l'intestazione. Posso trovare un modo per rimuoverlo del tutto ovviamente, ma non è quello che vogliamo fare.
Modifica: grazie per l'aiuto; finora una volta rimosso WriteStartDocument ora non viene più visualizzato standalone = yes. Non riesco comunque a smettere di aggiungere la codifica. Qualche idea?
Soluzione
Un modo per farlo è quello di prendere tu stesso il controllo delle istruzioni di elaborazione iniziali con il metodo WriteProcessingInstruction:
Dim settings As New XmlWriterSettings()
settings.Indent = True
settings.IndentChars = " "
Using writer As XmlWriter = XmlWriter.Create(strFileName, settings)
writer.WriteProcessingInstruction("xml", "version='1.0'")
writer.WriteStartElement("root")
For Each kvp As KeyValuePair(Of String, String) In dictArguments
Dim key As String = kvp.Key
Dim value As String = kvp.Value
writer.WriteStartElement(key)
writer.WriteString(value)
writer.WriteEndElement()
Next
writer.WriteEndElement()
End Using
Nota che ho anche aggiunto un " root " nel caso in cui il tuo dizionario contenga più di un elemento (e suppongo che nessuno dei valori chiave del dizionario sia " root " :)
Altri suggerimenti
So che sono trascorsi alcuni mesi da quando è stata posta la domanda, tuttavia mi sento in dovere di menzionare una soluzione (di vecchia data?) che mi sono imbattuto attraverso. Elimina l'intera intera dichiarazione xmld e tutto ciò che devi fare è riscrivere solo la dichiarazione di cui hai bisogno scrivendo un'istruzione di proiezione.
XmlFragmentWriter - Omettere la dichiarazione Xml e gli spazi dei nomi XSD e XSI
Ed ecco la classe in VB
Imports System.Xml
Imports System.IO
Imports System.Text
Class XmlFragmentWriter
Inherits XmlTextWriter
Public Sub New(ByVal w As TextWriter)
MyBase.New(w)
End Sub
Public Sub New(ByVal w As Stream, ByVal encoding As Encoding)
MyBase.New(w, encoding)
End Sub
Public Sub New(ByVal filename As String, ByVal encoding As Encoding)
MyBase.New(New FileStream(filename, FileMode.Create, FileAccess.Write, FileShare.None), encoding)
End Sub
Private _skip As Boolean = False
Public Overrides Sub WriteStartAttribute(ByVal prefix As String, ByVal localName As String, ByVal ns As String)
' STEP 1 - Omits XSD and XSI declarations.
' From Kzu - http://weblogs.asp.net/cazzu/archive/2004/01/23/62141.aspx
If prefix = "xmlns" AndAlso (localName = "xsd" OrElse localName = "xsi") Then
_skip = True
Return
End If
MyBase.WriteStartAttribute(prefix, localName, ns)
End Sub
Public Overrides Sub WriteString(ByVal text As String)
If _skip Then
Return
End If
MyBase.WriteString(text)
End Sub
Public Overrides Sub WriteEndAttribute()
If _skip Then
' Reset the flag, so we keep writing.
_skip = False
Return
End If
MyBase.WriteEndAttribute()
End Sub
Public Overrides Sub WriteStartDocument()
' STEP 2: Do nothing so we omit the xml declaration.
End Sub
End Class
e l'utilizzo qui:
Dim f As New XmlSerializer(GetType(OFXg)) Dim w As New XmlFragmentWriter("c:\books1.xml", Nothing) w.Formatting = Formatting.Indented w.WriteProcessingInstruction("xml", "version=""1.0""") f.Serialize(w, RTofx) w.Close()
Naturalmente la classe OFXg è un XMLSerializable
Perché ritieni che ci siano proprietà personalizzate nell'intestazione?
WriteStartDocument scrive l'intestazione con o senza l'attributo autonomo. Il tuo codice aggiunge l'attributo che hai detto che il tuo partner non accetta.
Non hai mostrato il codice utilizzato per produrre "utf-16", ma sospetto che sia stato scritto su StringWriter. Le stringhe in .NET sono sempre UNICODE e otterrai sempre utf-16 quando scrivi su una stringa. Se scrivi su uno stream, puoi controllare la codifica.
Necromancing.
Puoi creare il tuo XmlTextWriter e sovrascrivere WriteStartDocument.
Esempio:
public class XmlTextWriterIndentedStandaloneNo : System.Xml.XmlTextWriter
{
public bool bStandAlone = false;
public bool bWriteStartDocument = true;
public bool bOmitEncodingAndStandAlone = true;
public XmlTextWriterIndentedStandaloneNo(System.IO.TextWriter w)
: base(w)
{
Formatting = System.Xml.Formatting.Indented;
} // End Constructor
public XmlTextWriterIndentedStandaloneNo(string strFileName, System.Text.Encoding teEncoding)
: base(strFileName, teEncoding)
{
Formatting = System.Xml.Formatting.Indented;
} // End Constructor
public XmlTextWriterIndentedStandaloneNo(System.IO.Stream w, System.Text.Encoding teEncoding)
: base(w, teEncoding)
{
Formatting = System.Xml.Formatting.Indented;
} // End Constructor
public override void WriteStartDocument(bool standalone)
{
if (bWriteStartDocument)
{
if (bOmitEncodingAndStandAlone)
{
this.WriteProcessingInstruction("xml", "version='1.0'");
return;
} // End if (bOmitEncodingAndStandAlone)
base.WriteStartDocument(bStandAlone);
}
} // End Sub WriteStartDocument
public override void WriteStartDocument()
{
// Suppress by ommitting WriteStartDocument
if (bWriteStartDocument)
{
if (bOmitEncodingAndStandAlone)
{
this.WriteProcessingInstruction("xml", "version='1.0'");
return;
} // End if (bOmitEncodingAndStandAlone)
base.WriteStartDocument(bStandAlone);
// False: Standalone="no"
} // End if (bWriteStartDocument)
} // End Sub WriteStartDocument
} // End Class XmlTextWriterIndentedStandaloneNo
VB.NET
Public Class XmlTextWriterIndentedStandaloneNo
Inherits System.Xml.XmlTextWriter
Public bStandAlone As Boolean = False
Public bWriteStartDocument As Boolean = True
Public bOmitEncodingAndStandAlone As Boolean = True
Public Sub New(w As System.IO.TextWriter)
MyBase.New(w)
Formatting = System.Xml.Formatting.Indented
End Sub
' End Constructor
Public Sub New(strFileName As String, teEncoding As System.Text.Encoding)
MyBase.New(strFileName, teEncoding)
Formatting = System.Xml.Formatting.Indented
End Sub
' End Constructor
Public Sub New(w As System.IO.Stream, teEncoding As System.Text.Encoding)
MyBase.New(w, teEncoding)
Formatting = System.Xml.Formatting.Indented
End Sub
' End Constructor
Public Overrides Sub WriteStartDocument(standalone As Boolean)
If bOmitEncodingAndStandAlone Then
Me.WriteProcessingInstruction("xml", "version='1.0'")
Return
End If
' End if (bOmitEncodingAndStandAlone)
If bWriteStartDocument Then
MyBase.WriteStartDocument(bStandAlone)
End If
End Sub
' End Sub WriteStartDocument
Public Overrides Sub WriteStartDocument()
If bOmitEncodingAndStandAlone Then
Me.WriteProcessingInstruction("xml", "version='1.0'")
Return
End If
' End if (bOmitEncodingAndStandAlone)
' Suppress by ommitting WriteStartDocument
If bWriteStartDocument Then
' False: Standalone="no"
MyBase.WriteStartDocument(bStandAlone)
End If
' End if (bWriteStartDocument)
End Sub
' End Sub WriteStartDocument
End Class
' End Class XmlTextWriterIndentedStandaloneNo
Esempio di utilizzo:
//using (System.Xml.XmlTextWriter wr = new System.Xml.XmlTextWriter(System.IO.Path.Combine(strBasePath, "TestFile.xml"), System.Text.Encoding.UTF8))
//using (System.Xml.XmlWriter wr = System.Xml.XmlWriter.Create(System.IO.Path.Combine(strBasePath, "TestFile.xml"), xwsSettings))
using (System.Xml.XmlWriter wr = new XmlTextWriterIndentedStandaloneNo(System.IO.Path.Combine(strBasePath, "TestFile.xml"), System.Text.Encoding.UTF8))
{
//wr.Formatting = System.Xml.Formatting.None; // here's the trick !
xdoc.Save(wr);
wr.Flush();
wr.Close();
} // End Using wr
Questa:
XmlWriterSettings xmlWriterSettings
= new XmlWriterSettings { OmitXmlDeclaration = true, };
ti darà questo:
<?xml version="1.0"?>