Одна модель домена, несколько представлений json

У нас есть набор классов домена, которые сериализуются в json через jackson, используя службы Джерси. В настоящее время мы аннотируем классы с помощью JAXB (хотя мы не привязаны к этому). Это прекрасно работает. Но мы хотим предложить различные сериализации классов для разных вариантов использования.

  • веб-сайт
  • мобильные приложения
  • инструмент администрирования
  • публичный API

в каждом из этих случаев есть различные поля, которые мы может или не может быть включен в представление json. Например, средства администрирования могут понадобиться некоторые параметры для настройки разрешений на данные. Мобильный клиент должен иметь другой URL-адрес для медиа-потока, чем веб-сайт. Веб-сайт имеет особые соглашения об именах, необходимые для полей.

какова наилучшая практика управления различными сопоставлениями json для разных конечных точек службы в Джерси?

спасибо!

7
jackson jaxb jersey json

1 ответов

Примечание: Я EclipseLink JAXB (MOXy) ведущий и член JAXB (JSR-222) группы экспертов.

MOXy предлагает привязку JSON на основе аннотаций JAXB, а также внешний документ привязки, который позволяет применять альтернативные сопоставления к модели домена. Я продемонстрирую ниже на примере.

метаданные как аннотации JAXB

ниже простое сопоставление моделей Java со стандартными аннотациями JAXB.

package forum10761762;

import javax.xml.bind.annotation.*;

@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {

    int id;

    @XmlElement(name="first-name")
    String firstName;

    @XmlElement(name="last-name")
    String lastName;

}

альтернативные метаданные #1 (alternate1.в XML)

здесь мы будем использовать документ сопоставления XML, чтобы отменить сопоставление нескольких полей, сделав их @XmlTransient.

<?xml version="1.0"?>
<xml-bindings
    xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm"
    package-name="forum10761762">
    <java-types>
        <java-type name="Customer">
            <java-attributes>
                <xml-transient java-attribute="id"/>
                <xml-transient java-attribute="firstName"/>
             </java-attributes>
        </java-type>
    </java-types>
</xml-bindings>

альтернативные метаданные #2 (alternate2.в XML)

здесь мы сопоставим модель Java с другой структурой JSON, используя сопоставление на основе пути MOXy расширение.

<?xml version="1.0"?>
<xml-bindings
    xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm"
    package-name="forum10761762">
    <java-types>
        <java-type name="Customer">
            <java-attributes>
                <xml-element java-attribute="firstName" xml-path="personalInfo/firstName/text()"/>
                <xml-element java-attribute="lastName" xml-path="personalInfo/lastName/text()"/>
             </java-attributes>
        </java-type>
    </java-types>
</xml-bindings>

Код

package forum10761762;

import java.util.*;
import javax.xml.bind.*;
import org.eclipse.persistence.jaxb.JAXBContextProperties;

public class Demo {

    public static void main(String[] args) throws Exception {
        Customer customer = new Customer();
        customer.id = 123;
        customer.firstName = "Jane";
        customer.lastName = "Doe";

        Map<String, Object> properties = new HashMap<String, Object>();
        properties.put(JAXBContextProperties.MEDIA_TYPE, "application/json");
        properties.put(JAXBContextProperties.JSON_INCLUDE_ROOT, false);

        // Output #1
        JAXBContext jc1 = JAXBContext.newInstance(new Class[] {Customer.class}, properties);
        marshal(jc1, customer);

        // Output #2
        properties.put(JAXBContextProperties.OXM_METADATA_SOURCE, "forum10761762/alternate1.xml");
        JAXBContext jc2 = JAXBContext.newInstance(new Class[] {Customer.class}, properties);
        marshal (jc2, customer);

        // Output #2
        properties.put(JAXBContextProperties.OXM_METADATA_SOURCE, "forum10761762/alternate2.xml");
        JAXBContext jc3 = JAXBContext.newInstance(new Class[] {Customer.class}, properties);
        marshal(jc3, customer);
    }

    private static void marshal(JAXBContext jc, Object object) throws Exception {
        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(object, System.out);
        System.out.println();
    }

}

выход

Ниже приведен вывод из запуска демо-кода. Примечание из той же объектной модели было выпущено 3 разных документов JSON.

{
   "id" : 123,
   "first-name" : "Jane",
   "last-name" : "Doe"
}
{
   "last-name" : "Doe"
}
{
   "id" : 123,
   "personalInfo" : {
      "firstName" : "Jane",
      "lastName" : "Doe"
   }
}

для получения дополнительной информации (из моего блога)

4