Використання StringWriter для серіалізації XML

Зараз я шукаю простий спосіб серіалізації об’єктів (у C # 3).

Я погуглив кілька прикладів і придумав щось на зразок:

MemoryStream memoryStream = new MemoryStream ( );
XmlSerializer xs = new XmlSerializer ( typeof ( MyObject) );
XmlTextWriter xmlTextWriter = new XmlTextWriter ( memoryStream, Encoding.UTF8 );
xs.Serialize ( xmlTextWriter, myObject);
string result = Encoding.UTF8.GetString(memoryStream .ToArray());

Прочитавши це запитання, я запитав себе, чому б не використовувати StringWriter? Це здається набагато простіше.

XmlSerializer ser = new XmlSerializer(typeof(MyObject));
StringWriter writer = new StringWriter();
ser.Serialize(writer, myObject);
serializedValue = writer.ToString();

Ще одна проблема полягала в тому, що перший приклад, що генерував XML, я не міг просто записати у стовпець XML бази даних SQL Server 2005.

Перше питання: Чи є причина, чому я не повинен використовувати StringWriter для серіалізації об'єкта, коли мені він потрібен як рядок після цього? Я ніколи не знайшов результату за допомогою StringWriter під час гуглювання.

Друге, звичайно: Якщо ви не хочете робити це з StringWriter (з яких-небудь причин), що було б хорошим і правильним способом?

Доповнення:

Як уже було зазначено в обох відповідях, я продовжую переходити до проблеми XML до БД.

Під час написання до бази даних я отримав такий виняток:

System.Data.SqlClient.SqlException: Аналіз XML: рядок 1, символ 38, не в змозі переключити кодування

Для рядка

<?xml version="1.0" encoding="utf-8"?><test/>

Я взяв рядок, створений з XmlTextWriter, і просто поставив туди як xml. Це не спрацювало (ні з ручним вставленням у БД).

Після цього я спробував вставити вручну (просто писав INSERT INTO ...) з encoding = "utf-16", який також не вдався. Видалення кодування тоді повністю спрацювало. Після цього результату я перейшов до коду StringWriter і voila - він спрацював.

Проблема: я не дуже розумію, чому.

Крістіан Хейтер: За допомогою цих тестів я не впевнений, що мені потрібно використовувати utf-16 для запису в БД. Не вдалося б тоді встановити кодування на UTF-16 (у тезі xml)?

<TL; DR> Насправді проблема досить проста: ви не узгоджуєте заявлене кодування (у декларації XML) з типом даних вхідного параметра. Якщо ви вручну додали <?xml version="1.0" encoding="utf-8"?><test/>до рядка, то оголосивши SqlParameterтип типу SqlDbType.Xmlабо SqlDbType.NVarCharпризведе до помилки "не в змозі переключити кодування". Потім, вставляючи вручну через T-SQL, оскільки ви переключили заявлене кодування на таке utf-16, ви чітко вставляли VARCHARрядок (не префіксовану великим регістром "N", отже, 8-бітове кодування, наприклад UTF-8) а не NVARCHARрядок (з префіксом верхнього регістру "N", отже, 16-бітове кодування UTF-16 LE).

Виправлення повинно бути таким же простим, як:

1. У першому випадку, додаючи декларацію із зазначенням encoding="utf-8": просто не додайте декларацію XML.
2. У другому випадку при додаванні декларації із зазначенням encoding="utf-16": або
   1. просто не додайте декларацію XML, АБО
   2. просто додайте "N" до типу вхідного параметра: SqlDbType.NVarCharзамість SqlDbType.VarChar:-) (або, можливо, навіть переключитесь на використання SqlDbType.Xml)

(Детальна відповідь нижче)

Усі відповіді тут є надмірно складними та непотрібними (незалежно від 121 та 184 голосів за відповіді Крістіана та Йона відповідно). Вони можуть надати робочий код, але жоден з них насправді не відповідає на питання. Проблема полягає в тому, що ніхто по-справжньому не зрозумів питання, що в кінцевому підсумку полягає в тому, як працює тип даних XML на SQL Server. Нічого проти цих двох явно розумних людей, але це питання майже не має нічого спільного з серіалізацією до XML. Збереження XML-даних у SQL Server набагато простіше, ніж те, що тут мається на увазі.

