从.NET控制台调用JSON WebService的最佳方法


89

我在ASP.Net MVC3中托管一个Web服务,该服务返回Json字符串。从ac#控制台应用程序调用Web服务并将返回的内容解析为.NET对象的最佳方法是什么?

我应该在控制台应用程序中引用MVC3吗?

Json.Net有一些不错的方法来序列化和反序列化.NET对象,但是我看不到它具有从Web服务发布和获取值的方法。

还是应该只创建自己的帮助程序方法以进行POST和GET到Web服务?如何将.net对象序列化为键值对?

Answers:


141

我使用HttpWebRequest从Web服务中获取,这返回了一个JSON字符串。看起来像这样的GET:

// Returns JSON string
string GET(string url) 
{
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
    try {
        WebResponse response = request.GetResponse();
        using (Stream responseStream = response.GetResponseStream()) {
            StreamReader reader = new StreamReader(responseStream, System.Text.Encoding.UTF8);
            return reader.ReadToEnd();
        }
    }
    catch (WebException ex) {
        WebResponse errorResponse = ex.Response;
        using (Stream responseStream = errorResponse.GetResponseStream())
        {
            StreamReader reader = new StreamReader(responseStream, System.Text.Encoding.GetEncoding("utf-8"));
            String errorText = reader.ReadToEnd();
            // log errorText
        }
        throw;
    }
}

然后,我使用JSON.Net动态解析字符串。或者,您可以使用以下Codeplex工具从示例JSON输出静态生成C#类:http : //jsonclassgenerator.codeplex.com/

POST看起来像这样:

// POST a JSON string
void POST(string url, string jsonContent) 
{
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
    request.Method = "POST";

    System.Text.UTF8Encoding encoding = new System.Text.UTF8Encoding();
    Byte[] byteArray = encoding.GetBytes(jsonContent);

    request.ContentLength = byteArray.Length;
    request.ContentType = @"application/json";

    using (Stream dataStream = request.GetRequestStream()) {
        dataStream.Write(byteArray, 0, byteArray.Length);
    }
    long length = 0;
    try {
        using (HttpWebResponse response = (HttpWebResponse)request.GetResponse()) {
            length = response.ContentLength;
        }
    }
    catch (WebException ex) {
        // Log exception and throw as for GET example above
    }
}

我在我们的Web服务的自动化测试中使用了这样的代码。


JsonClassGenerator很棒。反序列化很容易,因为您只需通过传递json字符串来构造强类型对象。
AaronLS

如果您在非ASCII字符集中设置了字符,则需要对您所拥有的代码进行一些更改。ContentLength表示已发布内容中的字节数,因此从技术上讲request.ContentLength应该设置为byteArray.Length,而不是jsonContent.Length。
Grady Werner

Encoding.GetEncoding("utf-8")可以替换为Encoding.UTF8
JoelFan

谢谢,这非常有帮助
shweta

作为授权令牌的一部分,将设置,但是如果需要测试,我们可能还必须传递标头。像这个请求。Method =“ GET”; request.Timeout = 20000; request.ContentType =“ application / json”; request.Headers.Add(“ Authorization”,“承载您的令牌:
Kurkula

51

WebClient可以从远程URL中获取内容,JavaScriptSerializerJson.NET可以将JSON反序列化为.NET对象。例如,您定义一个模型类,该模型类将反映JSON结构,然后:

using (var client = new WebClient())
{
    var json = client.DownloadString("http://example.com/json");
    var serializer = new JavaScriptSerializer();
    SomeModel model = serializer.Deserialize<SomeModel>(json);
    // TODO: do something with the model
}

您还可以签出一些REST客户端框架,例如RestSharp


@BrokeMyLegBiking,哪个?它与ASPAjax无关。如果您正在谈论JavaScriptSerializer类,则它是在System.Web.Extensions程序集的.NET中构建的,因此您无需下载或安装任何东西。
Darin Dimitrov

有没有一种方法可以将ac#对象的所有属性名称/属性值转换为POST键值对(或GET键值对)?这样我就可以有效地将c#对象用作Webservice方法的输入值?
BrokeMyLegBiking 2011年

@BrokeMyLegBiking,这取决于您拥有的对象以及Web服务如何期望输入。
Darin Dimitrov

3
我真的很喜欢RestSharp库。感谢您提及。
布莱恩·雷

1
Daren您可以更新此内容吗,client.downloadstring()不再可行。
JReam '16

9

尽管现有的答案是有效的方法,但它们是过时的。HttpClient是用于RESTful Web服务的现代界面。检查链接中页面的示例部分,它有一个非常简单的异步HTTP GET用例。

using (var client = new System.Net.Http.HttpClient())
{
    return await client.GetStringAsync("https://reqres.in/api/users/3"); //uri
}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.