Как включить необработанный JSON в объект, используя Джексона? - PullRequest
Новая
       44

Как включить необработанный JSON в объект, используя Джексона?

93 голосов
/ 24 января 2011

Я пытаюсь включить необработанный JSON в объект Java, когда объект (де) сериализован с использованием Джексона. Чтобы проверить эту функциональность, я написал следующий тест: 

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. в [Источник: java.io.StringReader@d70d7a; строка: 1, столбец: 13] (через цепочку ссылок: com.tnal.prism.cobalt.gather.testing.Pojo ["bar"])

Почему Джексон прекрасно работает в одном направлении, но не работает при движении в другом направлении? Похоже, что он должен быть в состоянии взять свой собственный вывод в качестве ввода снова. Я знаю, что я пытаюсь сделать, это неортодоксально (общий совет - создать внутренний объект для bar, который имеет свойство с именем A), но я вообще не хочу взаимодействовать с этим JSON. Мой код действует как проход для этого кода - я хочу взять этот JSON и снова отправить его обратно, не затрагивая ничего, потому что, когда JSON изменяется, я не хочу, чтобы мой код нуждался в изменениях.

Спасибо за совет.

EDIT: сделал Pojo статическим классом, который вызывал другую ошибку.

Ответы [ 12 ]

54 голосов
/ 24 января 2011

@ JsonRawValue предназначен только для стороны сериализации, поскольку обратное направление немного сложнее в обращении. Фактически он был добавлен, чтобы разрешить ввод предварительно закодированного содержимого.

Полагаю, можно было бы добавить поддержку реверса, хотя это было бы довольно неловко: контент нужно будет проанализировать, а затем переписать обратно в «сырую» форму, которая может совпадать или не совпадать ( поскольку цитирование символов может отличаться). Это для общего случая. Но, возможно, это имело бы смысл для некоторого подмножества проблем.

Но я думаю, что обходным решением для вашего конкретного случая было бы указать тип как 'java.lang.Object', поскольку это должно работать нормально: для сериализации String будет выводиться как есть, а для десериализации - быть десериализованным как карта. На самом деле вы можете захотеть иметь отдельный геттер / сеттер, если так; getter возвращает String для сериализации (и нуждается в @JsonRawValue); и установщик будет принимать либо карту, либо объект. Вы можете перекодировать его в строку, если это имеет смысл.

48 голосов
/ 12 июля 2012

После ответа @ 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}
  }
}
32 голосов
/ 06 июня 2014

Я смог сделать это с помощью специального десериализатора (вырезано и вставлено из здесь ) 

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();
    }
}
15 голосов
/ 05 декабря 2016

@ JsonSetter может помочь.Смотрите мой пример («данные» должны содержать неразобранный JSON): 

class Purchase
{
    String data;

    @JsonProperty("signature")
    String signature;

    @JsonSetter("data")
    void setData(JsonNode data)
    {
        this.data = data.toString();
    }
}
3 голосов
/ 23 июля 2017

Это работает даже в сущности 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) {
    // this leads to non-standard json, see discussion: 
    // setJson(jsonNode.toString());

    StringWriter stringWriter = new StringWriter();
    ObjectMapper objectMapper = new ObjectMapper();
    JsonGenerator generator = 
      new JsonFactory(objectMapper).createGenerator(stringWriter);
    generator.writeTree(n);
    setJson(stringWriter.toString());
}

В идеале ObjectMapper и даже JsonFactory взяты из контекста и настроены так, чтобы правильно обрабатывать ваш JSON (например, стандартные или с нестандартными значениями, такими как «бесконечность»).

3 голосов
/ 30 января 2017

Это простое решение сработало для меня: 

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, а не как объект, и это было не то, что я хотел.

3 голосов
/ 18 декабря 2016

Добавление к Roy Truelove замечательно ответ , это как добавить пользовательский десериализатор в ответ на появление @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;
    }
}
3 голосов
/ 24 января 2011

Это проблема ваших внутренних классов. Класс Pojo является нестатическим внутренним классом вашего тестового класса, и Джексон не может создать экземпляр этого класса. Так что он может сериализовать, но не десериализовать.

Переопределите свой класс следующим образом: 

public static class Pojo {
    public String foo;

    @JsonRawValue
    public String bar;
}

Обратите внимание на добавление static

1 голос
/ 19 июня 2018

У меня была похожая проблема, но я использовал список с большим количеством 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");
    }
}
1 голос
/ 08 ноября 2017

Вот полный рабочий пример того, как использовать модули Джексона, чтобы @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);
Страница:
...