Насправді не важливо, як виробляється XML, якщо ви дотримуєтесь правил створення XML-даних на SQL Server. У мене є більш ретельне пояснення (включаючи код робочого прикладу, щоб проілюструвати наведені нижче пункти) у відповіді на це запитання: Як вирішити помилку "не в змозі переключити кодування" під час вставки XML у SQL Server , але основними є:

1. Декларація XML не є обов'язковою
2. Тип XML зберігає рядки завжди як UCS-2 / UTF-16 LE
3. Якщо ваш XML - UCS-2 / UTF-16 LE, то ви:
   1. передавати дані як NVARCHAR(MAX)або XML/ / SqlDbType.NVarCharmaxsize = -1), або SqlDbType.Xml, якщо використовується літеральний рядок, то він повинен бути встановлений з великого регістру "N".
   2. якщо вказується декларація XML, вона повинна бути або "UCS-2", або "UTF-16" (тут немає ніякої реальної різниці)
4. Якщо ваш XML кодований 8-бітовим (наприклад, "UTF-8" / "iso-8859-1" / "Windows-1252"), ви:
   1. необхідно вказати декларацію XML, якщо кодування відрізняється від сторінки коду, визначеної зіставленням бази даних за замовчуванням
   2. ви повинні передавати дані як VARCHAR(MAX)/ SqlDbType.VarChar(maxsize = -1), або якщо ви використовуєте рядковий літерал, то він не повинен бути префіксом з великого регістру "N".
   3. Що б не використовувалося 8-бітове кодування, "кодування", зазначене в декларації XML, повинно відповідати фактичному кодуванню байтів.
   4. 8-бітове кодування буде перетворено в UTF-16 LE за типом даних XML

Зважаючи на окреслені вище пункти та враховуючи, що рядки в .NET завжди є UTF-16 LE / UCS-2 LE (різниці між кодуванням немає), ми можемо відповісти на ваші запитання:

Чи є причина, чому я не повинен використовувати StringWriter для серіалізації об'єкта, коли мені він потрібен як рядок після цього?

Ні, ваш StringWriterкод здається чудовим (принаймні, я не бачу проблем у своєму обмеженому тестуванні з використанням другого блоку коду з питання).

Не вдалося б тоді встановити кодування на UTF-16 (у тезі xml)?

Не потрібно надавати декларацію XML. Якщо він відсутній, кодування вважається UTF-16 LE, якщо ви передаєте рядок у SQL Server як NVARCHAR(тобто SqlDbType.NVarChar) або XML(тобто SqlDbType.Xml). Кодування вважається 8-бітовою кодовою сторінкою за замовчуванням, якщо вона передається як VARCHAR(тобто SqlDbType.VarChar). Якщо у вас є будь-які нестандартні символи ASCII (тобто значення 128 і вище) і передаються як " VARCHAR," ви, ймовірно, побачите "?" для символів BMP та "??" для додаткових символів як SQL Server перетворить рядок UTF-16 з .NET в 8-бітну рядок кодової сторінки поточної бази даних, перш ніж перетворити її назад в UTF-16 / UCS-2. Але ви не повинні отримувати жодних помилок.

З іншого боку, якщо ви вказуєте декларацію XML, вам потрібно перейти в SQL Server, використовуючи відповідний 8-бітний або 16-бітний тип даних. Отже, якщо у вас є декларація, що вказує, що кодування є або UCS-2, або UTF-16, ви повинні ввести як SqlDbType.NVarCharабо SqlDbType.Xml. Або, якщо у вас є заява про те , що кодування є одним з 8-бітних варіантів (тобто UTF-8, Windows-1252, iso-8859-1і т.д.), то ви повинні пройти як SqlDbType.VarChar. Невідповідність заявленого кодування правильному типу даних 8 або 16 біт SQL Server призведе до помилки "не в змозі переключити кодування", яку ви отримували.

