Надіслати JSON через POST у C # та отримати повернутий JSON?


86

Я вперше використовую JSON, а також System.Netі WebRequestв будь-якому з моїх додатків. Моя програма повинна надсилати корисне навантаження JSON, подібне до наведеного нижче, на сервер автентифікації:

{
  "agent": {                             
    "name": "Agent Name",                
    "version": 1                                                          
  },
  "username": "Username",                                   
  "password": "User Password",
  "token": "xxxxxx"
}

Для створення цього корисного навантаження я використав JSON.NETбібліотеку. Як мені надіслати ці дані на сервер автентифікації та отримати відповідь JSON назад? Ось те, що я бачив у деяких прикладах, але жодного вмісту JSON:

var http = (HttpWebRequest)WebRequest.Create(new Uri(baseUrl));
http.Accept = "application/json";
http.ContentType = "application/json";
http.Method = "POST";

string parsedContent = "Parsed JSON Content needs to go here";
ASCIIEncoding encoding = new ASCIIEncoding();
Byte[] bytes = encoding.GetBytes(parsedContent);

Stream newStream = http.GetRequestStream();
newStream.Write(bytes, 0, bytes.Length);
newStream.Close();

var response = http.GetResponse();

var stream = response.GetResponseStream();
var sr = new StreamReader(stream);
var content = sr.ReadToEnd();

Однак це, здається, багато коду, порівняного з використанням інших мов, якими я користувався раніше. Чи правильно я це роблю? І як я отримаю відповідь JSON, щоб я міг її проаналізувати?

Дякую, Еліто.

Оновлений код

// Send the POST Request to the Authentication Server
// Error Here
string json = await Task.Run(() => JsonConvert.SerializeObject(createLoginPayload(usernameTextBox.Text, password)));
var httpContent = new StringContent(json, Encoding.UTF8, "application/json");
using (var httpClient = new HttpClient())
{
    // Error here
    var httpResponse = await httpClient.PostAsync("URL HERE", httpContent);
    if (httpResponse.Content != null)
    {
        // Error Here
        var responseContent = await httpResponse.Content.ReadAsStringAsync();
    }
}

2
Ви можете спробувати WebClient.UploadString(JsonConvert.SerializeObjectobj(yourobj))абоHttpClient.PostAsJsonAsync
LB

Відповіді:


129

Я виявив, що використовую бібліотеку HttpClient для запитів RESTful API, оскільки код дуже простий і повністю асинхронний.

(Редагувати: Додавання JSON із запитання для ясності)

{
  "agent": {                             
    "name": "Agent Name",                
    "version": 1                                                          
  },
  "username": "Username",                                   
  "password": "User Password",
  "token": "xxxxxx"
}

З двома класами, що представляють структуру JSON, яку ви розмістили, може виглядати так:

public class Credentials
{
    [JsonProperty("agent")]
    public Agent Agent { get; set; }

    [JsonProperty("username")]
    public string Username { get; set; }

    [JsonProperty("password")]
    public string Password { get; set; }

    [JsonProperty("token")]
    public string Token { get; set; }
}

public class Agent
{
    [JsonProperty("name")]
    public string Name { get; set; }

    [JsonProperty("version")]
    public int Version { get; set; }
}

у вас може бути такий метод, який виконує ваш запит POST:

var payload = new Credentials { 
    Agent = new Agent { 
        Name = "Agent Name",
        Version = 1 
    },
    Username = "Username",
    Password = "User Password",
    Token = "xxxxx"
};

// Serialize our concrete class into a JSON String
var stringPayload = await Task.Run(() => JsonConvert.SerializeObject(payload));

// Wrap our JSON inside a StringContent which then can be used by the HttpClient class
var httpContent = new StringContent(stringPayload, Encoding.UTF8, "application/json");

