Я нашёл правильный способ вернуть XML клиенту в ASP.NET. Думаю, если я укажу неправильные пути, это сделает правильный путь более понятным.

Неправильно:

Response.Write(doc.ToString());

Неправильно:

Response.Write(doc.InnerXml);

Неправильно:

Response.ContentType = "text/xml";
Response.ContentEncoding = System.Text.Encoding.UTF8;
doc.Save(Response.OutputStream);

Исправлено:

Response.ContentType = "text/xml"; //Must be 'text/xml'
Response.ContentEncoding = System.Text.Encoding.UTF8; //We'd like UTF-8
doc.Save(Response.Output); //Save to the text-writer
      //using the encoding of the text-writer
      //(which comes from response.contentEncoding)

Использовать TextWriter

Делать не использовать Ответ. OutputStream

Do use Response.Output

Both are flows, but Output is a TextWriter. Когда XmlDocument сохраняется в TextWriter, он будет использовать кодировку TextWriter, указанную этим TextWriter. XmlDocument автоматически изменит узел xml декларации на кодировку, используемую TextWriter. Например, в этом случае узел XML декларации:

<?xml version="1.0" encoding="ISO-8859-1"?>

станет

<?xml version="1.0" encoding="UTF-8"?>

Это потому, что TextWriter был установлен в UTF-8. (Подробнее об этом позже). Так как TextWriter подает символьные данные, он будет кодировать их байтовыми последовательностями, соответствующими его заданной кодировке.

Неправильно:

doc.Save(Response.OutputStream);

В данном примере документ некорректно сохраняется в OutputStream, который не изменяет кодировку и может не совпадать ни с кодировкой контента ответа, ни с кодировкой, заданной узлом XML-объявления.

Исправьте

doc.Save(Response.Output);

XML-документ корректно сохраняется в объект TextWriter, что обеспечивает правильную обработку кодировки.

Установить кодировку

Кодировка, переданная клиенту в заголовке:

Response.ContentEncoding = ...

должна совпадать с кодировкой XML документа:

<?xml version="1.0" encoding="..."?>

должна совпадать с фактической кодировкой, присутствующей в последовательностях байтов, передаваемых клиенту. Чтобы заставить все три эти вещи согласиться, установите единственную строку:

Response.ContentEncoding = System.Text.Encoding.UTF8;

Когда кодировка установлена на объекте Response, она устанавливает ту же самую кодировку на TextWriter. Набор кодировок TextWriter заставляет XmlDocument изменить xml декларацию:

<?xml version="1.0" encoding="UTF-8"?>

при сохранении документа:

doc.Save(someTextWriter);

Save to the response Output

Вы не хотите сохранять документ в двоичном потоке или записывать строку:

Неверно:

doc.Save(Response.OutputStream);

Здесь XML некорректно сохраняется в двоичном потоке. Окончательная последовательность кодирования байтов не будет соответствовать ни XML-декларации, ни контент-кодировке ответа веб-сервера.

Неправильно:

Response.Write(doc.ToString());
Response.Write(doc.InnerXml);

Здесь XML некорректно преобразуется в строку, которая не имеет кодировки. Узел XML декларации не обновляется, чтобы отразить кодировку ответа, и ответ не правильно закодирован, чтобы соответствовать кодировке ответа. Кроме того, при хранении XML в промежуточной строке теряется память.

Вы не хотите сохранять XML в строку, или запихивать XML в строку и response.Write a string, потому что:

- doesn't follow the encoding specified
- doesn't set the XML declaration node to match
- wastes memory

Do use doc.Save(Response.Output);

Do not use doc. Save(Response.OutputStream);

Do not use Response.Write(doc.ToString());

Do not use 'Response.Write(doc.InnerXml);`

Set the content type

The ContentType's Response's must be set to "text/xml". В противном случае клиент не будет знать, что вы отправляете ему XML.

Final Answer

Response.Clear(); //Optional: if we've sent anything before
Response.ContentType = "text/xml"; //Must be 'text/xml'
Response.ContentEncoding = System.Text.Encoding.UTF8; //We'd like UTF-8
doc.Save(Response.Output); //Save to the text-writer
    //using the encoding of the text-writer
    //(which comes from response.contentEncoding)