Наприклад, використовуючи ваш StringWriterкод серіалізації на основі, я просто надрукував отриманий рядок XML і використав його в SSMS. Як ви бачите нижче, декларація XML включена (оскільки StringWriterне має можливості OmitXmlDeclarationподобатися XmlWriter), що не створює проблем, якщо ви передаєте рядок у правильний тип даних SQL Server:

-- Upper-case "N" prefix == NVARCHAR, hence no error:
DECLARE @Xml XML = N'<?xml version="1.0" encoding="utf-16"?>
<string>Test ሴ😸</string>';
SELECT @Xml;
-- <string>Test ሴ😸</string>

Як бачите, він навіть обробляє символи, що перевищують стандартний ASCII, враховуючи, що ሴце BMP- 😸кодова точка U + 1234, і є додатковою кодовою точкою коду U + 1F638. Однак наступне:

-- No upper-case "N" prefix on the string literal, hence VARCHAR:
DECLARE @Xml XML = '<?xml version="1.0" encoding="utf-16"?>
<string>Test ሴ😸</string>';

призводить до наступної помилки:

Msg 9402, Level 16, State 1, Line XXXXX
XML parsing: line 1, character 39, unable to switch the encoding

Ерго, все це пояснення вбік, повне рішення вашого початкового питання:

Ви чітко передавали рядок як SqlDbType.VarChar. Перейдіть на, SqlDbType.NVarCharі він працюватиме без необхідності пройти додатковий крок видалення декларації XML. Це краще, ніж зберігання SqlDbType.VarCharта видалення декларації XML, оскільки це рішення запобігає втраті даних, коли XML включає нестандартні символи ASCII. Наприклад:

-- No upper-case "N" prefix on the string literal == VARCHAR, and no XML declaration:
DECLARE @Xml2 XML = '<string>Test ሴ😸</string>';
SELECT @Xml2;
-- <string>Test ???</string>

Як бачите, помилок цього разу немає, але зараз є втрата даних 🙀.

Одна з проблем StringWriterполягає в тому, що за замовчуванням він не дозволяє встановити кодування, яке він рекламує - так що ви можете закінчити документ XML, що рекламує його кодування як UTF-16, а це означає, що вам потрібно кодувати його як UTF-16, якщо ви запишіть його у файл. У мене є невеликий клас, який допоможе з цим:

public sealed class StringWriterWithEncoding : StringWriter
{
    public override Encoding Encoding { get; }

    public StringWriterWithEncoding (Encoding encoding)
    {
        Encoding = encoding;
    }    
}

Або якщо вам потрібен лише UTF-8 (а це все, що мені часто потрібно):

public sealed class Utf8StringWriter : StringWriter
{
    public override Encoding Encoding => Encoding.UTF8;
}

Що стосується того, чому ви не змогли зберегти свій XML у базі даних, вам доведеться повідомити нам більше подробиць про те, що сталося під час спроби, якщо ви хочете, щоб ми змогли це діагностувати / виправити.

Під час послідовного введення XML-документа в рядок .NET кодування повинно бути встановлено на UTF-16. Струни зберігаються як UTF-16 внутрішньо, тому це єдине кодування, яке має сенс. Якщо ви хочете зберігати дані в іншому кодуванні, замість цього ви використовуєте байтовий масив.

SQL Server працює за аналогічним принципом; будь-яка рядок, що передається у xmlстовпець, повинна кодуватися як UTF-16. SQL Server відхилить будь-який рядок, де в декларації XML не вказано UTF-16. Якщо декларація XML відсутня, тоді стандарт XML вимагає, щоб за замовчуванням він використовував UTF-8, тому SQL Server також відхилить це.

Маючи це на увазі, ось деякі корисні методи здійснення конверсії.

