Пользовательская десериализация JSON с помощью Jackson
Я использую Flickr API. При вызове flickr.test.login
метод, результат JSON по умолчанию:
{
"user": {
"id": "21207597@N07",
"username": {
"_content": "jamalfanaian"
}
},
"stat": "ok"
}
Я хотел бы разобрать этот ответ на объект Java:
public class FlickrAccount {
private String id;
private String username;
// ... getter & setter ...
}
свойства JSON должны быть сопоставлены следующим образом:
"user" -> "id" ==> FlickrAccount.id
"user" -> "username" -> "_content" ==> FlickrAccount.username
к сожалению, я не смог найти хороший, элегантный способ сделать это с помощью аннотаций. Мой подход до сих пор заключается в том, чтобы прочитать строку JSON в Map<String, Object>
и получить значения из там.
Map<String, Object> value = new ObjectMapper().readValue(response.getStream(),
new TypeReference<HashMap<String, Object>>() {
});
@SuppressWarnings( "unchecked" )
Map<String, Object> user = (Map<String, Object>) value.get("user");
String id = (String) user.get("id");
@SuppressWarnings( "unchecked" )
String username = (String) ((Map<String, Object>) user.get("username")).get("_content");
FlickrAccount account = new FlickrAccount();
account.setId(id);
account.setUsername(username);
но я думаю, это самый элегантный способ, когда-либо. Есть ли простой способ, используя аннотации или пользовательский десериализатор?
это было бы очень очевидно для меня, но, конечно, это не работает:
public class FlickrAccount {
@JsonProperty( "user.id" ) private String id;
@JsonProperty( "user.username._content" ) private String username;
// ... getter and setter ...
}
4 ответов
Вы можете написать пользовательский десериализатор для этого класса. Это может выглядеть так:
class FlickrAccountJsonDeserializer extends JsonDeserializer<FlickrAccount> {
@Override
public FlickrAccount deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException, JsonProcessingException {
Root root = jp.readValueAs(Root.class);
FlickrAccount account = new FlickrAccount();
if (root != null && root.user != null) {
account.setId(root.user.id);
if (root.user.username != null) {
account.setUsername(root.user.username.content);
}
}
return account;
}
private static class Root {
public User user;
public String stat;
}
private static class User {
public String id;
public UserName username;
}
private static class UserName {
@JsonProperty("_content")
public String content;
}
}
после этого, вы должны определить сериализатор для класса. Вы можете сделать это следующим образом:
@JsonDeserialize(using = FlickrAccountJsonDeserializer.class)
class FlickrAccount {
...
}
так как я не хочу реализовывать пользовательский класс (Username
) просто чтобы отобразить имя пользователя, я пошел с немного более элегантным, но все же довольно уродливым подходом:
ObjectMapper mapper = new ObjectMapper();
JsonNode node = mapper.readTree(in);
JsonNode user = node.get("user");
FlickrAccount account = new FlickrAccount();
account.setId(user.get("id").asText());
account.setUsername(user.get("username").get("_content").asText());
это все еще не так элегантно, как я надеялся, но, по крайней мере, я избавился от всего уродливого литья.
Другим преимуществом этого решения является то, что мой класс домена (FlickrAccount
) не загрязнен никакими аннотациями Джексона.
на основе @Михал Ziober это, я решил использовать в моем мнение - самое прямое решение. С помощью @JsonDeserialize
аннотация с пользовательский десериализатор:
@JsonDeserialize( using = FlickrAccountDeserializer.class )
public class FlickrAccount {
...
}
но десериализатор не использует никаких внутренних классов, только JsonNode
как выше:
class FlickrAccountDeserializer extends JsonDeserializer<FlickrAccount> {
@Override
public FlickrAccount deserialize(JsonParser jp, DeserializationContext ctxt) throws
IOException, JsonProcessingException {
FlickrAccount account = new FlickrAccount();
JsonNode node = jp.readValueAsTree();
JsonNode user = node.get("user");
account.setId(user.get("id").asText());
account.setUsername(user.get("username").get("_content").asText());
return account;
}
}
вы также можете использовать SimpleModule.
SimpleModule module = new SimpleModule();
module.setDeserializerModifier(new BeanDeserializerModifier() {
@Override public JsonDeserializer<?> modifyDeserializer(
DeserializationConfig config, BeanDescription beanDesc, JsonDeserializer<?> deserializer) {
if (beanDesc.getBeanClass() == YourClass.class) {
return new YourClassDeserializer(deserializer);
}
return deserializer;
}});
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(module);
objectMapper.readValue(json, classType);