如何使用 C# 将 JSON 发布到服务器？

Question

这是我正在使用的代码：

// create a request
HttpWebRequest request = (HttpWebRequest)
WebRequest.Create(url); request.KeepAlive = false;
request.ProtocolVersion = HttpVersion.Version10;
request.Method = "POST";


// turn our request string into a byte stream
byte[] postBytes = Encoding.UTF8.GetBytes(json);

// this is important - make sure you specify type this way
request.ContentType = "application/json; charset=UTF-8";
request.Accept = "application/json";
request.ContentLength = postBytes.Length;
request.CookieContainer = Cookies;
request.UserAgent = currentUserAgent;
Stream requestStream = request.GetRequestStream();

// now send it
requestStream.Write(postBytes, 0, postBytes.Length);
requestStream.Close();

// grab te response and print it out to the console along with the status code
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
string result;
using (StreamReader rdr = new StreamReader(response.GetResponseStream()))
{
    result = rdr.ReadToEnd();
}

return result;

当我运行此代码时，我总是收到 500 内部服务器错误。

我做错了什么？

Answer 1

我这样做和工作的方式是：

var httpWebRequest = (HttpWebRequest)WebRequest.Create("http://url");
httpWebRequest.ContentType = "application/json";
httpWebRequest.Method = "POST";

using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
{
    string json = "{\"user\":\"test\"," +
                  "\"password\":\"bla\"}";

    streamWriter.Write(json);
}

var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
    var result = streamReader.ReadToEnd();
}

我编写了一个库来以更简单的方式执行此任务，它在这里： https://github.com/ademargomes/JsonRequest

Answer 2

Ademar 的解决方案可以通过利用 JavaScriptSerializer 的 Serialize 方法来改进，以提供对象到 JSON 的隐式转换。

此外，还可以利用 using 语句的默认功能来省略显式调用 Flush 和 Close。

var httpWebRequest = (HttpWebRequest)WebRequest.Create("http://url");
httpWebRequest.ContentType = "application/json";
httpWebRequest.Method = "POST";

using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
{
    string json = new JavaScriptSerializer().Serialize(new
                {
                    user = "Foo",
                    password = "Baz"
                });

    streamWriter.Write(json);
}

var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
    var result = streamReader.ReadToEnd();
}

Answer 3

HttpClient 类型是较新的类型实现优于 WebClient 和 HttpWebRequest。 WebClient 和 WebRequest 均已被标记为过时。 [1]

您只需使用以下几行。

string myJson = "{'Username': 'myusername','Password':'pass'}";
using (var client = new HttpClient())
{
    var response = await client.PostAsync(
        "http://yourUrl", 
         new StringContent(myJson, Encoding.UTF8, "application/json"));
}

当您多次需要 HttpClient 时，建议仅创建一个实例并重用它或使用新的 HttpClientFactory。 [2]

对于FTP，由于HttpClient不支持，我们建议使用第三方库。

@learn.microsoft.com [3]

---

自 dotnet core 3.1 您可以使用 JsonSerializer 来自 System.Text.Json 创建 json 字符串。

string myJson = JsonSerializer.Serialize(credentialsObj);

Answer 4

根据 Sean 的帖子，没有必要嵌套 using 语句。通过使用 StreamWriter，它将在块末尾刷新并关闭，因此无需显式调用 Flush() 和 Close() 方法：

var request = (HttpWebRequest)WebRequest.Create("http://url");
request.ContentType = "application/json";
request.Method = "POST";

using (var streamWriter = new StreamWriter(request.GetRequestStream()))
{
    string json = new JavaScriptSerializer().Serialize(new
                {
                    user = "Foo",
                    password = "Baz"
                });

    streamWriter.Write(json);
}

var response = (HttpWebResponse)request.GetResponse();
using (var streamReader = new StreamReader(response.GetResponseStream()))
{
        var result = streamReader.ReadToEnd();
}

Answer 5

如果您需要异步调用，请使用

var request = HttpWebRequest.Create("http://www.maplegraphservices.com/tokkri/webservices/updateProfile.php?oldEmailID=" + App.currentUser.email) as HttpWebRequest;
            request.Method = "POST";
            request.ContentType = "text/json";
            request.BeginGetRequestStream(new AsyncCallback(GetRequestStreamCallback), request);

private void GetRequestStreamCallback(IAsyncResult asynchronousResult)
    {
        HttpWebRequest request = (HttpWebRequest)asynchronousResult.AsyncState;
        // End the stream request operation

        Stream postStream = request.EndGetRequestStream(asynchronousResult);


        // Create the post data
        string postData = JsonConvert.SerializeObject(edit).ToString();

        byte[] byteArray = Encoding.UTF8.GetBytes(postData);


        postStream.Write(byteArray, 0, byteArray.Length);
        postStream.Close();

        //Start the web request
        request.BeginGetResponse(new AsyncCallback(GetResponceStreamCallback), request);
    }

    void GetResponceStreamCallback(IAsyncResult callbackResult)
    {
        HttpWebRequest request = (HttpWebRequest)callbackResult.AsyncState;
        HttpWebResponse response = (HttpWebResponse)request.EndGetResponse(callbackResult);
        using (StreamReader httpWebStreamReader = new StreamReader(response.GetResponseStream()))
        {
            string result = httpWebStreamReader.ReadToEnd();
            stat.Text = result;
        }

    }

Answer 6

我最近想出了一种更简单的方法来发布 JSON，其中包括从应用程序中的模型进行转换的附加步骤。请注意，您必须为控制器创建模型 [JsonObject] 才能获取值并进行转换。

