Sử dụng StringWriter để tuần tự hóa XML

Tôi hiện đang tìm kiếm một cách dễ dàng để tuần tự hóa các đối tượng (trong C # 3).

Tôi tìm kiếm một số ví dụ và nghĩ ra một cái gì đó như:

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());

Sau khi đọc câu hỏi này, tôi đã tự hỏi mình, tại sao không sử dụng StringWriter? Nó có vẻ dễ dàng hơn nhiều.

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

Một vấn đề khác là ví dụ đầu tiên tạo ra XML, tôi không thể chỉ ghi vào một cột XML của SQL Server 2005 DB.

Câu hỏi đầu tiên là: Có lý do gì tôi không nên sử dụng StringWriter để tuần tự hóa một Đối tượng khi tôi cần nó dưới dạng chuỗi sau đó không? Tôi không bao giờ tìm thấy kết quả bằng cách sử dụng StringWriter khi googling.

Tất nhiên, điều thứ hai là: Nếu bạn không nên làm điều đó với StringWriter (vì bất kỳ lý do gì), thì đó sẽ là một cách tốt và đúng?

Thêm vào:

Vì nó đã được đề cập trong cả hai câu trả lời, tôi sẽ đi sâu hơn vào vấn đề XML với DB.

Khi ghi vào Cơ sở dữ liệu, tôi có ngoại lệ sau:

System.Data.SqlClient.SqlException: Phân tích cú pháp XML: dòng 1, ký tự 38, không thể chuyển đổi mã hóa

Đối với chuỗi

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

Tôi lấy chuỗi được tạo từ XmlTextWriter và chỉ cần đặt dưới dạng xml ở đó. Cái này không hoạt động (cả khi chèn thủ công vào DB).

Sau đó, tôi đã thử chèn thủ công (chỉ viết INSERT INTO ...) với encoding = "utf-16" mà cũng không thành công. Sau đó, việc xóa mã hóa hoàn toàn hoạt động. Sau kết quả đó, tôi quay lại mã StringWriter và thì đấy - nó đã hoạt động.

Vấn đề: Tôi không thực sự hiểu tại sao.

tại Christian Hayter: Với những bài kiểm tra đó, tôi không chắc rằng mình phải sử dụng utf-16 để ghi vào DB. Sau đó, đặt mã hóa thành UTF-16 (trong thẻ xml) sẽ không hoạt động?

<TL; DR> Thực ra vấn đề khá đơn giản: bạn không khớp kiểu mã hóa đã khai báo (trong khai báo XML) với kiểu dữ liệu của tham số đầu vào. Nếu bạn đã thêm vào <?xml version="1.0" encoding="utf-8"?><test/>chuỗi theo cách thủ công , thì việc khai báo SqlParameterthuộc loại SqlDbType.Xmlhoặc SqlDbType.NVarCharsẽ cho bạn lỗi "không thể chuyển đổi mã hóa". Sau đó, khi chèn theo cách thủ công qua T-SQL, vì bạn đã chuyển mã hóa đã khai báo thành utf-16, rõ ràng bạn đang chèn một VARCHARchuỗi (không có tiền tố bằng chữ hoa "N", do đó là mã hóa 8 bit, chẳng hạn như UTF-8) và không phải là mộtNVARCHAR chuỗi (có tiền tố là "N" viết hoa, do đó là mã hóa UTF-16 LE 16 bit).

Cách khắc phục phải đơn giản như sau:

1. Trong trường hợp đầu tiên, khi thêm khai báo nêu rõ encoding="utf-8" : chỉ cần không thêm khai báo XML.
2. Trong trường hợp thứ hai, khi thêm khai báo nêu rõ encoding="utf-16":
   1. đơn giản là không thêm khai báo XML, HOẶC
   2. chỉ cần thêm "N" vào kiểu tham số đầu vào: SqlDbType.NVarCharthay vì SqlDbType.VarChar:-) (hoặc thậm chí có thể chuyển sang sử dụng SqlDbType.Xml)

(Phản hồi chi tiết ở bên dưới)

Tất cả các câu trả lời ở đây đều quá phức tạp và không cần thiết (bất kể 121 và 184 phiếu thuận cho câu trả lời của Christian và Jon tương ứng). Họ có thể cung cấp mã làm việc, nhưng không ai trong số họ thực sự trả lời câu hỏi. Vấn đề là không ai thực sự hiểu câu hỏi, cuối cùng là về cách hoạt động của kiểu dữ liệu XML trong SQL Server. Không có gì chống lại hai người rõ ràng thông minh đó, nhưng câu hỏi này không liên quan gì đến việc tuần tự hóa sang XML. Lưu dữ liệu XML vào SQL Server dễ dàng hơn nhiều so với những gì đang được ngụ ý ở đây.

