在 ASP.Net 中创建 JSON 对象

Question

我正在尝试在 .Net 5 应用程序中创建 JSON 对象。当我在 Json 上使用 Visual Studio 2015 Qucik Actions 时，我看到的默认选项是 Microsoft.AspNet.Mvc.Formatters.Json、Microsoft.Extensions.Configuration.Json 和 Newtonsoft.Json。我的理解是Configuration.Json 用于读取appsettings.json 的形式，所以它可能不是我用来创建JSON 对象的方法。我找不到关于Formatters.Json 的任何真实信息，如何使用它，或者它的用途是什么。 Newtonsoft.Json 将记录在案，但它是否比 Formatters.Json 更好？我应该使用这两者中的哪一个？

Answer 1

直接取自ASP.NET Core 1 tests

var 预期 = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(new { foo = "abcd" }));

同样采用from the tests并稍作修改，用HttpClient调用它，看看如何将你的json字符串发送到服务器。

var response = 等待 Client.PostAsync( "http://localhost/api/ActionUsingSpecificFormatters", 新的 StringContent(yourJsonContent, Encoding.UTF8, "application/json"));

按照Newtonsoft，你可以简单地编码，然后做任何你想做的事情。

产品产品 = 新产品（）； product.Name = "苹果"; product.ExpiryDate = new DateTime(2008, 12, 28); 产品.价格 = 3.99M; product.Sizes = new string[] { "Small", "Medium", "Large" }; 字符串输出 = JsonConvert.SerializeObject(product); //{ // "名称": "苹果", // "ExpiryDate": "2008-12-28T00:00:00", // "价格": 3.99, //“尺寸”：[ // “小的”， // “中等的”， // “大” // ] //} 产品反序列化产品 = JsonConvert.DeserializeObject(输出);

把它们放在一起 - 我刚刚测试了这个。请记住，这是来自 MVC 6（ASP.NET 5 即 ASP.NET Core 1）的真正通用直通测试:)

[HttpGet] 公共异步任务 Get() { var client = new HttpClient(); var customer = new Customer() { Name = "Schmo", Address = "1999 Purple Rain St" }; var customerJson = JsonConvert.SerializeObject(客户); var response = 等待 client.PostAsync( "http://localhost:4815/api/Customer", 新 StringContent(customerJson, Encoding.UTF8, "application/json")); //只是一些模板输出来测试我要回来的。 字符串 resultJson = "{'Name':'adam'}"; if (response.StatusCode == HttpStatusCode.OK) { resultJson = 等待 response.Content.ReadAsStringAsync(); var updatedCustomer = JsonConvert.DeserializeObject(resultJson); } 返回结果Json； } 公共类客户 { 公共字符串名称 { 获取；放; } 公共字符串地址 { 获取；放; } }

Answer 2

我肯定会使用 Json.Net 来创建 JSON 有效负载（毕竟，Microsoft 是为 Web Api 做的）。

Nuget 包来源：

Install-Package Newtonsoft.Json

这是一个例子。如果您想在进行 GET 调用时调用返回产品的 REST api，那么您可以执行类似的操作。

public static class Main
{
    string url = "https://TheDomainYouWantToContact.com/products/1";
    HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(url);
    request.Method = "GET";
    request.ContentType = "application/json";
    request.Accept = "application/json";
    var httpResponse = (HttpWebResponse)request.GetResponse();

    var dataStream = httpResponse.GetResponseStream();
    var reader = new StreamReader(dataStream);
    var responseFromServer = reader.ReadToEnd();
    reader.Close();
    dataStream.Close();

    // This is the code that turns the JSON string into the Product object.
    Product productFromServer = JsonConvert.Deserialize<Product>(responseFromServer);
    Console.Writeline(productFromServer.Id);
}

// This is the class that represents the JSON that you want to post to the service.
public class Product
{
    public string Id { get; set; }
    public decimal Cost { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
}

同样的方法也可以用于 POST 和 PUT。

您也可以使用 3rd 方程序集来让这变得超级简单。我们是 DynamicApis.Api 的作者

Install-Package DynamicApis.Api

使用此客户端发出相同请求的代码如下：

public static class Main
{
    RestClient client = new RestClient();
    string url = "https://YourDomain.com/products/1";
    var productFromServer = client.Get<Product>(url);
    Console.Writeline(productFromServer.Id);
}

Answer 3

如果你需要将对象序列化为 json，你应该使用 NewtonSoft.Json

Answer 4

您不需要做任何特别的事情来发回 Json 数据。默认的输出格式化程序已经是 Json，如果你的 Startup.cs 文件有些正常，你应该有类似这样的一行：

services.AddMvc();

默认情况下，这已经包含 Json 格式化程序，并且您的控制器应该根据浏览器的要求自动协商返回类型。所以像下面这样的控制器应该可以工作（取自this Github issue，其中包含一些关于为什么/如何工作的信息）：

public class ValuesController : ApiController
{
    public SomeClass Get()
    {
        return new SomeClass();
    }

    public SomeClass Post([FromBody] SomeClass x)
    {
        return x;
    }
}