请求：

 var model = new MyModel(); 

 using (var client = new HttpClient())
 {
     var uri = new Uri("XXXXXXXXX"); 
     var json = new JavaScriptSerializer().Serialize(model);
     var stringContent = new StringContent(json, Encoding.UTF8, "application/json");
     var response = await client.PutAsync(uri,stringContent).Result;
     // ...
  }

模型：

[JsonObject]
[Serializable]
public class MyModel
{
    public Decimal Value { get; set; }
    public string Project { get; set; }
    public string FilePath { get; set; }
    public string FileName { get; set; }
}

服务器端：

[HttpPut]     
public async Task<HttpResponseMessage> PutApi([FromBody]MyModel model)
{
    // ...
}

Answer 7

注意您正在使用的内容类型：

application/json

来源：

RFC4627

其他帖子

Answer 8

到 .Net 4.5.1 此选项 可以工作：

using (var client = new HttpClient())
{
    client.BaseAddress = new Uri("http://localhost:9000/");
    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

    var foo = new User
    {
        user = "Foo",
        password = "Baz"
    }

    await client.PostAsJsonAsync("users/add", foo);
}

Answer 9

警告！我对此主题有非常强烈的看法。

.NET 现有的 Web 客户端对开发人员不友好！ WebRequest & WebClient 是“如何让开发人员感到沮丧”的主要示例”。它们很冗长且冗长。操作复杂；当您只想用 C# 发送一个简单的 Post 请求时。 HttpClient 在解决这些问题方面有所作为，但它仍然存在不足。最重要的是，微软的文档很糟糕……真的很糟糕；除非你想筛选一页又一页的技术简介。

开源来救援。有三个优秀的开源、免费 NuGet 库作为替代方案。谢天谢地！这些都得到了很好的支持和记录，是的，很容易修正……超级容易使用。

• ServiceStack.Text - 快速、轻便且有弹性。
• RestSharp - 简单的 REST 和 HTTP API 客户端
• Flurl - 一个流畅、可移植、可测试的 HTTP 客户端库

它们之间没有太多区别，但我认为 ServiceStack.Text 稍占优势……

• Github 星 大致是相同的。
• 未解决的问题和问题重要的是，问题解决的速度有多快？ ServiceStack 因最快的问题解决和解决速度而荣获此奖。没有未解决的问题。
• 文档？都有很棒的文档；然而，ServiceStack 将其提升到了一个新的水平。以其文档的“黄金标准”而闻名。

好的 - 那么 JSON 格式的 Post 请求在 ServiceStack.Text 中是什么样子的？

var response = "http://example.org/login"
    .PostJsonToUrl(new Login { Username="admin", Password="mypassword" });

这是一行代码。简洁&简单的！将以上内容与 .NET 的 Http 库进行比较。

Answer 10

实现此目的的一些不同且干净的方法是使用 HttpClient，如下所示：

public async Task<HttpResponseMessage> PostResult(string url, ResultObject resultObject)
{
    using (var client = new HttpClient())
    {
        HttpResponseMessage response = new HttpResponseMessage();
        try
        {
            response = await client.PostAsJsonAsync(url, resultObject);
        }
        catch (Exception ex)
        {
            throw ex
        }
        return response;
     }
}

Answer 11

我最终通过包含 .Result 在同步模式下调用

HttpResponseMessage response = null;
try
{
    using (var client = new HttpClient())
    {
       response = client.PostAsync(
        "http://localhost:8000/....",
         new StringContent(myJson,Encoding.UTF8,"application/json")).Result;
    if (response.IsSuccessStatusCode)
        {
            MessageBox.Show("OK");              
        }
        else
        {
            MessageBox.Show("NOK");
        }
    }
}
catch (Exception ex)
{
    MessageBox.Show("ERROR");
}

Answer 12

我发现这是发布读取的 JSON 数据的最友好、最简洁的方式：

var url = @"http://www.myapi.com/";
var request = new Request { Greeting = "Hello world!" };
var json = JsonSerializer.Serialize<Request>(request);
using (WebClient client = new WebClient())
{
    var jsonResponse = client.UploadString(url, json);
    var response = JsonSerializer.Deserialize<Response>(jsonResponse);
}

我使用 Microsoft 的 System.Text.Json 来序列化和反序列化 JSON。请参阅 NuGet。

Answer 13

我就是这样做的

//URL
var url = "http://www.myapi.com/";

//Request
using var request = new HttpRequestMessage(HttpMethod.Post, url);

//Headers
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Cache-Control", "no-cache");

//Payload
var payload = JsonConvert.SerializeObject(
    new
    {
        Text = "Hello world"
    });
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

//Send
var response = await _httpClient.SendAsync(request);

//Handle response
if (response.IsSuccessStatusCode)
    return;

Answer 14

Dot net core 解决方案

首先使用 Newtonsoft.Json，然后编写如下方法：

    public static string? LoginToken()
    {
        var httpWebRequest = (HttpWebRequest)WebRequest.Create("http://url");
        httpWebRequest.ContentType = "application/json";
        httpWebRequest.Method = "POST";

        using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
        {
           //  write your json content here
            string json = JsonConvert.SerializeObject(new
            {
                userName = ApiOptions.Username,
                password = ApiOptions.Password
            }
            );


            streamWriter.Write(json);
        }

        var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
        using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
        {
            var result = streamReader.ReadToEnd();
            return result;
        }

    }

该方法返回 string。如果您想将 string 结果反序列化为 JSON，只需在方法末尾添加此行：

var result = streamReader.ReadToEnd();               
var json_result = JsonConvert.DeserializeObject<LoginTokenResponse>(result); // + add this code
        

其中 LoginTokenResponse 是您的自定义类想要反序列化字符串结果

Answer 15

var data = Encoding.ASCII.GetBytes(json);

byte[] postBytes = Encoding.UTF8.GetBytes(json);

使用 ASCII 而不是 UFT8