Использование JsonConvert.DeserializeObject для десериализации Json в класс C# POCO
Вот мой простой User Класс POCO:
/// <summary>
/// The User class represents a Coderwall User.
/// </summary>
public class User
{
/// <summary>
/// A User's username. eg: "sergiotapia, mrkibbles, matumbo"
/// </summary>
public string Username { get; set; }
/// <summary>
/// A User's name. eg: "Sergio Tapia, John Cosack, Lucy McMillan"
/// </summary>
public string Name { get; set; }
/// <summary>
/// A User's location. eh: "Bolivia, USA, France, Italy"
/// </summary>
public string Location { get; set; }
public int Endorsements { get; set; } //Todo.
public string Team { get; set; } //Todo.
/// <summary>
/// A collection of the User's linked accounts.
/// </summary>
public List<Account> Accounts { get; set; }
/// <summary>
/// A collection of the User's awarded badges.
/// </summary>
public List<Badge> Badges { get; set; }
}
И метод, который я использую для десериализации ответа JSON в User объект (этот фактический вызов JSON здесь):
private User LoadUserFromJson(string response)
{
var outObject = JsonConvert.DeserializeObject<User>(response);
return outObject;
}
Это вызывает исключение:
Невозможно десериализовать текущий объект JSON (например, {"name":"value"}) в тип 'System.Collections.Generic.List`1[CoderwallDotNet.Api.Models.Account]', поскольку для типа требуется массив JSON (например, [1,2,3]) для правильной десериализации.
Чтобы исправить эту ошибку, либо измените JSON на массив JSON (например, [1,2,3]), либо измените десериализованный тип так, чтобы это был нормальный тип.NET (например, не примитивный тип, например, целое число, а не тип коллекции, например, массив или список), которые можно десериализовать из объекта JSON. JsonObjectAttribute также можно добавить к типу, чтобы заставить его десериализоваться из объекта JSON. Путь "accounts.github", строка 1, позиция 129.
Никогда ранее не работавший с этим методом DeserializeObject, я застрял здесь.
Я убедился, что имена свойств в классе POCO совпадают с именами в ответе JSON.
Что я могу попробовать десериализовать JSON в этот класс POCO?
9 ответов
Вот рабочий пример.
Ключевые точки:
- Декларация
Accounts - Использование
JsonPropertyатрибут
,
using (WebClient wc = new WebClient())
{
var json = wc.DownloadString("http://coderwall.com/mdeiters.json");
var user = JsonConvert.DeserializeObject<User>(json);
}
-
public class User
{
/// <summary>
/// A User's username. eg: "sergiotapia, mrkibbles, matumbo"
/// </summary>
[JsonProperty("username")]
public string Username { get; set; }
/// <summary>
/// A User's name. eg: "Sergio Tapia, John Cosack, Lucy McMillan"
/// </summary>
[JsonProperty("name")]
public string Name { get; set; }
/// <summary>
/// A User's location. eh: "Bolivia, USA, France, Italy"
/// </summary>
[JsonProperty("location")]
public string Location { get; set; }
[JsonProperty("endorsements")]
public int Endorsements { get; set; } //Todo.
[JsonProperty("team")]
public string Team { get; set; } //Todo.
/// <summary>
/// A collection of the User's linked accounts.
/// </summary>
[JsonProperty("accounts")]
public Account Accounts { get; set; }
/// <summary>
/// A collection of the User's awarded badges.
/// </summary>
[JsonProperty("badges")]
public List<Badge> Badges { get; set; }
}
public class Account
{
public string github;
}
public class Badge
{
[JsonProperty("name")]
public string Name;
[JsonProperty("description")]
public string Description;
[JsonProperty("created")]
public string Created;
[JsonProperty("badge")]
public string BadgeUrl;
}
Другой, более упорядоченный подход к десериализации строки JSON в верблюжьей оболочке в POCO-объекте в паскалях заключается в использовании CamelCasePropertyNamesContractResolver.
Это часть пространства имен Newtonsoft.Json.Serialization. Этот подход предполагает, что единственное различие между объектом JSON и POCO заключается в расположении имен свойств. Если имена свойств пишутся по-разному, вам придется прибегнуть к использованию атрибутов JsonProperty для сопоставления имен свойств.
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
. . .
private User LoadUserFromJson(string response)
{
JsonSerializerSettings serSettings = new JsonSerializerSettings();
serSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
User outObject = JsonConvert.DeserializeObject<User>(jsonValue, serSettings);
return outObject;
}
Вы могли бы создать JsonConverter, Смотрите здесь пример, похожий на ваш вопрос.
Свойство account определяется следующим образом:
"accounts":{"github":"sergiotapia"}
Ваш POCO утверждает это:
public List<Account> Accounts { get; set; }
Попробуйте использовать этот Json:
"accounts":[{"github":"sergiotapia"}]
Массив элементов (который будет отображаться в списке) всегда заключен в квадратные скобки.
Изменить: Account Poco будет что-то вроде этого:
class Account {
public string github { get; set; }
}
и, возможно, другие свойства.
Редактировать 2: Чтобы не иметь массива, используйте свойство следующим образом:
public Account Accounts { get; set; }
с чем-то вроде примера класса, который я опубликовал в первом редактировании.
В дополнение к принятому ответу, если у вас есть образец текста JSON, вы можете подключить его к этому конвертеру, выбрать параметры и сгенерировать код C#.
Если вы не знаете тип во время выполнения, эта тема выглядит так, как будто она подходит.
динамически десериализовать JSON в любой переданный объект. C#
to fix this error either change the JSON to a JSON array (e.g. [1,2,3]) or change the
deserialized type so that it is a normal .NET type (e.g. not a primitive type like
integer, not a collection type like an array or List) that can be deserialized from a
JSON object.`
Сообщение целиком указывает на возможность сериализации в объект List, но входные данные должны быть списком JSON. Это означает, что ваш JSON должен содержать
"accounts" : [{<AccountObjectData}, {<AccountObjectData>}...],
Где данные AccountObject - это JSON, представляющий ваш объект Account или объект Badge
То, что он сейчас получает, это
"accounts":{"github":"sergiotapia"}
Где account - это объект JSON (обозначенный фигурными скобками), а не массив объектов JSON (массивы обозначены скобками), что вам и нужно. Пытаться
"accounts" : [{"github":"sergiotapia"}]
Для тех, у кого возникла эта проблема, я не видел значение json должным образом. там вы можете проверить классы, которые должны быть сгенерированы, и вернуть ТОЛЬКО ОДИН из этих классов, как только вы прочитаете json в своем коде.
Например, мне нужен объект списка книг, поэтому мой код должен читать только один
res = await response.Content.ReadAsAsync<BookList>();
Где список книг выглядит примерно так
public class BookList
{
[JsonProperty("data")]
public IList<Datum> Data { get; set; }
}
И в этом списке есть меньший книжный класс, который преобразователь назвал Datum (просто книги).
public class Datum
{
[JsonProperty("id")]
public string Id { get; set; }
[JsonProperty("isbn")]
public string Isbn { get; set; }
}
Опять же, если у вас есть сомнения https://jsonutils.com/https://jsonutils.com/
Может быть поздно, но использование QuickType — самый простой способ сделать это:
Это не совсем то, что я имел в виду. Что вы делаете, если у вас есть универсальный тип, который будет известен только во время выполнения?
public MyDTO toObject() {
try {
var methodInfo = MethodBase.GetCurrentMethod();
if (methodInfo.DeclaringType != null) {
var fullName = methodInfo.DeclaringType.FullName + "." + this.dtoName;
Type type = Type.GetType(fullName);
if (type != null) {
var obj = JsonConvert.DeserializeObject(payload);
//var obj = JsonConvert.DeserializeObject<type.MemberType.GetType()>(payload); // <--- type ?????
...
}
}
// Example for java.. Convert this to C#
return JSONUtil.fromJSON(payload, Class.forName(dtoName, false, getClass().getClassLoader()));
} catch (Exception ex) {
throw new ReflectInsightException(MethodBase.GetCurrentMethod().Name, ex);
}
}