Search code examples
javaxmlspringjacksonxml-deserialization

Jackson deserialize xml fields with the same name


I would like to deserialize a XML response from an HTTP request into a list of POJOs. The issue I am encountering is that the XML uses the same name "property" for elements that contain different values.

<nowplaying-info-list>
    <nowplaying-info mountName="FGDGFD" timestamp="1559761606" type="track">
        <property name="cue_time_duration">
            <![CDATA[262000]]>
        </property>
        <property name="cue_time_start">
            <![CDATA[1559761571830]]>
        </property>
        <property name="cue_title">
            <![CDATA[Marine marchande]]>
        </property>
        <property name="track_album_name">
            <![CDATA[Octobre]]>
        </property>
        <property name="track_artist_name">
            <![CDATA[Les Cowboys Fringants]]>
        </property>
        <property name="track_id">
            <![CDATA[8133]]>
        </property>
        </property>
    </nowplaying-info>
...
@JacksonXmlRootElement(localName = "nowplaying-info")
public class ScheduleItem implements Serializable {
    @JacksonXmlProperty(localName = "property")
    private String song = null;
    private String artist = null;
    private String cover = null;
    private Long datetime = null;

I would like to serialize the property with the name cue_title to the song variable and cue_time_start to datetime.


Solution

  • There is no easy mapping between fields and lists. I suggest to create separate model, deserialise XML payload to it and convert to required POJO afterwards. Below example shows that idea:

    import com.fasterxml.jackson.annotation.JsonProperty;
    import com.fasterxml.jackson.core.type.TypeReference;
    import com.fasterxml.jackson.databind.DeserializationFeature;
    import com.fasterxml.jackson.dataformat.xml.XmlMapper;
    import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
    import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlText;
    import java.io.File;
    import java.util.LinkedHashMap;
    import java.util.List;
    import java.util.Map;
    import java.util.stream.Collectors;
    import org.apache.commons.lang3.StringUtils;
    
    public class XmlApp {
    
        public static void main(String[] args) throws Exception {
            System.out.println(new File(".").getAbsolutePath());
            File xml = new File("./src/main/resources/test.xml");
            XmlMapper xmlMapper = new XmlMapper();
            xmlMapper.setDefaultUseWrapper(false);
            xmlMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
    
            TypeReference<List<NowPlayingInfo>> type = new TypeReference<List<NowPlayingInfo>>() {
            };
            List<NowPlayingInfo> infos = xmlMapper.readValue(xml, type);
            List<ScheduleItem> items = infos.stream()
                .map(NowPlayingInfo::getPropertiesAsMap)
                .map(m -> {
                    ScheduleItem item = new ScheduleItem();
                    item.setSong(m.get("cue_title"));
                    item.setDatetime(Long.parseLong(m.get("cue_time_start")));
                    return item;
                }).collect(Collectors.toList());
            items.forEach(System.out::println);
        }
    }
    
    class ScheduleItem {
    
        private String song;
        private String artist;
        private String cover;
        private Long datetime;
    
        //getters, setters, toString
    }
    
    class NowPlayingInfo {
    
        private String mountName;
        private long timestamp;
        private String type;
    
        @JsonProperty("property")
        private List<Property> properties;
    
        public Map<String, String> getPropertiesAsMap() {
            Map<String, String> map = new LinkedHashMap<>();
            properties.forEach(p -> map.put(p.getName(), StringUtils.strip(p.getValue())));
            return map;
        }
    
        //getters, setters, toString
    }
    
    class Property {
    
        @JacksonXmlText
        private String value;
    
        @JacksonXmlProperty(isAttribute = true)
        private String name;
    
        //getters, setters, toString
    }
    

    Above app for your XML prints:

    ScheduleItem{song='Marine marchande', artist='null', cover='null', datetime=1559761571830}