Представить нулевое значение как пустой элемент в xml jaxb

Ответ 1

Я бы настоятельно рекомендовал представить null либо с отсутствием node, либо с атрибутом xsi:nil="true". Это лучше всего работает с проверкой схемы (т.е. <age/> или <age></age> не является допустимым элементом типа xsd:int. Однако, если вы не можете здесь, как вы можете выполнить свой прецедент:

СТАНДАРТНОЕ ПОВЕДЕНИЕ JAXB

Используя стандартные API-интерфейсы, вы можете контролировать, будет ли null представлен как отсутствующий node или с xsi:nil="true" с аннотацией @XmlElement (см. http://blog.bdoughan.com/2012/04/binding-to-json-xml-handling-null.html).

import javax.xml.bind.annotation.*;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Address {

    private String street;

    @XmlElement(nillable=true)
    private String city;

}

Ниже представлен вывод XML, если значения обоих полей равны нулю.

<?xml version="1.0" encoding="UTF-8"?>
<address>
   <city xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
</address>

MOXY - ПРЕВЫШАЕТ ЭТОТ ПОВЕДЕНИЕ К КЛАССУ

MOXy не предоставляет аннотацию для указания нулевой политики для всех свойств класса. Однако вы можете использовать DescriptorCustomizer через аннотацию @XmlCustomizer и настроить метаданные собственного MOXy, чтобы выполнить одно и то же.

DescriptorCustomizer (AddressCustomizer)

import org.eclipse.persistence.config.DescriptorCustomizer;
import org.eclipse.persistence.descriptors.ClassDescriptor;
import org.eclipse.persistence.mappings.DatabaseMapping;
import org.eclipse.persistence.oxm.mappings.XMLDirectMapping;
import org.eclipse.persistence.oxm.mappings.nullpolicy.XMLNullRepresentationType;

public class AddressCustomizer implements DescriptorCustomizer {

    @Override
    public void customize(ClassDescriptor descriptor) throws Exception {
        for(DatabaseMapping mapping : descriptor.getMappings()) {
            if(mapping.isAbstractDirectMapping()) {
                XMLDirectMapping xmlDirectMapping = (XMLDirectMapping) mapping;
                xmlDirectMapping.getNullPolicy().setMarshalNullRepresentation(XMLNullRepresentationType.EMPTY_NODE);
                xmlDirectMapping.getNullPolicy().setNullRepresentedByEmptyNode(true);
            }
        }
    }

}

DomainModel (адрес)

import javax.xml.bind.annotation.*;
import org.eclipse.persistence.oxm.annotations.XmlCustomizer;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@XmlCustomizer(AddressCustomizer.class)
public class Address {

    private String street;

    @XmlElement(nillable=true)
    private String city;

}

Выход

<?xml version="1.0" encoding="UTF-8"?>
<address>
   <street/>
   <city/>
</address>

MOXy - ПРЕВЫШАЕТ ЭТОТ ПОВЕДЕНИЕ ДЛЯ ВСЕХ КЛАССОВ

Если вместо этого вы хотите переопределить нулевую обработку для всех сопоставленных классов, я бы рекомендовал вместо этого использовать SessionEventListener. Если вы предпочитаете, вы также можете использовать этот подход для обновления метаданных для одного класса.

SessionEventListener (NullPolicySessionEventListener)

import org.eclipse.persistence.descriptors.ClassDescriptor;
import org.eclipse.persistence.mappings.DatabaseMapping;
import org.eclipse.persistence.oxm.mappings.XMLDirectMapping;
import org.eclipse.persistence.oxm.mappings.nullpolicy.XMLNullRepresentationType;
import org.eclipse.persistence.sessions.*;

public class NullPolicySessionEventListener extends SessionEventAdapter {

    @Override
    public void preLogin(SessionEvent event) {
        Project project = event.getSession().getProject();
        for(ClassDescriptor descriptor : project.getOrderedDescriptors()) {
            for(DatabaseMapping mapping : descriptor.getMappings()) {
                if(mapping.isAbstractDirectMapping()) {
                    XMLDirectMapping xmlDirectMapping = (XMLDirectMapping) mapping;
                    xmlDirectMapping.getNullPolicy().setMarshalNullRepresentation(XMLNullRepresentationType.EMPTY_NODE);
                    xmlDirectMapping.getNullPolicy().setNullRepresentedByEmptyNode(true);
                }
            }
        }
     }

}

Демо-код

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

public class Demo {

    public static void main(String[] args) throws Exception {
        Map<String, Object> properties = new HashMap<String, Object>(1);
        SessionEventListener sessionEventListener = new NullPolicySessionEventListener();
        properties.put(JAXBContextProperties.SESSION_EVENT_LISTENER, sessionEventListener);
        JAXBContext jc = JAXBContext.newInstance(new Class[] {Address.class}, properties);

        Address address = new Address();

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(address, System.out);
    }

}

Выход

<?xml version="1.0" encoding="UTF-8"?>
<address>
   <street/>
   <city/>
</address>

Ответ 2

Обходной путь "плохой практики", если у вас есть только поля String в классе, должен переопределить установщик для этого элемента следующим образом:

public class Address {

  private String street;

  @XmlElement(name = "street")
  public void setStreet(String street){
    this.street = street;
    if (this.street == null){
      this.street = ""; // Not NULL, empty string like new String()!
    }
  }
}

Это не работает с другими типами, такими как дата или номер! Но иногда String достаточно.

@Blaise Doughan ответ кажется намного лучше в долгосрочной перспективе, если вы можете справиться с ним.:)