Response.End(); //Optional: will end processing

Complete Example

Rob Kennedy имел хорошее замечание, что я не включил пример "от начала до конца".

GetPatronInformation.ashx:

<%@ WebHandler Language="C#" Class="Handler" %>

using System;
using System.Web;
using System.Xml;
using System.IO;
using System.Data.Common;

//Why a "Handler" and not a full ASP.NET form?
//Because many people online critisized my original solution
//that involved the aspx (and cutting out all the HTML in the front file),
//noting the overhead of a full viewstate build-up/tear-down and processing,
//when it's not a web-form at all. (It's a pure processing.)

public class Handler : IHttpHandler
{
   public void ProcessRequest(HttpContext context)
   {
      //GetXmlToShow will look for parameters from the context
      XmlDocument doc = GetXmlToShow(context);

      //Don't forget to set a valid xml type.
      //If you leave the default "text/html", the browser will refuse to display it correctly
      context.Response.ContentType = "text/xml";

      //We'd like UTF-8.
      context.Response.ContentEncoding = System.Text.Encoding.UTF8;
      //context.Response.ContentEncoding = System.Text.Encoding.UnicodeEncoding; //But no reason you couldn't use UTF-16:
      //context.Response.ContentEncoding = System.Text.Encoding.UTF32; //Or UTF-32
      //context.Response.ContentEncoding = new System.Text.Encoding(500); //Or EBCDIC (500 is the code page for IBM EBCDIC International)
      //context.Response.ContentEncoding = System.Text.Encoding.ASCII; //Or ASCII
      //context.Response.ContentEncoding = new System.Text.Encoding(28591); //Or ISO8859-1
      //context.Response.ContentEncoding = new System.Text.Encoding(1252); //Or Windows-1252 (a version of ISO8859-1, but with 18 useful characters where they were empty spaces)

      //Tell the client don't cache it (it's too volatile)
      //Commenting out NoCache allows the browser to cache the results (so they can view the XML source)
      //But leaves the possiblity that the browser might not request a fresh copy
      //context.Response.Cache.SetCacheability(HttpCacheability.NoCache);

      //And now we tell the browser that it expires immediately, and the cached copy you have should be refreshed
      context.Response.Expires = -1;

      context.Response.Cache.SetAllowResponseInBrowserHistory(true); //"works around an Internet&nbsp;Explorer bug"

      doc.Save(context.Response.Output); //doc saves itself to the textwriter, using the encoding of the text-writer (which comes from response.contentEncoding)

      #region Notes
      /*
       * 1. Use Response.Output, and NOT Response.OutputStream.
       *  Both are streams, but Output is a TextWriter.
       *  When an XmlDocument saves itself to a TextWriter, it will use the encoding
       *  specified by the TextWriter. The XmlDocument will automatically change any
       *  XML declaration node, i.e.:
       *     <?xml version="1.0" encoding="ISO-8859-1"?>
       *  to match the encoding used by the Response.Output's encoding setting
       * 2. The Response.Output TextWriter's encoding settings comes from the
       *  Response.ContentEncoding value.
       * 3. Use doc.Save, not Response.Write(doc.ToString()) or Response.Write(doc.InnerXml)
       * 3. You DON'T want to save the XML to a string, or stuff the XML into a string
       *  and response.Write that, because that
       *   - doesn't follow the encoding specified
       *   - wastes memory
       *
       * To sum up: by Saving to a TextWriter: the XML Declaration node, the XML contents,
       * and the HTML Response content-encoding will all match.
       */
      #endregion Notes
   }

   private XmlDocument GetXmlToShow(HttpContext context)
   {
      //Use context.Request to get the account number they want to return
      //GET /GetPatronInformation.ashx?accountNumber=619

      //Or since this is sample code, pull XML out of your rear:
      XmlDocument doc = new XmlDocument();
      doc.LoadXml("<Patron><Name>Rob Kennedy</Name></Patron>");

      return doc;
   }

   public bool IsReusable { get { return false; } }
}