Как задать собственные namespace'ы для дочерних элементов при сериализации в XML?

Question

[AleDv]

Всем привет. У меня стоит задача сформировать несколько SOAP запросов. Для того, чтобы получить структуры в XML я пишу класс под каждый запрос. В каждом запросе есть свой элемент Header со своим namespace. Header для каждого запроса состоит из одинаковых полей, но namespace зависят от запроса.

Например, запросы:

public class Request {
    [XmlElement(ElementName = "Header", Namespace = "http://example1.com")]
    public Header HeaderRequest;

}

public class AnotherRequest {
    [XmlElement(ElementName = "Header", Namespace = "http://site.com")]
    public Header HeaderRequest;
}

Сам класс Header имеет такую структуру:

public class Header {
    [XmlElement(ElementName = "Sender")]
    public string Sender;
	
	[XmlElement(ElementName = "Reciever")]
    public string Reciever;
}

При этом, мне нужно использовать разные namespace внутри Header в завивимости от запроса, например для Request внутри Header должен быть префикс v11="example1.com/v11", а для AnotherRequest внутри Header должен быть префикс v22="site.com/v22", чтобы получить примерно такие XML на выходе:

<Request>
	<v1:Header>
		<v11:Sender />
		<v11:Reciever />
	</v1:Header>
</Request>

и

<AnotherRequest>
	<v2:Header>
		<v22:Sender />
		<v22:Reciever />
	</v2:Header>
</AnotherRequest>

Я могу так сделать, если для каждого запроса писать свой собственный Header, где для каждого элемента прописывать свои пространства имён, но тогда получается куча дублированного кода, если число запросов будет постоянно расти, поэтому хотелось бы использовать один Header и каким-то образом управлять пространствами имен для его дочерних элементов.

В c# я не силён, возможно, я что-то упускаю. Прощения прощения за сумбурность.

UPD. Поправил ожидаемый XML, писал вечером, видимо совсем поплыл. Прощу прощения.

Answer 1

[cicatrix]

Управление пространствами имён в XML-документе

Comments

[AleDv]

Вы предлагаете использовать XmlNamespaceManager? Если да, то каким образом мне задать пространства имен для тегов Sender и Reciever для каждого запроса свои?

[cicatrix]

AleDv, А в чём проблема-то? Для одного запроса один префикс, для другого-другой
Кстати, у вас опечатка:

<AnotherRequest>
  <Header xmlns:v1="http://site.com">
    <v2:Sender />
    <v2:Reciever />
  </Header>
</AnotherRequest>

Вместо v2 должно быть v1

Именно для того, чтобы атрибутами не метить жёстко каждый тэг, используйте менеджер.
Покажите, код, где генерится сам Header

[AleDv]

Я прощу прощения, сейчас перечитал вопрос и нашёл ошибки в том XML, который я ожидаю. Исправил.

Для сериализации я использую общий метод, в который передаю тип запроса, объект запроса и список пространств имён, который мне нужно использовать при сериализации:

public static string Serialize(Type objectType, object obj, XmlSerializerNamespaces namespaces)
        {
            StringBuilder stringBuilder = new StringBuilder();
            XmlWriterSettings xmlSettings = new XmlWriterSettings() { OmitXmlDeclaration = true };
            XmlWriter t_writer = XmlWriter.Create(stringBuilder, xmlSettings);
            new XmlSerializer(objectType).Serialize(t_writer, obj, namespaces);
            t_writer.Flush();
            t_writer.Close();

            return stringBuilder.ToString();
        }

Проблема в том, что я не знаю, как указать пространства имён для внутренних элементов Header для одного запроса как example1.com/v11, для другого sitecom/v22, кроме как гвоздями их прибивать, и делать свой Header на каждый запрос на подобии:

public class Header {
    [XmlElement(ElementName = "Sender", Namespace = "example1.com/v11")]
    public string Sender;
  
  [XmlElement(ElementName = "Reciever, Namespace = "example1.com/v11"")]
    public string Reciever;
}

и

public class Header {
    [XmlElement(ElementName = "Sender", Namespace = "site.com/v22")]
    public string Sender;
  
  [XmlElement(ElementName = "Reciever, Namespace = "site.com/v22"")]
    public string Reciever;
}

