Wysłać JSON przez POST w C # i odebrać zwrócony JSON?

86

Jest to mój pierwszy raz w historii za pomocą JSON, jak System.Neti WebRequestw żadnym z moich aplikacji. Moja aplikacja ma wysyłać ładunek JSON, podobny do poniższego, do serwera uwierzytelniającego:

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

Aby utworzyć ten ładunek, użyłem JSON.NETbiblioteki. Jak wysłać te dane do serwera uwierzytelniającego i otrzymać odpowiedź JSON z powrotem? Oto, co widziałem w kilku przykładach, ale bez zawartości 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();

Jednak wydaje się, że jest to dużo kodu w porównaniu z innymi językami, których używałem w przeszłości. Czy robię to poprawnie? Jak uzyskać odpowiedź JSON z powrotem, aby móc ją przeanalizować?

Dzięki, Elita.

Zaktualizowany kod

// 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();
    }
}
Hunter Mitchell
źródło
2
Możesz spróbować WebClient.UploadString(JsonConvert.SerializeObjectobj(yourobj))lubHttpClient.PostAsJsonAsync
LB

Odpowiedzi:

129

Odkryłem, że używam biblioteki HttpClient do wykonywania zapytań dotyczących interfejsów API RESTful, ponieważ kod jest bardzo prosty iw pełni asynchroniczny.

(Edycja: dodawanie JSON z pytania dla jasności)

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

Dwie klasy reprezentujące opublikowaną przez Ciebie strukturę JSON mogą wyglądać następująco:

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; }
}

możesz mieć metodę taką jak ta, która wykona żądanie 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
    }
}
Kai Eichinger
źródło
5
idealne, ale jakie jest oczekiwanie Task.run (()?
Hunter Mitchell
21
Nie powinieneś używać Task.Run na synchronicznych metodach związanych z procesorem, ponieważ po prostu odpalasz nowy wątek bez żadnych korzyści!
Stephen Foster
2
Nie musisz wpisywać JsonPropertydla każdej nieruchomości. Po prostu użyj Json.Net wbudowanego w CamelCasePropertyNamesContractResolver lub niestandardowego,NamingStrategy aby dostosować proces serializacji
Seafish
6
Uwaga dodatkowa: nie używaj usingz HttpClient. Zobacz: aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong
maxshuty
4
W System.Net.Http.Formatting masz zdefiniowane metody rozszerzające: „await httpClient.PostAsJsonAsync („ api / v1 / domain ”, csObjRequest)”
hB0
13

Korzystając z pakietu NuGet JSON.NET i typów anonimowych, możesz uprościć sugestie innych plakatów:

// ...

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);

// ...
Maksymiliana Burszleya
źródło
6

Możesz zbudować swoją HttpContentkombinację, JObjectaby uniknąć, JPropertya następnie przywołać ToString()ją podczas budowania 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);
            }
        }
Jan Dolejsi
źródło
Jak uniknąć Exception while executing function. Newtonsoft.Json: Can not add Newtonsoft.Json.Linq.JProperty to Newtonsoft.Json.Linq.JArraybłędów?
Jari Turkia
1
Wystąpienie HttpClient nie powinno być tworzone przy użyciu konstrukcji using. Instancję należy utworzyć raz i używać w całej aplikacji. Dzieje się tak, ponieważ używa własnej puli połączeń. Twój kod zazwyczaj generuje wyjątek SocketException. docs.microsoft.com/en-us/dotnet/api/…
Harun Diluka Heshan
2

Można również użyć metody PostAsJsonAsync () dostępnej w HttpClient ()

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

Rukshala Weerasinghe
źródło
1
Czy możesz dodać wyjaśnienie, co robi twój kod i jak rozwiązuje problem?
Nilambar Sharma
Możesz wziąć dowolny obiekt, który chcesz opublikować i serializować go za pomocą SerializeObject (); var obj= new Credentials { Agent = new Agent { Name = "Agent Name", Version = 1 }, Username = "Username", Password = "User Password", Token = "xxxxx" }; A następnie bez konieczności konwertowania go na httpContent, możesz użyć PostAsJsonAsync (), przekazując adres URL punktu końcowego i sam przekonwertowany obiekt JSON.
Rukshala Weerasinghe