JSON'u POST yoluyla C # ile gönder ve döndürülen JSON alsın mı?


86

Bu, JSON'u System.Netve WebRequestuygulamalarımın herhangi birinde ilk kez kullanıyorum . Uygulamamın, bir kimlik doğrulama sunucusuna aşağıdakine benzer bir JSON yükü göndermesi gerekiyor:

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

Bu yükü oluşturmak için JSON.NETkütüphaneyi kullandım . Bu verileri kimlik doğrulama sunucusuna nasıl gönderirim ve JSON yanıtını geri alırım? İşte bazı örneklerde gördüğüm, ancak JSON içeriği yok:

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

Ancak, bu, geçmişte kullandığım diğer dilleri kullanmakla karşılaştırıldığında çok fazla kod gibi görünüyor. Bunu doğru yapıyor muyum? Ve ayrıştırabilmek için JSON yanıtını nasıl geri alabilirim?

Teşekkürler Elite.

Güncellenen 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();
    }
}

2
Deneyebilirsiniz WebClient.UploadString(JsonConvert.SerializeObjectobj(yourobj))veyaHttpClient.PostAsJsonAsync
LB

Yanıtlar:


136

Kod çok basit ve tamamen zaman uyumsuz olduğundan RESTful API'leri sorgulamak için HttpClient kitaplığını kullanırken buldum kendimi .

(Düzenleme: Açıklık için sorudan JSON ekleniyor)

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

Gönderdiğiniz JSON Yapısını temsil eden iki sınıfla aşağıdaki gibi görünebilir:

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 isteğinizi yerine getirecek bunun gibi bir yönteme sahip olabilirsiniz:

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
mükemmel, ama Task.run (() nedir?
Hunter Mitchell

24
Task.Run'u eşzamanlı CPU'ya bağlı yöntemlerde kullanmamalısınız, çünkü hiçbir fayda sağlamadan yeni bir iş parçacığı başlatıyorsunuz!
Stephen Foster

2
JsonPropertyHer mülk için yazmanız gerekmez . Sadece Json.Net en yerleşik kullanmak CamelCasePropertyNamesContractResolver veya özelNamingStrategy seri hale getirme işlemi özelleştirmek için
SEAFISH

6
Yan not: usingile birlikte kullanmayın HttpClient. Bakınız: aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong
maxshuty

4
System.Net.Http.Formatting ile tanımlanmış uzantı yöntemleriniz vardır: "await httpClient.PostAsJsonAsync (" api / v1 / domain ", csObjRequest)"
hB0

15

JSON.NET NuGet paketini ve anonim türleri kullanarak, diğer posterlerin önerdiği şeyi basitleştirebilirsiniz:

// ...

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

Sen senin inşa edebilirsiniz HttpContentkombinasyonunu kullanarak JObjectönlemek ve JPropertyardından arama ToString()oluştururken üzerinde 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.JArrayHataları nasıl önlersiniz ?
Jari Turkia

1
Bir HttpClient örneğinin yapı kullanılarak oluşturulması beklenmez. Örnek bir kez oluşturulmalı ve uygulama boyunca kullanılmalıdır. Bunun nedeni, kendi bağlantı havuzunu kullanmasıdır. Kodunuz çoğunlukla SocketException atma eğilimindedir. docs.microsoft.com/en-us/dotnet/api/…
Harun Diluka Heshan

2

HttpClient () içinde bulunan PostAsJsonAsync () yöntemini de kullanabilirsiniz.

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


1
Lütfen kodunuzun ne işe yaradığı ve sorunu nasıl çözdüğü hakkında açıklama ekleyebilir misiniz?
Nilambar Sharma

Göndermek istediğiniz nesneyi alabilir ve SerializeObject () kullanarak onu serileştirebilirsiniz; var obj= new Credentials { Agent = new Agent { Name = "Agent Name", Version = 1 }, Username = "Username", Password = "User Password", Token = "xxxxx" }; Ve sonra onu httpContent'e dönüştürmek zorunda kalmadan, uç nokta URL'sini ve dönüştürülmüş JSON nesnesinin kendisini ileten PostAsJsonAsync () kullanabilirsiniz.
Rukshala Weerasinghe
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.