Як я можу включити сирий JSON в об’єкт за допомогою Джексона?


102

Я намагаюся включити сирий 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який має властивість з назвою A), але я взагалі не хочу взаємодіяти з цим JSON. Мій код виконує функцію пропуску цього коду - я хочу взяти цей JSON і знову надіслати його, не торкаючись жодної речі, тому що, коли JSON змінюється, я не хочу, щоб мій код не потребував змін.

Дякую за пораду.

EDIT: Зробив Pojo статичним класом, який спричинив інші помилки.

Відповіді:


64

@JsonRawValue призначений лише для серіалізації, оскільки зворотний напрямок трохи складніше для обробки. По суті, він був доданий, щоб дозволити введення попередньо закодованого контенту.

Я думаю, можна було б додати підтримку зворотного зв'язку, хоча це було б досить незручно: вміст доведеться проаналізувати, а потім переписати назад у "сировинну" форму, яка може бути, а може бути і не однаковою (оскільки цитування символів можуть відрізнятися). Це для загального випадку. Але, можливо, це мало б сенс для деяких наборів проблем.

Але я думаю, що вирішенням вашого конкретного випадку було б вказати тип як "java.lang.Object", оскільки це має спрацювати нормально: для серіалізації String буде виведений таким, який є, а для десеріалізації - буде деріаріалізований як мапа. Насправді ви можете мати окремий геттер / сетер, якщо так; getter поверне рядок для серіалізації (і потребує @JsonRawValue); і сетер візьме або карту, або об’єкт. Ви можете перекодувати його до String, якщо це має сенс.


1
Це працює як шарм; дивіться мою відповідь щодо коду ( форматування в коментарях - помилкове ).
yves amsellem

У мене був інший випадок використання для цього. Схоже, якщо ми не хочемо створювати багато сміттєвого сміття в дезертирі / ser, ми повинні мати можливість просто пройти рядок як такий. Я побачив нитку, яка відстежувала це, але, здається, немає можливої ​​підтримки. Подивіться на markmail.org/message/…
Sid

@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 (). Я не впевнений, що стосується 2-го.
Вадим Кирильчук

Цікаво , чому getJson()ж повертають в Stringкінці кінців. Якби він просто повернув те, JsonNodeщо було встановлено через сетер, воно було б серіалізоване за бажанням, ні?
sorrymissjackson

@VadimKirilchuk node.asText()повертає порожнє значення навпроти toString().
v.ladynev

36

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

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
Дивно, як просто. ІМО, це має бути офіційною відповіддю. Я спробував із дуже складною структурою, що містить масиви, субекти тощо. (і виправіть друк у назві свого класу ;-)
Heri,

це працює для Deserializion. Як щодо серіалізації сирої json в pojo? Як би це було досягнуто
xtrakBandit

4
@xtrakBandit для серіалізації, використання@JsonRawValue
smartwjw

Це працює як шарм. Дякую Рою та @Heri ..com. Комбінація цього допису разом із коментарем Хері - це найкраща відповідь.
Міхал

Просте і акуратне рішення. Я згоден з @Heri
mahesh nanayakkara

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 тепер говорить "Метод, який створить (станом на Джексона 2.10) дійсний JSON, використовуючи налаштування за замовчуванням databind, як String"
Берні,

4

Додаючи чудову відповідь Роя 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;
    }
}

це не працює в Джексона 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 тепер говорить "Метод, який створить (станом на Джексона 2.10) дійсний JSON, використовуючи налаштування за замовчуванням databind, як String"
Берні,

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.
Хелдер Перейра

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.