Việc tạo ra XML như thế nào không thực sự quan trọng, miễn là bạn tuân theo các quy tắc về cách tạo dữ liệu XML trong SQL Server. Tôi có giải thích kỹ lưỡng hơn (bao gồm mã ví dụ làm việc để minh họa các điểm được nêu bên dưới) trong câu trả lời cho câu hỏi này: Cách giải quyết lỗi "không thể chuyển đổi mã hóa" khi chèn XML vào SQL Server , nhưng những điều cơ bản là:

1. Khai báo XML là tùy chọn
2. Kiểu dữ liệu XML luôn lưu trữ các chuỗi dưới dạng UCS-2 / UTF-16 LE
3. Nếu XML của bạn là UCS-2 / UTF-16 LE, thì bạn:
   1. chuyển vào dữ liệu dưới dạng NVARCHAR(MAX)hoặc hoặc XML/ SqlDbType.NVarChar(maxsize = -1) hoặc SqlDbType.Xml, hoặc nếu sử dụng một chuỗi ký tự thì nó phải được đặt trước bằng chữ hoa "N".
   2. nếu chỉ định khai báo XML, nó phải là "UCS-2" hoặc "UTF-16" (không có sự khác biệt thực sự ở đây)
4. Nếu XML của bạn được mã hóa 8 bit (ví dụ: "UTF-8" / "iso-8859-1" / "Windows-1252"), thì bạn:
   1. cần chỉ định khai báo XML NẾU mã hóa khác với trang mã được chỉ định bởi Đối chiếu mặc định của cơ sở dữ liệu
   2. bạn phải chuyển vào dữ liệu dưới dạng VARCHAR(MAX)/ SqlDbType.VarChar(maxsize = -1), hoặc nếu sử dụng một chuỗi ký tự thì nó không được bắt đầu bằng chữ hoa "N".
   3. Dù sử dụng cách mã hóa 8 bit nào, thì "mã hóa" được ghi chú trong khai báo XML phải khớp với mã hóa thực tế của các byte.
   4. Mã hóa 8 bit sẽ được chuyển đổi thành UTF-16 LE bởi kiểu dữ liệu XML

Với những điểm đã nêu ở trên và cho rằng các chuỗi trong .NET luôn là UTF-16 LE / UCS-2 LE (không có sự khác biệt giữa các chuỗi về mặt mã hóa), chúng tôi có thể trả lời câu hỏi của bạn:

Có lý do gì mà tôi không nên sử dụng StringWriter để tuần tự hóa một Đối tượng khi tôi cần nó dưới dạng chuỗi sau đó không?

Không, StringWritermã của bạn có vẻ ổn (ít nhất tôi không thấy có vấn đề gì trong thử nghiệm giới hạn của mình bằng cách sử dụng khối mã thứ 2 từ câu hỏi).

Sau đó, đặt mã hóa thành UTF-16 (trong thẻ xml) sẽ không hoạt động?

Không cần thiết phải cung cấp khai báo XML. Khi nó bị thiếu, mã hóa được giả định là UTF-16 LE nếu bạn chuyển chuỗi vào SQL Server dưới dạng NVARCHAR(tức là SqlDbType.NVarChar) hoặc XML(tức là SqlDbType.Xml). Mã hóa được giả định là Trang mã 8 bit mặc định nếu chuyển vào dưới dạng VARCHAR(tức là SqlDbType.VarChar). Nếu bạn có bất kỳ ký tự ASCII không chuẩn nào (tức là giá trị 128 trở lên) và đang chuyển vào dưới dạng VARCHAR, thì bạn có thể sẽ thấy "?" cho các ký tự BMP và "??" đối với Ký tự bổ sung vì SQL Server sẽ chuyển đổi chuỗi UTF-16 từ .NET thành chuỗi 8 bit của Trang mã của cơ sở dữ liệu hiện tại trước khi chuyển đổi lại thành UTF-16 / UCS-2. Nhưng bạn sẽ không nhận được bất kỳ lỗi nào.

Mặt khác, nếu bạn chỉ định khai báo XML, thì bạn phải chuyển vào SQL Server bằng cách sử dụng kiểu dữ liệu 8 bit hoặc 16 bit phù hợp. Vì vậy, nếu bạn có một khai báo cho biết mã hóa là UCS-2 hoặc UTF-16, thì bạn phải nhập bằng SqlDbType.NVarCharhoặc SqlDbType.Xml. Hoặc, nếu bạn có một tuyên bố nói rằng các mã hóa là một trong những lựa chọn 8-bit (ví dụ UTF-8, Windows-1252, iso-8859-1, vv), sau đó bạn phải vượt qua trong khi SqlDbType.VarChar. Không khớp mã hóa đã khai báo với kiểu dữ liệu SQL Server 8 hoặc 16 bit thích hợp sẽ dẫn đến lỗi "không thể chuyển đổi mã hóa" mà bạn đang gặp phải.