[cicatrix]

AleDv, Тут-то вам и придёт на помощь менеджер. Сделайте 2 разных и подсовывайте их в зависимости от ситуации.

[AleDv]

cicatrix, можете привести пример? Не понимаю, как я могу его использовать при сериализации класса в XML.

[cicatrix]

AleDv, Да, немного не туда посмотрел.
Вам нужна вот эта перегрузка для Serialize

public void Serialize (System.IO.Stream stream, object? o, System.Xml.Serialization.XmlSerializerNamespaces? namespaces);

Вот тут есть пример:
https://docs.microsoft.com/ru-ru/dotnet/api/system...

Используйте разные экземпляры XmlSerializerNamespaces

[AleDv]

cicatrix, я так и делаю, но это сработает только при жёстком указании Namespace в классе, как здесь:

[XmlElement(ElementName = "Sender", Namespace = "site.com/v22")]
    public string Sender;

[cicatrix]

AleDv, Хммм... даже не ожидал, что у XMLSerializer такие проблемы. Поискал на SO, действительно, без бубна не получится.

Но вот я вам набросал "бубен". Вроде работает:

using System;
using System.Text;
using System.Xml;
using System.Xml.Serialization;

namespace ConsoleAppTest
{
    public class Header
    {
        [XmlElement(elementName:"Sender", Namespace = "http://www.site1.com")]
        public string Sender;
        [XmlElement(elementName: "Receiver", Namespace = "http://www.site1.com")]
        public string Receiver;
    }

    class Program
    {
        static void Main(string[] args)
        {
            Header header1 = new Header() { Sender = "SND1", Receiver = "RCV1" };
            Header header2 = new Header() { Sender = "SND2", Receiver = "RCV2" };

            XmlSerializerNamespaces nm = new XmlSerializerNamespaces();
            nm.Add("v1", "http://www.site1.com");


            Console.WriteLine("No override:\n");
            StringBuilder sb = new StringBuilder();
            XmlWriterSettings settings = new XmlWriterSettings() { OmitXmlDeclaration = true, Indent = true };
            XmlWriter t_writer = XmlWriter.Create(sb, settings);
            new XmlSerializer(typeof(Header)).Serialize(t_writer, header1, nm);
            t_writer.Flush();
            Console.WriteLine(sb.ToString());

            Console.WriteLine("\nWith override:\n");

            nm = new XmlSerializerNamespaces();
            nm.Add("v2", "http://www.site2.com");

            XmlAttributes overrideAttributes_sender = new XmlAttributes();
            XmlAttributes overrideAttributes_receiver = new XmlAttributes();
            overrideAttributes_sender.XmlElements.Add(
                new XmlElementAttribute("Sender") { Namespace = "http://www.site2.com" });
            overrideAttributes_receiver.XmlElements.Add(
                new XmlElementAttribute("Receiver") { Namespace = "http://www.site2.com" });
                        
            XmlAttributeOverrides attr_overrides = new XmlAttributeOverrides();
            attr_overrides.Add(typeof(Header), "Sender", overrideAttributes_sender);
            attr_overrides.Add(typeof(Header), "Receiver", overrideAttributes_receiver);


            sb = new StringBuilder();
            t_writer = XmlWriter.Create(sb, settings);
            new XmlSerializer(typeof(Header), attr_overrides).Serialize(t_writer, header2, nm);
            t_writer.Flush();
            Console.WriteLine(sb.ToString());

            Console.ReadLine();
        } // Main
    } // class Program
} // namespace

Вывод такой:

No override:

<Header xmlns:v1="http://www.site1.com">
  <v1:Sender>SND1</v1:Sender>
  <v1:Receiver>RCV1</v1:Receiver>
</Header>

With override:

<Header xmlns:v2="http://www.site2.com">
  <v2:Sender>SND2</v2:Sender>
  <v2:Receiver>RCV2</v2:Receiver>
</Header>

[cicatrix]

AleDv, Только имейте в виду, что указанный способ в памяти каждый раз будет создавать виртуальную сборку, так что лучше всего Serializer не прибивать и не создавать каждый раз при помощи new, а создать сразу нужное количество и держать до следующего раза.