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


我了解如何使用 XMLAdapters 至 转换不可映射的类型或者只是改变某些对象被序列化/反序列化为XML的方式。如果我使用注释(包级别或其他),一切都很好。问题是我试图改变第三方对象的表示,我无法将源代码更改为(即为了注入注释)。

考虑到Marshaller对象有一个方法,那应该不是问题 手动添加适配器。不幸的是,无论我做什么,我都无法通过这种方式设置适配器来“启动”。例如,我有一个表示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以添加注释时,如何解决此问题?

7827
2018-05-24 12:55


起源



答案:


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

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


9
2018-05-24 14:36



呃,好吧。那很烦人。我现在看到我没有充分阅读addAdapter的合同。有没有理由不揭露 void <E,F> addAdapter(Class<E> classToAdapt, XMLAdapter<F,E>) 方法? - I82Much
@ I82Much - 可以增强JAXB以提供该行为。它目前不支持这一点的原因主要是由于性能。 JAXBContext可以在创建时初始化其元数据,并为每个maullhal / unmarshal操作使用相同的元数据。如果允许在Marshaller / Unmarshaller级别引入适配器,则JAXB impl需要考虑此类元数据更改的可能性。 - Blaise Doughan
好的非常合理的回应。我很生气,因为在XStream中进行这种自定义非常容易,而且我发现有很多障碍可以通过JAXB来实现。我会检查MOXy。谢谢您的帮助。 - I82Much


答案:


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

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


9
2018-05-24 14:36



呃,好吧。那很烦人。我现在看到我没有充分阅读addAdapter的合同。有没有理由不揭露 void <E,F> addAdapter(Class<E> classToAdapt, XMLAdapter<F,E>) 方法? - I82Much
@ I82Much - 可以增强JAXB以提供该行为。它目前不支持这一点的原因主要是由于性能。 JAXBContext可以在创建时初始化其元数据,并为每个maullhal / unmarshal操作使用相同的元数据。如果允许在Marshaller / Unmarshaller级别引入适配器,则JAXB impl需要考虑此类元数据更改的可能性。 - Blaise Doughan
好的非常合理的回应。我很生气,因为在XStream中进行这种自定义非常容易,而且我发现有很多障碍可以通过JAXB来实现。我会检查MOXy。谢谢您的帮助。 - I82Much


你总是需要注释 @XmlJavaTypeAdapter(...).

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

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

这是一个很好的答案,更详细的解释: JAXB:如果没有@XmlJavaTypeAdapter,是不是可以使用XmlAdapter?

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(..);
   }
}

setAdapter Marshaller和Unmarshaller都提供了方法

注意: marshaller / unmarshaller上的setAdapter并不意味着你不必使用 @XmlJavaTypeAdapter


2
2018-04-15 18:04