XMLシリアル化のためのStringWriterの使用

現在、オブジェクトをシリアル化する簡単な方法を探しています（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();

もう1つの問題は、最初の例でXMLが生成されて、SQL Server 2005 DBのXML列に書き込むことができなかったことです。

最初の質問は次のとおりです。後で文字列として必要になったときに、StringWriterを使用してオブジェクトをシリアル化しない理由はありますか？グーグルでStringWriterを使用した結果は見つかりませんでした。

2番目はもちろんです。もしStringWriterを（何らかの理由で）使用してはならない場合は、どちらが適切で正しい方法でしょうか。

添加：

両方の回答ですでに言及されているので、XMLからDBへの問題についてさらに説明します。

データベースに書き込むときに、次の例外が発生しました。

System.Data.SqlClient.SqlException：XML解析：行1、文字38、エンコードを切り替えることができません

文字列用

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

XmlTextWriterから作成した文字列を取り、そこにxmlとして配置しました。これは機能しませんでした（手動でDBに挿入した場合も同様）。

その後、手動での挿入（INSERT INTO ...を書くだけ）をencoding = "utf-16"で試みましたが、これも失敗しました。その後、エンコーディングを完全に削除しました。その結果、私は再びStringWriterコードに切り替えて、できあがりました-うまくいきました。

問題：理由がよくわかりません。

Christian Hayterで：これらのテストでは、DBへの書き込みに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」が前に付いていないため、UTF-8などの8ビットエンコーディングではない）を明確に挿入していました。NVARCHAR文字列ではありません（先頭に大文字の「N」が付いているため、16ビットのUTF-16 LEエンコーディング）。

修正は次のように簡単なはずです。

1. 最初のケースでは、次の宣言を追加する場合、encoding="utf-8"単にXML宣言を追加しないでください。
2. 宣言を追加するときに、第2のケースでは、述べencoding="utf-16"：いずれか
   1. 単にXML宣言を追加しない、または
   2. 入力パラメータタイプに「N」を追加するだけです：:)のSqlDbType.NVarChar代わりにSqlDbType.VarChar（または多分に切り替えて使用しますSqlDbType.Xml）

（詳細な応答は以下のとおりです）

ここでのすべての回答は複雑すぎて不必要です（クリスチャンの回答に対する121票とジョンの回答に対する184票に関係なく）。彼らは実際に機能するコードを提供するかもしれませんが、実際には誰も質問に答えません。問題は、最終的にSQL ServerのXMLデータ型がどのように機能するかについての質問を誰も本当に理解していなかったことです。これらの2人の明らかにインテリジェントな人々に対しては何もありませんが、この質問はXMLへのシリアル化とはほとんど関係がありません。XMLデータをSQL Serverに保存することは、ここに示されているものよりもはるかに簡単です。

SQL ServerでXMLデータを作成する方法のルールに従う限り、XMLがどのように生成されるかは重要ではありません。この質問の回答には、より詳細な説明（以下に概説するポイントを示すためのサンプルコードを含む）があります。SQLServerにXMLを挿入するときに「エンコードを切り替えられません」エラーを解決する方法ですが、基本は次のとおりです。

1. XML宣言はオプションです
2. XMLデータ型は文字列を常にUCS-2 / UTF-16 LEとして保存します
3. XMLがUCS-2 / UTF-16 LEの場合、次のようになります。
   1. NVARCHAR(MAX)またはXML/ SqlDbType.NVarChar（maxsize = -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ビットエンコーディングは、XMLデータ型によってUTF-16 LEに変換されます

上記のポイントを念頭に置き、.NETの文字列は常に UTF-16 LE / UCS-2 LEであることを前提として（エンコーディングに関してはそれらに違いはありません）、次の質問に答えることができます。

後で文字列として必要になったときに、StringWriterを使用してオブジェクトをシリアル化しない理由はありますか？

いいえ、StringWriterコードは問題ないようです（少なくとも、質問の2番目のコードブロックを使用した限定的なテストでは問題は発生しません）。

エンコーディングをUTF-16（xmlタグで）に設定すると機能しませんか？

XML宣言を提供する必要はありません。それがない場合、文字列をSQL ServerにNVARCHAR（ie SqlDbType.NVarChar）またはXML（ie SqlDbType.Xml）として渡すと、エンコーディングはUTF-16 LEであると見なされます。として渡される場合VARCHAR（つまりSqlDbType.VarChar）、エンコーディングはデフォルトの8ビットコードページであると想定されます。非標準のASCII文字（128以上の値）があり、として渡されているVARCHAR場合は、「？」が表示される可能性があります。BMP文字と「??」SQL Serverは、UTF-16文字列を.NETから現在のデータベースのコードページの8ビット文字列に変換してから、UTF-16 / UCS-2に戻すため、補助文字の場合。ただし、エラーは発生しません。

一方、XML宣言を指定する場合は、一致する8ビットまたは16ビットのデータ型を使用してSQL Serverに渡す必要があります。あなたがエンコードが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>

ご覧のように、ሴBMPコードポイントU + 1234であり、😸補助文字コードポイントU + 1F638であることから、標準のASCIIを超える文字も処理できます。ただし、次のとおりです。

-- 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に非標準のASCII文字が含まれている場合のデータ損失を防ぐため、XML宣言を保持および削除するよりも優先されます。例えば：

-- 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>

ご覧のとおり、今回はエラーは発生していませんが、データ損失が発生しています🙀。

問題の1つStringWriterは、デフォルトでは、アドバタイズするエンコーディングを設定できないことです。つまり、XMLドキュメントでエンコーディングを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をSQL Serverの「xml」データ型に挿入できます。

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テキストがXML <string></string>タグで囲まれます。

コード内のテーブルアダプターは、Visual Studio 2013の「新しいデータソースの追加：ウィザード」を使用して自動的に構築されるクラスです。Insertメソッドの5つのパラメーターは、SQL Serverテーブルのフィールドにマップされます。