XML attributes are not correctly populated when converting from XML (ObjectNode) to String using writeValueAsString (XML structure)

Offen
  • Stimmt etwas nicht?
#613 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Bug
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
java
Bereich
backend

Rechercherichtung

Beginne mit dem Beispieldriver, der XmlMapper.readTree und writeValueAsString verwendet, und untersuche dann den benutzerdefinierten AnimalDeserializer.java und dessen Methode readObjectNodeAsString. Vergleiche den geparsten ObjectNode mit dem erwarteten XML, einschließlich Attributen und Namespace-Deklarationen; abgeschlossen ist die Aufgabe, wenn die Konvertierung diese Attribute und Namespaces beibehält, statt untergeordnete Elemente auszugeben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Hi @cowtowncoder,

We are planning to migrate our old deserialization logic from using fragmented substrings between <open> and </closing> tags when deserializing an XML String to POJOs into Jackson’s sophisticated custom StdDeserializers/JsonDeserializers directly starting from version 2.15.2.

I have a few questions about whether this feature of mine already exists or not.

My team and I are trying to deserialize a very complex XML structure, to the point that we do not have to create multiple beans because some of the content of our XML subtree often changes dynamically with minimal format structure (we have ~10 XML formats to support with or without attributes and namespaces) and is also a valid XML structure. WE mostly used custom deserializers like StdDeserializer and JsonDeserializer to map ObjectNode into plain Map (well internally, this is already a Map) (thanks for your suggestion in #574) and then later converted it back to String.

While I still stumbled across our implementation to keep our XML subtree to be deserialized via substring. But then later we planned to stick to using JsonNode to retrieve segments of XML and convert it back to the original XML as String using SegmentedStringWriter#writeValueAsString, for a reason that we wanted to leverage the java.xml.stream.* without the need to retrieve full string token and to fully adapt Jackson's Streaming API interoperability. We do not want to convert it into a plain POJO, but instead, would rather use the java.util.Map class to keep it generic and to store every JsonNode token retrieved from ObjectNode#getValue().

Sample Scenario

Supposedly, I have an XML element that contains an attribute name and age.

<animal>
  <dog name="tucker" age="2">woof woof!</dog>
  <cat name="cody" age="2">meowwwwwww!</cat>
  <chicken name="browny" age="3">cluck cluck!</chicken>
  <pig name="porky" age="4">oink oink!</pig>
</animal>

XML Attribute

The output I would expect should be the same as the original XML, but in my case, it's not:

<animal>
  <dog>
    <name>tucker</name>
    <age>2</age>
    <>woof woof!</>
  </dog>
  <cat>
    <name>cody</name>
    <age>2</age>
    <>meowwwwwww!</>
  </cat>
  <chicken>
    <name>browny</name>
    <age>3</age>
    <>cluck cluck cluck cluck!</>
  </chicken>
  <pig>
    <name>porky</name>
    <age>4</age>
    <>oink oink!</>
  </pig>
</animal>

The attributes became sub-elements of the original element, while the element tag of the original element value becomes empty: <>...</>

XML Namespace

The same happens with namespaces:
suppose Animal namespace declaration: <ns1:animal xmlns:ns1="urn:this:is:namespace:for:animal">

Output:

<animal>
  <xmlns:ns1>urn:this:is:namespace:for:animal</xmlns:ns1>
  <ns1:dog>
    <name>tucker</name>
    <age>2</age>
    <>woof woof!</>
  </ns1:dog>
  <!-- ... -->
</animal>

The namespace becomes a new element.

My assumption is that it will only work with a plain XML structure (excluding the attributes itself) or with bean-defined POJOs annotated XML attr properties.

Sampe Driver Code

Tried using custom XmlMapper config:

private static XMLInputFactory xmlInputFactory() {
  final XMLInputFactory factory = XMLInputFactory.newInstance();
  factory.setProperty(XMLInputFactory.IS_NAMESPACE_AWARE, false);
  return factory;
}

OBJECT_WRITER = new XmlMapper(xmlInputFactory(), customJacksonXmlModule())
   .configure(ToXmlGenerator.Feature.WRITE_XML_DECLARATION, true)
   .enable(SerializationFeature.INDENT_OUTPUT)
   .writer();


JsonNode node = mapper.readTree(
 "<animal>\n"
 + "  <dog name=\"tucker\" age=\"2\">woof woof!</dog>\n"
 + "  <cat name=\"cody\" age=\"2\">meowwwwwww!</cat>\n"
 + "  <chicken name=\"browny\" age=\"3\">cluck cluck!</chicken>\n"
 + "  <pig name=\"porky\" age=\"4\">oink oink!</pig>\n"
 + " </animal>");

System.out.println(mapper.writer().withDefaultPrettyPrinter().withRootName("animal").writeValueAsString(node));

and with a custom deserializer for the Animal bean.

@JsonDeserialize(using = AnimalDeserializer.class)
class Animal {
 String xmlContent; // <-- JsonNode to String: <dog name="tucker" age="2">woof woof!</dog>...
}
AnimalDeserializer.java
@Override
public T deserialize(JsonParser parser, DeserializationContext context) throws IOException {
  final ObjectCodec codec = parser.getCodec();
  final ObjectNode objectNode = codec.readTree(parser);

  final T object = codec.readValue(objectNode.traverse(), getValueType(context));
  final Iterator<Entry<String, JsonNode>> nodeIterator = objectNode.fields();

  while (nodeIterator.hasNext()) {
    Entry<String, JsonNode> nodeEntry = nodeIterator.next();
    // we manually set the value for non-annotated @JsonProperty() fields, let Jackson take care for us!!
    if (!attributes().contains(nodeEntry.getKey())) {
      if (nodeEntry.getValue() instanceof ObjectNode) {
        object.setContent(readObjectNodeAsString(nodeEntry));
      } 
      ...
    }
  }

  return object;
}

private String readObjectNodeAsString(Entry<String, JsonNode> nodeEntry) {
  try {
    return OBJECT_WRITER
        .withRootName(nodeEntry.getKey())
        .writeValueAsString(nodeEntry.getValue());
  }
  ...
}

Update:

When using TypeReference<Map<String, String>(){}, it prints the expected XML output. However, the attribute is still missing.

Map<String, String> node = XML_MAPPER.readValue("...", new TypeReference<Map<String, String>>() {});

Output:

<?xml version='1.0' encoding='UTF-8'?>
<animal>
  <dog>woof woof!</dog>
  <cat>meowwwwwww!</cat>
  ...

We really appreciate your feedback and suggestions for this @cowtowncoder

Vorherrschende Sprache
Java
Sterne
636
Forks
250
Ø Merge
7 Std. 10 Min.
Gemergte PRs (30 T.)
8

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus FasterXML/jackson-dataformat-xml

Alle Issues in FasterXML/jackson-dataformat-xml

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.