public static string Serialize<T>(T value) {

    if(value == null) {
        return null;
    }

    XmlSerializer serializer = new XmlSerializer(typeof(T));

    XmlWriterSettings settings = new XmlWriterSettings()
    {
        Encoding = new UnicodeEncoding(false, false), // no BOM in a .NET string
        Indent = false,
        OmitXmlDeclaration = false
    };

    using(StringWriter textWriter = new StringWriter()) {
        using(XmlWriter xmlWriter = XmlWriter.Create(textWriter, settings)) {
            serializer.Serialize(xmlWriter, value);
        }
        return textWriter.ToString();
    }
}

public static T Deserialize<T>(string xml) {

    if(string.IsNullOrEmpty(xml)) {
        return default(T);
    }

    XmlSerializer serializer = new XmlSerializer(typeof(T));

    XmlReaderSettings settings = new XmlReaderSettings();
    // No settings need modifying here

    using(StringReader textReader = new StringReader(xml)) {
        using(XmlReader xmlReader = XmlReader.Create(textReader, settings)) {
            return (T) serializer.Deserialize(xmlReader);
        }
    }
}

Перш за все, остерігайтеся пошуку старих прикладів. Ви знайшли такий, що використовує XmlTextWriter, який не підтримується на .NET 2.0. XmlWriter.Createслід використовувати замість цього.

Ось приклад серіалізації об’єкта в стовпець XML:

public void SerializeToXmlColumn(object obj)
{
    using (var outputStream = new MemoryStream())
    {
        using (var writer = XmlWriter.Create(outputStream))
        {
            var serializer = new XmlSerializer(obj.GetType());
            serializer.Serialize(writer, obj);
        }

        outputStream.Position = 0;
        using (var conn = new SqlConnection(Settings.Default.ConnectionString))
        {
            conn.Open();

            const string INSERT_COMMAND = @"INSERT INTO XmlStore (Data) VALUES (@Data)";
            using (var cmd = new SqlCommand(INSERT_COMMAND, conn))
            {
                using (var reader = XmlReader.Create(outputStream))
                {
                    var xml = new SqlXml(reader);

                    cmd.Parameters.Clear();
                    cmd.Parameters.AddWithValue("@Data", xml);
                    cmd.ExecuteNonQuery();
                }
            }
        }
    }
}

public static T DeserializeFromXml<T>(string xml)
{
    T result;
    XmlSerializerFactory serializerFactory = new XmlSerializerFactory();
    XmlSerializer serializer =serializerFactory.CreateSerializer(typeof(T));

    using (StringReader sr3 = new StringReader(xml))
    {
        XmlReaderSettings settings = new XmlReaderSettings()
        {
            CheckCharacters = false // default value is true;
        };

        using (XmlReader xr3 = XmlTextReader.Create(sr3, settings))
        {
            result = (T)serializer.Deserialize(xr3);
        }
    }

    return result;
}

Можливо, це було охоплено в іншому місці, але просто зміна рядка кодування джерела XML на 'utf-16' дозволяє XML вставляти у тип xml'data типу SQL Server.

using (DataSetTableAdapters.SQSTableAdapter tbl_SQS = new DataSetTableAdapters.SQSTableAdapter())
{
    try
    {
        bodyXML = @"<?xml version="1.0" encoding="UTF-8" standalone="yes"?><test></test>";
        bodyXMLutf16 = bodyXML.Replace("UTF-8", "UTF-16");
        tbl_SQS.Insert(messageID, receiptHandle, md5OfBody, bodyXMLutf16, sourceType);
    }
    catch (System.Data.SqlClient.SqlException ex)
    {
        Console.WriteLine(ex.Message);
        Console.ReadLine();
    }
}

В результаті весь текст XML вставляється в поле типу "xml", але рядок "header" видаляється. Те, що ви бачите в отриманому записі, просто

<test></test>

Використання методу серіалізації, описаного у записі "Відповів", є способом включення оригінального заголовка в цільове поле, але результат полягає в тому, що текст, що залишився XML, укладений у <string></string>тег XML .

Адаптер таблиці в коді - це клас, автоматично створений за допомогою Visual Studio 2013 "Майстер додавання нового джерела даних: майстер. П'ять параметрів до карти методу" Вставити "до полів у таблиці SQL Server.