using (var httpClient = new HttpClient()) {

    // Do the actual request and await the response
    var httpResponse = await httpClient.PostAsync("http://localhost/api/path", httpContent);

    // If the response contains content we want to read it!
    if (httpResponse.Content != null) {
        var responseContent = await httpResponse.Content.ReadAsStringAsync();

        // From here on you could deserialize the ResponseContent back again to a concrete C# type using Json.Net
    }
}

5
ідеально, але що очікує Task.run (()?
Хантер Мітчелл

21
Ви не повинні використовувати Task.Run для синхронних методів, пов'язаних з процесором, оскільки ви просто запускаєте новий потік без користі!
Стівен Фостер,

2
Вам не потрібно вводити JsonPropertyдля кожного об’єкта. Просто використовуйте вбудований Json.Net в CamelCasePropertyNamesContractResolver або спеціальнийNamingStrategy засіб для налаштування процесу серіалізації
Seafish,

6
Примітка: не використовуйте usingс HttpClient. Див .: aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong
maxshuty

4
У System.Net.Http.Formatting у вас визначено методи розширення: "await httpClient.PostAsJsonAsync (" api / v1 / domain ", csObjRequest)"
hB0

13

Використовуючи пакет JSON.NET NuGet та анонімні типи, ви можете спростити те, що пропонують інші плакати:

// ...

string payload = JsonConvert.SerializeObject(new
{
    agent = new
    {
        name    = "Agent Name",
        version = 1,
    },

    username = "username",
    password = "password",
    token    = "xxxxx",
});

var client = new HttpClient();
var content = new StringContent(payload, Encoding.UTF8, "application/json");

HttpResponseMessage response = await client.PostAsync(uri, content);

// ...

6

Ви можете створити свій, HttpContentвикористовуючи комбінацію, JObjectщоб уникнути, JPropertyа потім ToString()використовувати його при побудові StringContent:

        /*{
          "agent": {                             
            "name": "Agent Name",                
            "version": 1                                                          
          },
          "username": "Username",                                   
          "password": "User Password",
          "token": "xxxxxx"
        }*/

        JObject payLoad = new JObject(
            new JProperty("agent", 
                new JObject(
                    new JProperty("name", "Agent Name"),
                    new JProperty("version", 1)
                    ),
                new JProperty("username", "Username"),
                new JProperty("password", "User Password"),
                new JProperty("token", "xxxxxx")    
                )
            );

        using (HttpClient client = new HttpClient())
        {
            var httpContent = new StringContent(payLoad.ToString(), Encoding.UTF8, "application/json");

            using (HttpResponseMessage response = await client.PostAsync(requestUri, httpContent))
            {
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                return JObject.Parse(responseBody);
            }
        }

Як уникнути Exception while executing function. Newtonsoft.Json: Can not add Newtonsoft.Json.Linq.JProperty to Newtonsoft.Json.Linq.JArrayпомилок?
Ярі Туркія

1
Екземпляр HttpClient не повинен створюватися за допомогою конструкції. Екземпляр повинен бути створений один раз і використаний у всій програмі. Це тому, що він використовує власний пул підключень. Ваш код, як правило, створює SocketException. docs.microsoft.com/en-us/dotnet/api/…
Харун Ділука Хешан

2

Ви також можете використовувати метод PostAsJsonAsync (), доступний у HttpClient ()

   var requestObj= JsonConvert.SerializeObject(obj);
   HttpResponseMessage response = await    client.PostAsJsonAsync($"endpoint",requestObj).ConfigureAwait(false);


1
Чи можете ви додати пояснення, що робить ваш код і як він вирішує проблему?
Ніламбар Шарма

Ви можете взяти будь-який об’єкт, який ви хочете розмістити, і серіалізувати його за допомогою SerializeObject (); var obj= new Credentials { Agent = new Agent { Name = "Agent Name", Version = 1 }, Username = "Username", Password = "User Password", Token = "xxxxx" }; А потім, не перетворюючи його у httpContent, ви можете використовувати PostAsJsonAsync (), передаючи URL-адресу кінцевої точки та сам перетворений об'єкт JSON.
Rukshala Weerasinghe
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.