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


103

Я пытаюсь включить необработанный 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 статическим классом, который вызывал другую ошибку.

Ответы:


65

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

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

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


1
Это работает как шарм; см. мой ответ для кода ( форматирование в комментариях - awgul ).
yves amsellem

У меня был другой вариант использования этого. Похоже, что если мы не хотим генерировать много строкового мусора в deser / ser, мы должны иметь возможность просто пропустить строку как таковую. Я видел поток, который отслеживал это, но похоже, что нативная поддержка невозможна. Взгляните на markmail.org/message/…
Сид,

@Sid нет способа сделать это И токенизацию эффективно. Для поддержки передачи необработанных токенов потребуется дополнительное сохранение состояния, что делает «обычный» синтаксический анализ несколько менее эффективным. Это что-то вроде оптимизации между обычным кодом и выдачей исключений: поддержка последнего добавляет накладные расходы для первого. Джексон не был разработан, чтобы пытаться сохранить доступность необработанного ввода; Было бы неплохо иметь его (в том числе и для сообщений об ошибках), но для этого потребуется другой подход.
StaxMan

55

После ответа @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}
  }
}

1
Я не пробовал, но это должно сработать: 1) создать узел JsonNode вместо Object json 2) использовать node.asText () вместо toString (). Хотя насчет второго я не уверен.
Вадим Кирильчук

Интересно, почему все- getJson()таки возвращается String. Если он просто вернет значение JsonNode, установленное через сеттер, он будет сериализован по желанию, не так ли?
sorrymissjackson

@VadimKirilchuk node.asText()возвращает пустое значение напротив toString().
v.ladynev 08

37

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

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

6
Удивительно, как просто. ИМО, это должен быть официальный ответ. Я пробовал использовать очень сложную структуру, содержащую массивы, подобъекты и т. Д. Возможно, вы отредактируете свой ответ и добавите, что член String, который нужно десериализовать, должен быть аннотирован @JsonDeserialize (using = KeepAsJsonDeserialzier.class). (и исправьте опечатку в названии вашего класса ;-)
Heri

это работает для Deserializion. Как насчет сериализации необработанного json в pojo? Как бы это было достигнуто
xtrakBandit

4
@xtrakBandit для сериализации, используйте@JsonRawValue
smartwjw

Это работает как шарм. Спасибо, Рой и @Heri ..com, комбинация этого поста с комментарием Хери - imho лучший ответ.
Михал

Простое и удобное решение. Я согласен с @Heri
mahesh nanayakkara 09

18

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

class Purchase
{
    String data;

    @JsonProperty("signature")
    String signature;

    @JsonSetter("data")
    void setData(JsonNode data)
    {
        this.data = data.toString();
    }
}

3
Согласно документации JsonNode.toString () Метод, который будет создавать удобочитаемое представление узла; который может <b> или не </b> быть таким же действительным JSON. Так что на самом деле это очень рискованная реализация.
Петр

@Piotr, javadoc теперь говорит: «Метод, который будет создавать (по состоянию на Jackson 2.10) действительный JSON, используя настройки
привязки данных

4

В дополнение к отличному ответу Роя Трулава , вот как ввести настраиваемый десериализатор в ответ на появление :@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;
    }
}

это не работает в Jackson 2.9. Похоже, он был сломан, поскольку теперь он использует старое свойство в PropertyBasedCreator.construct вместо замены одного
dant3

3

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

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

public static class Pojo {
    public String foo;

    @JsonRawValue
    public String bar;
}

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


Спасибо. Это дало мне еще один шаг вперед, но теперь я получаю другую ошибку. Я обновлю исходный пост с новой ошибкой.
bhilstrom

3

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

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

Это работает даже в сущности 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 (например, стандартные или с нестандартными значениями, такими как «Infinity» с плавающей точкой).


1
Согласно JsonNode.toString()документации. Method that will produce developer-readable representation of the node; which may <b>or may not</b> be as valid JSON.Так что на самом деле это очень рискованная реализация.
Петр

Привет @Piotr, спасибо за подсказку. Вы правы, конечно, это использует JsonNode.asText()внутреннее значение и выводит Infinity и другие нестандартные значения JSON.
Георг

@Piotr, javadoc теперь говорит: «Метод, который будет создавать (по состоянию на Jackson 2.10) действительный JSON, используя настройки
привязки данных

2

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

Есть ли что-то еще, что вам нужно сделать помимо вышеперечисленного? Я обнаружил, что метод десериализации JsonRawValueDeserializer никогда не вызывается ObjectMapper
Майкл Коксон,

@MichaelCoxon Тебе удалось заставить его работать? Одна вещь, которая вызывала у меня проблемы в прошлом, заключалась в использовании аннотаций из org.codehaus.jacksonпакета, не осознавая этого. Убедитесь, что весь ваш импорт исходит из com.fasterxml.jackson.
Helder Pereira

1

У меня была такая же проблема. Я нашел решение в этом посте: Разобрать дерево JSON до простого класса с помощью Джексона или его альтернатив

Проверьте последний ответ. Благодаря определению настраиваемого установщика для свойства, которое принимает JsonNode в качестве параметра и вызывает метод toString на jsonNode для установки свойства String, все работает.


1

Использование объекта прекрасно работает в обоих направлениях ... Этот метод имеет небольшие накладные расходы на десериализацию необработанного значения в два раза.

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;
    }
}

1

У меня была аналогичная проблема, но я использовал список с большим количеством 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");
    }
}
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.