Как настроить сериализацию списка объектов JAXB для JSON?

Я использую Джерси для создания веб-службы REST для серверного компонента.

JAXB-аннотированный объект, который я хочу сериализовать в списке, выглядит следующим образом:

@XmlRootElement(name = "distribution")
@XmlType(name = "tDistribution", propOrder = {
    "id", "name"
})
public class XMLDistribution {
    private String id;
    private String name;
    // no-args constructor, getters, setters, etc
}

У меня есть ресурс REST для извлечения одного дистрибутива, который выглядит следующим образом:

@Path("/distribution/{id: [1-9][0-9]*}")
public class RESTDistribution {
    @GET
    @Produces("application/json")
    public XMLDistribution retrieve(@PathParam("id") String id) {
        return retrieveDistribution(Long.parseLong(id));
    }
    // business logic (retrieveDistribution(long))
}

У меня также есть ресурс REST для получения списка всех дистрибутивов, который выглядит следующим образом:

@Path("/distributions")
public class RESTDistributions {
    @GET
    @Produces("application/json")
    public List<XMLDistribution> retrieveAll() {
        return retrieveDistributions();
    }
    // business logic (retrieveDistributions())
}

Я использую ContextResolver для настройки сериализации JAXB, которая в настоящее время настроена следующим образом:

@Provider
@Produces("application/json")
public class JAXBJSONContextResolver implements ContextResolver<JAXBContext> {
    private JAXBContext context;
    public JAXBJSONContextResolver() throws Exception {
        JSONConfiguration.MappedBuilder b = JSONConfiguration.mapped();
        b.nonStrings("id");
        b.rootUnwrapping(true);
        b.arrays("distribution");
        context = new JSONJAXBContext(b.build(), XMLDistribution.class);
    }
    @Override
    public JAXBContext getContext(Class<?> objectType) {
        return context;
    }
}

Ресурсы REST работают, а также контекстный разрешитель. Это пример вывода для первого:

// path: /distribution/1
{"id":1,"name":"Example Distribution"}

Это именно то, что я хочу. Это пример вывода для списка:

// path: /distributions
{"distribution":[{"id":1,"name":"Sample Distribution 1"},{"id":2,"name":"Sample Distribution 2"}]}

Это не совсем то, что я хочу.

Я не понимаю, почему есть тег distribution. Я хотел удалить его с помощью .rootUnwrapping(true) в контексте resolver, но, по-видимому, это только удаляет другой закрывающий тег. Это результат с .rootUnwrapping(false):

// path: /distribution/1
{"distribution":{"id":1,"name":"Example Distribution"}} // not ok
// path: /distributions
{"xMLDistributions":{"distribution":[{"id":1,"name":"Sample Distribution 1"},{"id":2,"name":"Sample Distribution 2"}]}}

Мне также пришлось настроить .arrays("distribution"), чтобы всегда получать массив JSON, даже с одним элементом.

В идеале я хотел бы иметь это как вывод:

// path: /distribution/1
{"id":1,"name":"Example Distribution"} // currently works
// path: /distributions
[{"id":1,"name":"Sample Distribution 1"},{"id":2,"name":"Sample Distribution 2"}]

Я попытался вернуть List<XMLDistribution>, a XMLDistributionList (обертка вокруг списка), XMLDistribution[], но я не смог найти способ получить простой массив распределений JSON в моем требуемом формате.

Я также пробовал другие записи, возвращенные JSONConfiguration.natural(), JSONConfiguration.mappedJettison() и т.д., и не мог получить ничего похожего на то, что мне нужно.

Кто-нибудь знает, можно ли настроить JAXB для этого?

Ответ 1

Я нашел решение: замените JAXB JSON-сериализатор на более корректный JSON-сериализатор, такой как Jackson. Легкий способ - использовать jackson-jaxrs, который уже сделал это для вас. Класс - JacksonJsonProvider. Все, что вам нужно сделать, это отредактировать свой проект web.xml, чтобы Джерси (или другая реализация JAX-RS) сканировала его. Вот что вам нужно добавить:

<init-param>
  <param-name>com.sun.jersey.config.property.packages</param-name>
  <param-value>your.project.packages;org.codehaus.jackson.jaxrs</param-value>
</init-param>

И все это к нему. Джексон будет использоваться для сериализации JSON, и он работает так, как вы ожидаете от списков и массивов.

Чем длиннее будет написать собственный пользовательский MessageBodyWriter, зарегистрированный для создания "application/json". Вот пример:

@Provider
@Produces("application/json")
public class JsonMessageBodyWriter implements MessageBodyWriter {
    @Override
    public long getSize(Object obj, Class type, Type genericType,
            Annotation[] annotations, MediaType mediaType) {
        return -1;
    }

    @Override
    public boolean isWriteable(Class type, Type genericType,
            Annotation annotations[], MediaType mediaType) {
        return true;
    }

    @Override
    public void writeTo(Object target, Class type, Type genericType,
            Annotation[] annotations, MediaType mediaType,
            MultivaluedMap httpHeaders, OutputStream outputStream)
            throws IOException {        
        new ObjectMapper().writeValue(outputStream, target);
    }
}

Вам нужно убедиться, что ваш web.xml включает пакет, как для готового решения выше.

В любом случае: вуаля! Вы увидите правильно сформированный JSON.

Вы можете скачать Джексон здесь: http://jackson.codehaus.org/

Ответ 1

Ответ 2