c# - asp.net asmx Web 服务返回 xml 而不是 json

Question

为什么这个简单的 Web 服务拒绝向客户端返回 JSON？

这是我的客户代码：

        var params = { };
        $.ajax({
            url: "/Services/SessionServices.asmx/HelloWorld",
            type: "POST",
            contentType: "application/json; charset=utf-8",
            dataType: "json",
            timeout: 10000,
            data: JSON.stringify(params),
            success: function (response) {
                console.log(response);
            }
        });

和服务：

namespace myproject.frontend.Services
{
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    [ScriptService]
    public class SessionServices : System.Web.Services.WebService
    {
        [WebMethod]
        [ScriptMethod(ResponseFormat = ResponseFormat.Json)]
        public string HelloWorld()
        {
            return "Hello World";
        }
    }
}

网络配置：

<configuration>
    <system.web>
        <compilation debug="true" targetFramework="4.0" />
    </system.web>
</configuration>

和回应：

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">Hello World</string>

无论我做什么，响应总是以 XML 形式返回。如何让 Web 服务返回 Json？

编辑：

这是 Fiddler HTTP 跟踪：

REQUEST
-------
POST http://myproject.local/Services/SessionServices.asmx/HelloWorld HTTP/1.1
Host: myproject.local
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:13.0) Gecko/20100101 Firefox/13.0.1
Accept: application/json, text/javascript, */*; q=0.01
Accept-Language: en-gb,en;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Type: application/json; charset=utf-8
X-Requested-With: XMLHttpRequest
Referer: http://myproject.local/Pages/Test.aspx
Content-Length: 2
Cookie: ASP.NET_SessionId=5tvpx1ph1uiie2o1c5wzx0bz
Pragma: no-cache
Cache-Control: no-cache

{}

RESPONSE
-------
HTTP/1.1 200 OK
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 19 Jun 2012 16:33:40 GMT
Content-Length: 96

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">Hello World</string>

我已经不知道我现在阅读了多少篇文章试图解决这个问题。这些说明要么不完整，要么由于某种原因无法解决我的问题。一些更相关的包括（都没有成功）：

• ASP.NET Web 服务错误地返回 XML 而不是 JSON
• asmx Web 服务在 .net 4.0 中返回 xml 而不是 json
• http://williamsportwebdeveloper.com/cgi/wp/?p=494
• http://encosia.com/using-jquery-to-consume-aspnet-json-web-services/
• http://forums.asp.net/t/1054378.aspx
• http://jqueryplugins.info/2012/02/asp-net-web-service-returning-xml-instead-of-json/

加上其他几篇一般文章。

Answer 1

终于想通了。

发布的应用程序代码是正确的。问题出在配置上。正确的 web.config 是：

<configuration>
    <system.web>
        <compilation debug="true" targetFramework="4.0" />
    </system.web>
    <system.webServer>
        <handlers>
            <add name="ScriptHandlerFactory"
                 verb="*" path="*.asmx"
                 type="System.Web.Script.Services.ScriptHandlerFactory, System.Web.Extensions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"
                 resourceType="Unspecified" />
        </handlers>
    </system.webServer>
</configuration>

根据文档，从 .NET 4 向上注册处理程序应该是不必要的，因为它已被移动到 machine.config。无论出于何种原因，这对我不起作用。但是将注册添加到我的应用程序的 web.config 解决了这个问题。

许多关于此问题的文章都指示将处理程序添加到该<system.web>部分。这不起作用，并导致一大堆其他问题。我尝试将处理程序添加到这两个部分，这会生成一组其他迁移错误，这完全误导了我的故障排除。

如果它对其他人有帮助，如果我再次遇到同样的问题，这是我要查看的清单：

1. 你type: "POST"在ajax请求中指定了吗？
2. 你contentType: "application/json; charset=utf-8"在ajax请求中指定了吗？
3. 你dataType: "json"在ajax请求中指定了吗？
4. 您的 .asmx Web 服务是否包含该[ScriptService]属性？
5. 您的 Web 方法是否包含该[ScriptMethod(ResponseFormat = ResponseFormat.Json)] 属性？（我的代码即使没有这个属性也可以工作，但是很多文章都说它是必需的）
6. 您是否已将其添加ScriptHandlerFactory到 web.config 文件中<system.webServer><handlers>？
7. 您是否从 in 中的 web.config 文件中删除了所有处理程序<system.web><httpHandlers>？

希望这可以帮助任何有同样问题的人。并感谢海报的建议。

Answer 2

上述解决方案没有成功，这是我如何解决的。

将此行放入您的网络服务中，而不是返回类型，只需在响应上下文中写入字符串

this.Context.Response.ContentType = "application/json; charset=utf-8";
this.Context.Response.Write(serial.Serialize(city));

Answer 3

如果您想继续使用 Framework 3.5，您需要对代码进行如下更改。

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
// To allow this Web Service to be called from script, using ASP.NET AJAX, uncomment the following line. 
[ScriptService]
public class WebService : System.Web.Services.WebService
{
    public WebService()
    {
    }

    [WebMethod]
    public void HelloWorld() // It's IMP to keep return type void.
    {
        string strResult = "Hello World";
        object objResultD = new { d = strResult }; // To make result similarly like ASP.Net Web Service in JSON form. You can skip if it's not needed in this form.

        System.Web.Script.Serialization.JavaScriptSerializer ser = new System.Web.Script.Serialization.JavaScriptSerializer();
        string strResponse = ser.Serialize(objResultD);

        string strCallback = Context.Request.QueryString["callback"]; // Get callback method name. e.g. jQuery17019982320107502116_1378635607531
        strResponse = strCallback + "(" + strResponse + ")"; // e.g. jQuery17019982320107502116_1378635607531(....)

        Context.Response.Clear();
        Context.Response.ContentType = "application/json";
        Context.Response.AddHeader("content-length", strResponse.Length.ToString());
        Context.Response.Flush();

        Context.Response.Write(strResponse);
    }
}

Answer 4

有更简单的方法可以从 Web 服务返回纯字符串。我称它为 CROW 函数（便于记忆）。

  [WebMethod]
  public void Test()
    {
        Context.Response.Output.Write("and that's how it's done");    
    }

如您所见，返回类型为“void”，但 CROW 函数仍将返回您想要的值。

Answer 5

我有一个 .asmx Web 服务（.NET 4.0），它的方法返回一个字符串。该字符串是一个序列化列表，就像您在许多示例中看​​到的那样。这将返回未包装在 XML 中的 json。无需更改 web.config 或需要 3rd 方 DLL。

var tmsd = new List<TmsData>();
foreach (DataRow dr in dt.Rows)
{

m_firstname = dr["FirstName"].ToString();
m_lastname = dr["LastName"].ToString();

tmsd.Add(new TmsData() { FirstName = m_firstname, LastName = m_lastname} );

}

var serializer = new System.Web.Script.Serialization.JavaScriptSerializer();
string m_json = serializer.Serialize(tmsd);

return m_json;

使用该服务的客户端部分如下所示：

   $.ajax({
       type: 'POST',
       contentType: "application/json; charset=utf-8",
       dataType: 'json',
       url: 'http://localhost:54253/TmsWebService.asmx/GetTombstoneDataJson',
       data: "{'ObjectNumber':'105.1996'}",
       success: function (data) {
           alert(data.d);
       },
       error: function (a) {
           alert(a.responseText);
       }
   });

Answer 6

希望这会有所帮助，即使您调用的方法没有参数，您似乎仍然需要在请求中发送一些 JSON 对象。

var params = {};
return $http({
        method: 'POST',
        async: false,
        url: 'service.asmx/ParameterlessMethod',
        data: JSON.stringify(params),
        contentType: 'application/json; charset=utf-8',
        dataType: 'json'

    }).then(function (response) {
        var robj = JSON.parse(response.data.d);
        return robj;
    });

Answer 7

对我来说，它适用于我从这篇文章中获得的这段代码：

如何使用 Json.Net 从我的 WCF 休息服务（.NET 4）返回 json，而不是用引号括起来的字符串？

[WebInvoke(UriTemplate = "HelloWorld", Method = "GET"), OperationContract]
public Message HelloWorld()
{
    string jsonResponse = //Get JSON string here
    return WebOperationContext.Current.CreateTextResponse(jsonResponse, "application/json; charset=utf-8", Encoding.UTF8);
}

Answer 8

我已经尝试了上述所有步骤（甚至是答案），但我没有成功，我的系统配置是 Windows Server 2012 R2，IIS 8。以下步骤解决了我的问题。

更改了具有托管管道 = 经典的应用程序池。

Answer 9

我知道这确实是个老问题，但我今天遇到了同样的问题，我一直在到处寻找答案，但没有结果。经过长时间的研究，我找到了完成这项工作的方法。要从服务返回 JSON，您必须以正确的格式在请求中提供数据，在请求JSON.stringify()之前使用解析数据并且不要忘记contentType: "application/json; charset=utf-8"，使用它应该提供预期的结果。

Answer 10

response = await client.GetAsync(RequestUrl, HttpCompletionOption.ResponseContentRead);
if (response.IsSuccessStatusCode)
{
    _data = await response.Content.ReadAsStringAsync();
    try
    {
        XmlDocument _doc = new XmlDocument();
        _doc.LoadXml(_data);
        return Request.CreateResponse(HttpStatusCode.OK, JObject.Parse(_doc.InnerText));
    }
    catch (Exception jex)
    {
        return Request.CreateResponse(HttpStatusCode.BadRequest, jex.Message);
    }
}
else
    return Task.FromResult<HttpResponseMessage>(Request.CreateResponse(HttpStatusCode.NotFound)).Result;