2013-06-28 34 views
10

空の要素としてnull値をjaxbに表示する必要があります。私はjaxbのMoxy実装を使用しています。 私は、このオプションnull値をxmlの空の要素として表しますjaxb

@XmlNullPolicy(emptyNodeRepresentsNull = true, nullRepresentationForXml = XmlMarshalNullRepresentation.EMPTY_NODE) 

私は強くノードの不在またはいずれかでnullを表す推薦

答えて

16

(その中で定義されたすべての要素のための)クラスレベルで適用することができます任意の同様の拡張はありますを発見しましたxsi:nil="true"属性を使用します。これは、スキーマ検証で最適に動作(すなわち<age/>または<age></age>はタイプxsd:intの有効な要素ではありませんあなたがここにあなたがあなたのユースケースを実現することができる方法であることはできませんしかし、場合:

使用

標準JAXB挙動

。あなたはnullが不在のノードとして、あるいは@XmlElement注釈(参照:http://blog.bdoughan.com/2012/04/binding-to-json-xml-handling-null.html)とxsi:nil="true"で表現されているかどうかを制御することができ、標準的なAPI以下

import javax.xml.bind.annotation.*; 

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

    private String street; 

    @XmlElement(nillable=true) 
    private String city; 

} 

はXMLですoutpu両方のフィールドの値がNULLの場合はtです。

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

MOXY - クラスごとにこの動作をオーバーライド

MOXYは、クラスのすべてのプロパティにnullポリシーを指定するためのアノテーションを提供していません。しかし、@XmlCustomizerアノテーションを使用してDescriptorCustomizerを活用し、ネイティブ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); 
      } 
     } 
    } 

} 

ドメインモデル(アドレス)

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を使用することをお勧めしますマッピングされたすべてのクラスに対してnull処理をオーバーライドしたい場合は代わりに。必要に応じて、この方法を使用して単一のクラスのメタデータを更新することもできます。

の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> 
0

「悪い習慣」の回避策は、クラスで唯一の文字列フィールドを持っている場合は、このような要素のためのセッターをオーバーライドすることである。

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が十分です。

@Blise Doughanの答えは、あなたがそれに対処することができれば、長期的にはるかに良いようです。 :)

関連する問題