有没有办法在序列化 XML 时*只*删除 xmlns:xsd 命名空间?
Is there a way to remove *only* the xmlns:xsd namespace when serializing a XML?
我使用 xsd2code++ 创建了一个序列化对象。它工作正常,但以下情况除外:
出于某种原因,我需要发送的 XML 需要有一些命名空间,但 xsd 不需要(即使,据我所知,列出应该没有问题它,但这不是我的电话)。我在生成的 c# class 中有以下代码:
[XmlNamespaceDeclarations]
public XmlSerializerNamespaces xmlns;
[XmlAttribute("schemaLocation", Namespace = XmlSchema.InstanceNamespace)]
public string xsiSchemaLocation = "http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd";
public TimbreFiscalDigital()
{
this.versionField = "1.1";
this.xmlns = new XmlSerializerNamespaces();
this.xmlns.Add("tfd", "http://www.sat.gob.mx/TimbreFiscalDigital");
this.xmlns.Add("xsi", "http://www.w3.org/2001/XMLSchema-instance");
}
在 class 本身的属性中,我有以下内容:
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true, Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital")]
[System.Xml.Serialization.XmlRootAttribute(Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital", IsNullable = false)]
但是 XML 包括 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
命名空间声明。
我在这里看到了关于如何完全删除用于序列化的命名空间的不同答案,但这不是我要找的,我只希望我设置的那些是唯一序列化的。
有什么方法可以删除 xsd 序列化程序,而不求助于自定义 xml 序列化程序或类似的东西?我觉得可能有一些我可以设置的属性或选项(或者我设置不正确)会影响这个,但我没有在对象的代码中看到任何对 xsd
的引用。我已经通过 XmlSerializer.Serialize()
.
直接调用了序列化程序
XmlNamespaceDeclarationsAttribute
不影响根元素的名称空间前缀的原因在其 documentation:
中得到了解释,尽管还不清楚
Also note that the member to which the attribute is applied contains only the prefix-namespace pairs that belong to the XML element defined by the class. For example, in the following XML document, only the prefix pair "cal" is captured, but not the "x" prefix. To get that data, add a member with the XmlNamespaceDeclarationsAttribute to the class that represents the root
element.
<?xml version="1.0"?>
<x:root xmlns:x="http://www.cohowinery.com/x/">
<x:select xmlns:cal="http://www.cohowinery.com/calendar/" path="cal:appointments/@cal:startTime" />
</x:root>
含义是返回的前缀-命名空间对将被添加到当前元素的属性中,并在序列化子元素时使用(那些属于当前元素) -- 但不会影响当前元素本身的命名空间前缀。为此,必须向 parent 添加一个 XmlNamespaceDeclarationsAttribute
成员——当然,根元素没有父元素。
在没有控制根元素的命名空间前缀的属性的情况下,必须使用其 XmlSerializer.Serialize(Writer, Object, XmlSerializerNamespaces)
overloads. If you use an overload of Serialize()
that doesn't include an XmlSerializerNamespaces
, such as XmlSerializer.Serialize(XmlWriter, Object)
之一手动调用 XmlSerializer
,然后序列化程序将始终有用地添加一个默认值根元素的命名空间集,包括:
- 根元素本身需要的命名空间;
- 标准 "xsd" 和 "xsi" 命名空间;
- 子节点需要额外的命名空间;
XmlNamespaceDeclarations
成员返回的其他命名空间。
这就是您看到的行为。
因此,以下扩展方法将根据需要序列化您的根对象:
public static partial class XmlSerializationHelper
{
public static string GetXml<T>(this T obj, XmlSerializer serializer = null, XmlSerializerNamespaces ns = null)
{
ns = ns ?? obj.GetXmlNamespaceDeclarations();
using (var textWriter = new StringWriter())
{
var settings = new XmlWriterSettings() { Indent = true }; // For cosmetic purposes.
using (var xmlWriter = XmlWriter.Create(textWriter, settings))
(serializer ?? new XmlSerializer(obj.GetType())).Serialize(xmlWriter, obj, ns);
return textWriter.ToString();
}
}
public static XmlSerializerNamespaces GetXmlNamespaceDeclarations<T>(this T obj)
{
if (obj == null)
return null;
var type = obj.GetType();
return type.GetFields()
.Where(f => Attribute.IsDefined(f, typeof(XmlNamespaceDeclarationsAttribute)))
.Select(f => f.GetValue(obj))
.Concat(type.GetProperties()
.Where(p => Attribute.IsDefined(p, typeof(XmlNamespaceDeclarationsAttribute)))
.Select(p => p.GetValue(obj, null)))
.OfType<XmlSerializerNamespaces>()
.SingleOrDefault();
}
public static XmlSerializerNamespaces With(this XmlSerializerNamespaces xmlns, string prefix, string ns)
{
if (xmlns == null)
throw new ArgumentNullException();
xmlns.Add(prefix, ns);
return xmlns;
}
}
那么如果你按如下方式序列化你的类型:
var root = new TimbreFiscalDigital();
var xml = root.GetXml();
生成如下XML:
<tfd:TimbreFiscalDigital xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd" xmlns:tfd="http://www.sat.gob.mx/TimbreFiscalDigital">
<tfd:version>1.1</tfd:version>
</tfd:TimbreFiscalDigital>
示例 fiddle.
顺便说一句,如果TimbreFiscalDigital.xmlns
返回的命名空间是固定的,你不需要在反序列化过程中捕获它们,你可以用属性替换该字段,其中[XmlNamespaceDeclarations]
应用,像这样:
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true, Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital")]
[System.Xml.Serialization.XmlRootAttribute(Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital", IsNullable = false)]
public class TimbreFiscalDigital
{
string versionField;
//[XmlAttribute]
public string version { get { return versionField; } set { versionField = value; } }
[XmlNamespaceDeclarations]
public XmlSerializerNamespaces Xmlns
{
get
{
return new XmlSerializerNamespaces()
.With("tfd", "http://www.sat.gob.mx/TimbreFiscalDigital")
.With("xsi", XmlSchema.InstanceNamespace);
}
set { /* Do nothing */ }
}
[XmlAttribute("schemaLocation", Namespace = XmlSchema.InstanceNamespace)]
public string xsiSchemaLocation = "http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd";
public TimbreFiscalDigital()
{
this.versionField = "1.1";
}
}
属性必须同时有getter和setter,但是setter无能为力,而getter总是returns XmlSerializerNamespaces
的新实例。通过这样做,您可以减少 class.
的永久内存占用
示例 fiddle #2.
我使用 xsd2code++ 创建了一个序列化对象。它工作正常,但以下情况除外:
出于某种原因,我需要发送的 XML 需要有一些命名空间,但 xsd 不需要(即使,据我所知,列出应该没有问题它,但这不是我的电话)。我在生成的 c# class 中有以下代码:
[XmlNamespaceDeclarations]
public XmlSerializerNamespaces xmlns;
[XmlAttribute("schemaLocation", Namespace = XmlSchema.InstanceNamespace)]
public string xsiSchemaLocation = "http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd";
public TimbreFiscalDigital()
{
this.versionField = "1.1";
this.xmlns = new XmlSerializerNamespaces();
this.xmlns.Add("tfd", "http://www.sat.gob.mx/TimbreFiscalDigital");
this.xmlns.Add("xsi", "http://www.w3.org/2001/XMLSchema-instance");
}
在 class 本身的属性中,我有以下内容:
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true, Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital")]
[System.Xml.Serialization.XmlRootAttribute(Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital", IsNullable = false)]
但是 XML 包括 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
命名空间声明。
我在这里看到了关于如何完全删除用于序列化的命名空间的不同答案,但这不是我要找的,我只希望我设置的那些是唯一序列化的。
有什么方法可以删除 xsd 序列化程序,而不求助于自定义 xml 序列化程序或类似的东西?我觉得可能有一些我可以设置的属性或选项(或者我设置不正确)会影响这个,但我没有在对象的代码中看到任何对 xsd
的引用。我已经通过 XmlSerializer.Serialize()
.
XmlNamespaceDeclarationsAttribute
不影响根元素的名称空间前缀的原因在其 documentation:
Also note that the member to which the attribute is applied contains only the prefix-namespace pairs that belong to the XML element defined by the class. For example, in the following XML document, only the prefix pair "cal" is captured, but not the "x" prefix. To get that data, add a member with the XmlNamespaceDeclarationsAttribute to the class that represents the
root
element.<?xml version="1.0"?> <x:root xmlns:x="http://www.cohowinery.com/x/"> <x:select xmlns:cal="http://www.cohowinery.com/calendar/" path="cal:appointments/@cal:startTime" /> </x:root>
含义是返回的前缀-命名空间对将被添加到当前元素的属性中,并在序列化子元素时使用(那些属于当前元素) -- 但不会影响当前元素本身的命名空间前缀。为此,必须向 parent 添加一个 XmlNamespaceDeclarationsAttribute
成员——当然,根元素没有父元素。
在没有控制根元素的命名空间前缀的属性的情况下,必须使用其 XmlSerializer.Serialize(Writer, Object, XmlSerializerNamespaces)
overloads. If you use an overload of Serialize()
that doesn't include an XmlSerializerNamespaces
, such as XmlSerializer.Serialize(XmlWriter, Object)
之一手动调用 XmlSerializer
,然后序列化程序将始终有用地添加一个默认值根元素的命名空间集,包括:
- 根元素本身需要的命名空间;
- 标准 "xsd" 和 "xsi" 命名空间;
- 子节点需要额外的命名空间;
XmlNamespaceDeclarations
成员返回的其他命名空间。
这就是您看到的行为。
因此,以下扩展方法将根据需要序列化您的根对象:
public static partial class XmlSerializationHelper
{
public static string GetXml<T>(this T obj, XmlSerializer serializer = null, XmlSerializerNamespaces ns = null)
{
ns = ns ?? obj.GetXmlNamespaceDeclarations();
using (var textWriter = new StringWriter())
{
var settings = new XmlWriterSettings() { Indent = true }; // For cosmetic purposes.
using (var xmlWriter = XmlWriter.Create(textWriter, settings))
(serializer ?? new XmlSerializer(obj.GetType())).Serialize(xmlWriter, obj, ns);
return textWriter.ToString();
}
}
public static XmlSerializerNamespaces GetXmlNamespaceDeclarations<T>(this T obj)
{
if (obj == null)
return null;
var type = obj.GetType();
return type.GetFields()
.Where(f => Attribute.IsDefined(f, typeof(XmlNamespaceDeclarationsAttribute)))
.Select(f => f.GetValue(obj))
.Concat(type.GetProperties()
.Where(p => Attribute.IsDefined(p, typeof(XmlNamespaceDeclarationsAttribute)))
.Select(p => p.GetValue(obj, null)))
.OfType<XmlSerializerNamespaces>()
.SingleOrDefault();
}
public static XmlSerializerNamespaces With(this XmlSerializerNamespaces xmlns, string prefix, string ns)
{
if (xmlns == null)
throw new ArgumentNullException();
xmlns.Add(prefix, ns);
return xmlns;
}
}
那么如果你按如下方式序列化你的类型:
var root = new TimbreFiscalDigital();
var xml = root.GetXml();
生成如下XML:
<tfd:TimbreFiscalDigital xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd" xmlns:tfd="http://www.sat.gob.mx/TimbreFiscalDigital">
<tfd:version>1.1</tfd:version>
</tfd:TimbreFiscalDigital>
示例 fiddle.
顺便说一句,如果TimbreFiscalDigital.xmlns
返回的命名空间是固定的,你不需要在反序列化过程中捕获它们,你可以用属性替换该字段,其中[XmlNamespaceDeclarations]
应用,像这样:
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true, Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital")]
[System.Xml.Serialization.XmlRootAttribute(Namespace = "http://www.sat.gob.mx/TimbreFiscalDigital", IsNullable = false)]
public class TimbreFiscalDigital
{
string versionField;
//[XmlAttribute]
public string version { get { return versionField; } set { versionField = value; } }
[XmlNamespaceDeclarations]
public XmlSerializerNamespaces Xmlns
{
get
{
return new XmlSerializerNamespaces()
.With("tfd", "http://www.sat.gob.mx/TimbreFiscalDigital")
.With("xsi", XmlSchema.InstanceNamespace);
}
set { /* Do nothing */ }
}
[XmlAttribute("schemaLocation", Namespace = XmlSchema.InstanceNamespace)]
public string xsiSchemaLocation = "http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd";
public TimbreFiscalDigital()
{
this.versionField = "1.1";
}
}
属性必须同时有getter和setter,但是setter无能为力,而getter总是returns XmlSerializerNamespaces
的新实例。通过这样做,您可以减少 class.
示例 fiddle #2.