Ví dụ, sử dụng StringWritermã tuần tự hóa dựa trên cơ sở của bạn , tôi chỉ cần in chuỗi kết quả của XML và sử dụng nó trong SSMS. Như bạn có thể thấy bên dưới, khai báo XML được bao gồm (vì StringWriterkhông có tùy chọn OmitXmlDeclarationthích XmlWriter), điều này không có vấn đề gì miễn là bạn chuyển chuỗi vào dưới dạng kiểu dữ liệu SQL Server chính xác:

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

Như bạn có thể thấy, nó thậm chí còn xử lý các ký tự ngoài ASCII tiêu chuẩn, với điều kiện ሴlà Điểm mã BMP U + 1234 và 😸là Điểm mã ký tự bổ sung U + 1F638. Tuy nhiên, những điều sau:

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

dẫn đến lỗi sau:

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

Ergo, tất cả lời giải thích đó sang một bên, giải pháp đầy đủ cho câu hỏi ban đầu của bạn là:

Rõ ràng bạn đã chuyển chuỗi vào dưới dạng SqlDbType.VarChar. Chuyển sang SqlDbType.NVarCharvà nó sẽ hoạt động mà không cần thực hiện thêm bước xóa khai báo XML. Điều này được ưu tiên hơn việc giữ SqlDbType.VarCharvà loại bỏ khai báo XML vì giải pháp này sẽ ngăn mất dữ liệu khi XML bao gồm các ký tự ASCII không chuẩn. Ví dụ:

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

Như bạn thấy, không có lỗi lần này, nhưng bây giờ có mất dữ liệu 🙀.

Một vấn đề StringWriterlà theo mặc định, nó không cho phép bạn đặt mã hóa mà nó quảng cáo - vì vậy bạn có thể kết thúc với một tài liệu XML quảng cáo mã hóa của nó là UTF-16, có nghĩa là bạn cần mã hóa nó thành UTF-16 nếu bạn ghi nó vào một tập tin. Tuy nhiên, tôi có một lớp học nhỏ để giúp đỡ:

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

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

Hoặc nếu bạn chỉ cần UTF-8 (đó là tất cả những gì tôi thường cần):

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

Về lý do tại sao bạn không thể lưu XML của mình vào cơ sở dữ liệu - bạn sẽ phải cung cấp cho chúng tôi thêm chi tiết về những gì đã xảy ra khi bạn thử, nếu bạn muốn chúng tôi có thể chẩn đoán / sửa chữa nó.

Khi tuần tự hóa tài liệu XML thành chuỗi .NET, mã hóa phải được đặt thành UTF-16. Các chuỗi được lưu trữ dưới dạng UTF-16 bên trong, vì vậy đây là cách mã hóa duy nhất có ý nghĩa. Nếu bạn muốn lưu trữ dữ liệu ở một bảng mã khác, bạn sử dụng một mảng byte để thay thế.

SQL Server hoạt động trên một nguyên tắc tương tự; bất kỳ chuỗi nào được chuyển vào một xmlcột phải được mã hóa dưới dạng UTF-16. SQL Server sẽ từ chối bất kỳ chuỗi nào mà khai báo XML không chỉ định UTF-16. Nếu không có khai báo XML, thì tiêu chuẩn XML yêu cầu nó mặc định là UTF-8, vì vậy SQL Server cũng sẽ từ chối điều đó.

Ghi nhớ điều này, đây là một số phương pháp tiện ích để thực hiện chuyển đổi.

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);
        }
    }
}

Trước hết, hãy cẩn thận khi tìm các ví dụ cũ. Bạn đã tìm thấy một cái sử dụng XmlTextWriter, không được dùng nữa kể từ .NET 2.0. XmlWriter.Createnên được sử dụng thay thế.

Dưới đây là một ví dụ về việc tuần tự hóa một đối tượng thành một cột 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;
}

Nó có thể đã được đề cập ở những nơi khác nhưng chỉ cần thay đổi dòng mã hóa của nguồn XML thành 'utf-16' sẽ cho phép chèn XML vào kiểu xml'data của 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();
    }
}

Kết quả là tất cả văn bản XML được chèn vào trường kiểu dữ liệu 'xml' nhưng dòng 'tiêu đề' bị xóa. Những gì bạn thấy trong bản ghi kết quả chỉ là

<test></test>

Sử dụng phương pháp tuần tự hóa được mô tả trong mục nhập "Đã trả lời" là một cách để đưa tiêu đề gốc vào trường đích nhưng kết quả là văn bản XML còn lại được bao bọc trong một XML <string></string> thẻ .

Bộ điều hợp bảng trong mã là một lớp được tạo tự động bằng cách sử dụng Visual Studio 2013 "Add New Data Source: wizard. Năm tham số cho phương thức Chèn ánh xạ tới các trường trong bảng SQL Server.