JAXB XML Adapters通过注释工作,但不通过setAdapter工作

时间:2011-05-24 12:55:38

标签: java xml jaxb marshalling

我完全了解如何使用XMLAdaptersconvert unmappable types,或者仅仅更改某些对象序列化/反序列化为XML的方式。如果我使用注释(包级别或其他),一切都很好。问题是我试图改变第三方对象的表示,我无法将源代码更改为(即为了注入注释)。

考虑到Marshaller对象有一个manually adding adapters的方法,这应该不是问题。不幸的是,无论我做什么,我都无法通过这种方式设置适配器来“启动”。例如,我有一个表示XYZ空间中的点(地心坐标)的类。在我生成的XML中,我希望将其转换为lat / long / altitude(大地坐标)。这是我的课程:

地心

package testJaxb;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class GeocentricCoordinate {
    // Units are in meters; see http://en.wikipedia.org/wiki/Geocentric_coordinates
    private double x;
    private double y;
    private double z;

    @XmlAttribute
    public double getX() {
        return x;
    }
    public void setX(double x) {
        this.x = x;
    }
    @XmlAttribute
    public double getY() {
        return y;
    }
    public void setY(double y) {
        this.y = y;
    }
    @XmlAttribute
    public double getZ() {
        return z;
    }
    public void setZ(double z) {
        this.z = z;
    }
}

大地测量

package testJaxb;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
/**
 * @see http://en.wikipedia.org/wiki/Geodetic_system
 */
@XmlRootElement
public class GeodeticCoordinate {

    private double latitude;
    private double longitude;
    // Meters
    private double altitude;

    public GeodeticCoordinate() {
        this(0,0,0);
    }

    public GeodeticCoordinate(double latitude, double longitude, double altitude) {
        super();
        this.latitude = latitude;
        this.longitude = longitude;
        this.altitude = altitude;
    }

    @XmlAttribute
    public double getLatitude() {
        return latitude;
    }
    public void setLatitude(double latitude) {
        this.latitude = latitude;
    }

    @XmlAttribute
    public double getLongitude() {
        return longitude;
    }

    public void setLongitude(double longitude) {
        this.longitude = longitude;
    }

    @XmlAttribute
    public double getAltitude() {
        return altitude;
    }
    public void setAltitude(double altitude) {
        this.altitude = altitude;
    }



}

GeocentricToGeodeticLocationAdapter

package testJaxb;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.annotation.adapters.XmlAdapter;


/**
 * One of our systems uses xyz coordinates to represent locations. Consumers of our XML would much
 * prefer lat/lon/altitude.  This handles converting between xyz and lat lon alt.  
 * 
 * @author ndunn
 *
 */
public class GeocentricToGeodeticLocationAdapter extends XmlAdapter<GeodeticCoordinate,GeocentricCoordinate> {

    @Override
    public GeodeticCoordinate marshal(GeocentricCoordinate arg0) throws Exception {
        // TODO: do a real coordinate transformation
        GeodeticCoordinate coordinate = new GeodeticCoordinate();
        coordinate.setLatitude(45);
        coordinate.setLongitude(45);
        coordinate.setAltitude(1000);
        return coordinate;
    }

    @Override
    public GeocentricCoordinate unmarshal(GeodeticCoordinate arg0) throws Exception {
        // TODO do a real coordinate transformation
        GeocentricCoordinate gcc = new GeocentricCoordinate();
        gcc.setX(100);
        gcc.setY(200);
        gcc.setZ(300);
        return gcc;
    }
}

ObjectWithLocation字段

package testJaxb; 
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class ObjectWithLocation {

    private GeocentricCoordinate location = new GeocentricCoordinate();

    public GeocentricCoordinate getLocation() {
        return location;
    }

    public void setLocation(GeocentricCoordinate location) {
        this.location = location;
    }


    public static void main(String[] args) {

        ObjectWithLocation object = new ObjectWithLocation();

        try {
            JAXBContext context = JAXBContext.newInstance(ObjectWithLocation.class, GeodeticCoordinate.class, GeocentricCoordinate.class);
            Marshaller marshaller = context.createMarshaller();

            marshaller.setAdapter(new GeocentricToGeodeticLocationAdapter());
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

            marshaller.marshal(object, System.out);

        }
        catch (JAXBException jaxb) {
            jaxb.printStackTrace();
        }
    }
}

输出:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectWithLocation>
    <location z="0.0" y="0.0" x="0.0"/>
</objectWithLocation>

使用注释(在我的package-info.java文件中):

@javax.xml.bind.annotation.adapters.XmlJavaTypeAdapters
({
@javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter(value=GeocentricToGeodeticLocationAdapter.class,type=GeocentricCoordinate.class),
})

package package testJaxb;

我得到以下(所需)xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectWithLocation>
    <location longitude="45.0" latitude="45.0" altitude="1000.0"/>
</objectWithLocation>

所以我的问题是双重的。

  1. 为什么适配器在注释时有效,但在通过setAdapter方法明确设置时却无效?
  2. 如果我有无法注释的类,并且我无法修改其package-info.java以添加注释,我该如何解决此问题?

2 个答案:

答案 0 :(得分:9)

setAdapter(XmlAdapter)上的Marshaller用于为已使用@XmlJavaTypeAdapter注释的属性传入初始化的XmlAdapter。以下链接是我利用此行为的答案:

如果要映射第三方类,可以使用EclipseLink JAXB (MOXy)的XML映射文件(我是MOXy主管):

答案 1 :(得分:2)

您始终需要使用@XmlJavaTypeAdapter(...).

进行注释

marshaller.setAdapter(...)是指在您进行非默认构造函数初始化的情况下为类型适配器分配自定义初始化实例的方法。

否则,如果您的适配器只有一个默认构造函数,那么您不需要显式调用.setAdapter(...)方法。

这是一个很好的答案,有更详细的解释: JAXB: Isn't it possible to use an XmlAdapter without @XmlJavaTypeAdapter?

JAXB Runtime只能接受带有No-args构造函数的Adapter ..(显然JAXBContext不知道特定于应用程序的模型)

谢天谢地,有一个选项:D

您可以告诉您的unmarshaller使用给定的UserAdapter实例,而不是通过自己的实例来实现它。

public class Test {
public static void main(String... args) { 
    JAXBContext context = JAXBContext.getInstance(Event.class);
    Unmarshaller unmarshaller = context.createUnmarshaller();

      UserContext userContext = null; // fetch it from some where
      unmarshaller.setAdapter(UserAdapter.class, new UserAdapter(userContext));

      Event event = (Event) unmarshaller.unmarshal(..);
   }
}
Marshaller&amp; amp;和/或解组

注意: 关于marshaller / unmarshaller的setAdapter并不意味着你不必使用setAdapter