Как включить JSON в объект с помощью Jackson?
Я пытаюсь включить raw JSON внутри объекта Java, когда объект (de) сериализуется с использованием Jackson. Чтобы проверить эту функциональность, я написал следующий тест:
public static class Pojo {
public String foo;
@JsonRawValue
public String bar;
}
@Test
public void test() throws JsonGenerationException, JsonMappingException, IOException {
String foo = "one";
String bar = "{\"A\":false}";
Pojo pojo = new Pojo();
pojo.foo = foo;
pojo.bar = bar;
String json = "{\"foo\":\"" + foo + "\",\"bar\":" + bar + "}";
ObjectMapper objectMapper = new ObjectMapper();
String output = objectMapper.writeValueAsString(pojo);
System.out.println(output);
assertEquals(json, output);
Pojo deserialized = objectMapper.readValue(output, Pojo.class);
assertEquals(foo, deserialized.foo);
assertEquals(bar, deserialized.bar);
}
Код выводит следующую строку:
{"foo":"one","bar":{"A":false}}
JSON - это именно то, как я хочу, чтобы все выглядело. К сожалению, код не работает с исключением при попытке прочитать JSON обратно в объект. Вот исключение:
org.codehaus.jackson.map.JsonMappingException: не удается десериализовать экземпляр java.lang.String из токена START_OBJECT в [Источник: [email protected]; строка: 1, столбец: 13] (через цепочку ссылок: com.tnal.prism.cobalt.gather.testing.Pojo [ "bar" ])
Почему Джексон отлично работает в одном направлении, но не работает, когда идет в другом направлении? Кажется, он должен иметь возможность снова принимать свой собственный результат. Я знаю, что я пытаюсь сделать, это неортодоксальный (общий совет - создать внутренний объект для bar
, который имеет свойство с именем A
), но я не хочу вообще взаимодействовать с этим JSON. Мой код действует как сквозной код для этого кода - я хочу взять этот JSON и отправить его обратно, не касаясь вещи, потому что, когда изменения JSON меня не хотят, чтобы мой код нуждался в модификациях.
Спасибо за совет.
EDIT: Сделал Pojo статическим классом, который вызывал другую ошибку.
Ответы
Ответ 1
@JsonRawValue предназначен только для сериализации, так как обратное направление немного сложнее для обработки. По сути, он был добавлен, чтобы позволить вводить предварительно кодированный контент.
Я думаю, можно было бы добавить поддержку для обратного, хотя это было бы довольно неудобно: контент должен быть проанализирован, а затем переписан обратно в "сырую" форму, которая может быть или не быть одинаковой ( поскольку котировка символов может отличаться).
Это для общего случая. Но, возможно, это имело бы смысл для некоторых подмножеств проблем.
Но я думаю, что для вашего конкретного случая можно было бы указать тип как "java.lang.Object", так как это должно работать нормально: для сериализации строка будет выводиться как есть, и для десериализации она будет десериализоваться как карта. На самом деле, возможно, вы захотите иметь отдельный геттер/сеттер; getter возвращает String для сериализации (и нуждается в @JsonRawValue); и сеттер возьмет либо карту, либо объект. Вы можете перекодировать его в String, если это имеет смысл.
Ответ 2
Следуя @StaxMan, я сделал следующие работы как шарм:
public class Pojo {
Object json;
@JsonRawValue
public String getJson() {
// default raw value: null or "[]"
return json == null ? null : json.toString();
}
public void setJson(JsonNode node) {
this.json = node;
}
}
И, чтобы быть верным первому вопросу, вот рабочий тест:
public class PojoTest {
ObjectMapper mapper = new ObjectMapper();
@Test
public void test() throws IOException {
Pojo pojo = new Pojo("{\"foo\":18}");
String output = mapper.writeValueAsString(pojo);
assertThat(output).isEqualTo("{\"json\":{\"foo\":18}}");
Pojo deserialized = mapper.readValue(output, Pojo.class);
assertThat(deserialized.json.toString()).isEqualTo("{\"foo\":18}");
// deserialized.json == {"foo":18}
}
}
Ответ 3
Я смог сделать это с помощью специального десериализатора (вырезать и вставить из здесь)
package etc;
import java.io.IOException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.TreeNode;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
/**
* Keeps json value as json, does not try to deserialize it
* @author roytruelove
*
*/
public class KeepAsJsonDeserialzier extends JsonDeserializer<String> {
@Override
public String deserialize(JsonParser jp, DeserializationContext ctxt)
throws IOException, JsonProcessingException {
TreeNode tree = jp.getCodec().readTree(jp);
return tree.toString();
}
}
Ответ 4
@JsonSetter может помочь. См. Мой пример ( "данные" должны содержать unparsed JSON):
class Purchase
{
String data;
@JsonProperty("signature")
String signature;
@JsonSetter("data")
void setData(JsonNode data)
{
this.data = data.toString();
}
}
Ответ 5
Это даже работает в сущности JPA:
private String json;
@JsonRawValue
public String getJson() {
return json;
}
public void setJson(final String json) {
this.json = json;
}
@JsonProperty(value = "json")
public void setJsonRaw(JsonNode jsonNode) {
setJson(jsonNode.toString());
}
Ответ 6
Это проблема с вашими внутренними классами. Класс Pojo
является нестационарным внутренним классом вашего тестового класса, и Джексон не может создать экземпляр этого класса. Поэтому он может сериализоваться, но не десериализоваться.
Переопределите свой класс следующим образом:
public static class Pojo {
public String foo;
@JsonRawValue
public String bar;
}
Обратите внимание на добавление static
Ответ 7
Добавляя к Рой Трулову отличный ответ, это как ввести пользовательский десериализатор в ответ на внешний вид @JsonRawValue
:
import com.fasterxml.jackson.databind.Module;
@Component
public class ModuleImpl extends Module {
@Override
public void setupModule(SetupContext context) {
context.addBeanDeserializerModifier(new BeanDeserializerModifierImpl());
}
}
import java.util.Iterator;
import com.fasterxml.jackson.annotation.JsonRawValue;
import com.fasterxml.jackson.databind.BeanDescription;
import com.fasterxml.jackson.databind.DeserializationConfig;
import com.fasterxml.jackson.databind.deser.BeanDeserializerBuilder;
import com.fasterxml.jackson.databind.deser.BeanDeserializerModifier;
import com.fasterxml.jackson.databind.deser.SettableBeanProperty;
public class BeanDeserializerModifierImpl extends BeanDeserializerModifier {
@Override
public BeanDeserializerBuilder updateBuilder(DeserializationConfig config, BeanDescription beanDesc, BeanDeserializerBuilder builder) {
Iterator<SettableBeanProperty> it = builder.getProperties();
while (it.hasNext()) {
SettableBeanProperty p = it.next();
if (p.getAnnotation(JsonRawValue.class) != null) {
builder.addOrReplaceProperty(p.withValueDeserializer(KeepAsJsonDeserialzier.INSTANCE), true);
}
}
return builder;
}
}
Ответ 8
Это легкое решение сработало для меня:
public class MyObject {
private Object rawJsonValue;
public Object getRawJsonValue() {
return rawJsonValue;
}
public void setRawJsonValue(Object rawJsonValue) {
this.rawJsonValue = rawJsonValue;
}
}
Таким образом, я смог сохранить исходное значение JSON в переменной rawJsonValue, и тогда было бы нецелесообразно десериализовать его (как объект) с другими полями в JSON и отправить через мой REST. Использование @JsonRawValue мне не помогло, потому что сохраненный JSON был десериализован как String, а не как объект, и это было не то, что я хотел.
Ответ 9
У меня была такая же проблема.
Я нашел решение в этом сообщении:
Разделите дерево JSON на простой класс, используя Джексон или его альтернативы
Проверьте последний ответ.
Определив настраиваемый параметр для свойства, которое принимает параметр JsonNode в качестве параметра и вызывает метод toString в jsonNode для установки свойства String, все это работает.
Ответ 10
Использование объекта отлично работает в обоих направлениях... Этот метод имеет немного служебных операций десериализации исходного значения в два раза.
ObjectMapper mapper = new ObjectMapper();
RawJsonValue value = new RawJsonValue();
value.setRawValue(new RawHello(){{this.data = "universe...";}});
String json = mapper.writeValueAsString(value);
System.out.println(json);
RawJsonValue result = mapper.readValue(json, RawJsonValue.class);
json = mapper.writeValueAsString(result.getRawValue());
System.out.println(json);
RawHello hello = mapper.readValue(json, RawHello.class);
System.out.println(hello.data);
RawHello.java
public class RawHello {
public String data;
}
RawJsonValue.java
public class RawJsonValue {
private Object rawValue;
public Object getRawValue() {
return rawValue;
}
public void setRawValue(Object value) {
this.rawValue = value;
}
}
Ответ 11
Вот полный рабочий пример того, как использовать модули Jackson, чтобы сделать @JsonRawValue
работать в обоих направлениях (сериализация и десериализация):
public class JsonRawValueDeserializerModule extends SimpleModule {
public JsonRawValueDeserializerModule() {
setDeserializerModifier(new JsonRawValueDeserializerModifier());
}
private static class JsonRawValueDeserializerModifier extends BeanDeserializerModifier {
@Override
public BeanDeserializerBuilder updateBuilder(DeserializationConfig config, BeanDescription beanDesc, BeanDeserializerBuilder builder) {
builder.getProperties().forEachRemaining(property -> {
if (property.getAnnotation(JsonRawValue.class) != null) {
builder.addOrReplaceProperty(property.withValueDeserializer(JsonRawValueDeserializer.INSTANCE), true);
}
});
return builder;
}
}
private static class JsonRawValueDeserializer extends JsonDeserializer<String> {
private static final JsonDeserializer<String> INSTANCE = new JsonRawValueDeserializer();
@Override
public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
return p.readValueAsTree().toString();
}
}
}
Затем вы можете зарегистрировать модуль после создания ObjectMapper
:
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new JsonRawValueDeserializerModule());
String json = "{\"foo\":\"one\",\"bar\":{\"A\":false}}";
Pojo deserialized = objectMapper.readValue(json, Pojo.class);
Ответ 12
У меня была аналогичная проблема, но с использованием списка с большим количеством JSON itens (List<String>
).
public class Errors {
private Integer status;
private List<String> jsons;
}
Мне удалось сериализовать, используя аннотацию @JsonRawValue
. Но для десериализации я должен был создать собственный десериализатор на основе предложения Роя.
public class Errors {
private Integer status;
@JsonRawValue
@JsonDeserialize(using = JsonListPassThroughDeserialzier.class)
private List<String> jsons;
}
Ниже вы можете увидеть мой десериализатор "Список".
public class JsonListPassThroughDeserializer extends JsonDeserializer<List<String>> {
@Override
public List<String> deserialize(JsonParser jp, DeserializationContext cxt) throws IOException, JsonProcessingException {
if (jp.getCurrentToken() == JsonToken.START_ARRAY) {
final List<String> list = new ArrayList<>();
while (jp.nextToken() != JsonToken.END_ARRAY) {
list.add(jp.getCodec().readTree(jp).toString());
}
return list;
}
throw cxt.instantiationException(List.class, "Expected Json list");
}
}