【问题标题】:Jaxb marshalling with custom annotations带有自定义注释的 Jaxb 编组
【发布时间】:2013-10-21 17:54:59
【问题描述】:

我有一个要求,根据字段上标记的自定义注释来编组/解组 java pojo 的某些元素。 假设我的 java pojp 中有 3 个字段

@CustomVersion("v1")
private String field1;
@CustomVersion("v1","v2")
private String field2;
@CustomVersion("v2")
private String field3;

如果我在 jaxb 中转换时传递 version="v1" 参数,我只想编组带有 v1 的字段。如果我通过 v2,则所有带有 v2 注释的字段都应该被编组。

这甚至可以使用 jaxb 吗?我确信通过某些库或方式会支持选择性编组,但经过相当多的搜索后仍然无法弄清楚。 非常感谢任何帮助、建议或指示。

【问题讨论】:

    标签: java xml jaxb


    【解决方案1】:

    注意:我是EclipseLink JAXB (MOXy) 领导,也是JAXB (JSR-222) 专家组的成员。

    以下是如何使用 MOXy 的 @XmlNamedObjectGraphs 扩展来映射您的用例的示例。

    Java 模型

    Foo

    @XmlNamedObjectGraphs 扩展允许您指定由一个键标识的多个映射子集。

    import javax.xml.bind.annotation.XmlAccessType;
    import javax.xml.bind.annotation.XmlAccessorType;
    import javax.xml.bind.annotation.XmlRootElement;
    
    import org.eclipse.persistence.oxm.annotations.XmlNamedAttributeNode;
    import org.eclipse.persistence.oxm.annotations.XmlNamedObjectGraph;
    import org.eclipse.persistence.oxm.annotations.XmlNamedObjectGraphs;
    
    @XmlRootElement
    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlNamedObjectGraphs({
        @XmlNamedObjectGraph(
            name="v1",
            attributeNodes = { 
                @XmlNamedAttributeNode("field1"),
                @XmlNamedAttributeNode("field2")}),
        @XmlNamedObjectGraph(
            name="v2",
            attributeNodes = { 
                @XmlNamedAttributeNode("field2"),
                @XmlNamedAttributeNode("field3")})
    })
    public class Foo {
    
        private String field1 = "ONE";
        private String field2 = "TWO";
        private String field3 = "THREE";
    
    }
    

    jaxb.properties

    要将 MOXy 用作您的 JAXB 提供程序,您需要包含一个名为 jaxb.properties 的文件,其中包含以下条目(请参阅:http://blog.bdoughan.com/2011/05/specifying-eclipselink-moxy-as-your.html)。

    javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory
    

    演示代码

    演示

    您可以指定与对象图对应的键,以将该子集应用于您正在编组的对象。

    import javax.xml.bind.JAXBContext;
    import javax.xml.bind.Marshaller;
    import org.eclipse.persistence.jaxb.MarshallerProperties;
    
    public class Demo {
    
        public static void main(String[] args) throws Exception {
            JAXBContext jc = JAXBContext.newInstance(Foo.class);
    
            Marshaller marshaller = jc.createMarshaller();
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
    
            Foo foo = new Foo();
    
            // Marshal Everything
            marshaller.marshal(foo, System.out);
    
            // Marshal "v1" Data
            marshaller.setProperty(MarshallerProperties.OBJECT_GRAPH, "v1");
            marshaller.marshal(foo, System.out);
    
            // Marshal "v2" Data
            marshaller.setProperty(MarshallerProperties.OBJECT_GRAPH, "v2");
            marshaller.marshal(foo, System.out);
        }
    
    }
    

    输出

    <?xml version="1.0" encoding="UTF-8"?>
    <foo>
       <field1>ONE</field1>
       <field2>TWO</field2>
       <field3>THREE</field3>
    </foo>
    <?xml version="1.0" encoding="UTF-8"?>
    <foo>
       <field1>ONE</field1>
       <field2>TWO</field2>
    </foo>
    <?xml version="1.0" encoding="UTF-8"?>
    <foo>
       <field2>TWO</field2>
       <field3>THREE</field3>
    </foo>
    

    更多信息

    【讨论】:

    • 它几乎是我正在寻找的那种答案,但是如果您注意到我必须在 @XmlNamedAttributeNode 注释中指定字段名称,这可能会使用反射来识别字段。现在,如果我有一个类似 50 个字段的类,则几乎不可能维护各个版本的字段名称列表,并且字段名称的重构也不起作用。有没有办法我可以在字段上指定一些自定义版本注释并让 jaxb 使用输入版本参数找出要编组的内容?
    【解决方案2】:

    首先,我建议在编组之前进行此类预处理。这会容易得多。但是,如果由于某种原因不可能,那么您可以创建自定义类型适配器。然后,您可以将@XmlJavaTypeAdapter(VersioningAdapter.class) 放在您希望启用版本控制的每种类型上。 @XmlJavaTypeAdapter 也可以在包级别指定,但您必须指定它适用于哪些类型。如果不指定某处 @XmlJavaTypeAdapter,则不能使用 XmlAdapter。

    这种解决方案的缺点:

    • 如果您有多个版本化类型,那么每个类型都必须使用@XmlJavaTypeAdapter 进行注释
    • @XmlJavaTypeAdapter 不适用于根元素,仅适用于子元素。在编组之前,您必须在根元素上手动调用适配器

    AFAIK 没有其他选项可用于自定义 JAXB 编组。这就是为什么我认为注释处理应该在编组之前在单独的步骤中执行。除非你能接受提到的限制。

    示例适配器(完整代码可在here找到):

    public class VersioningAdapter extends XmlAdapter<Object, Object> {
    
        @Override
        public Object unmarshal(Object v) throws Exception {
            // TODO Auto-generated method stub
            return null;
        }
    
        @Override
        public Object marshal(Object v) throws Exception {
            if (v == null) {
                return v;
            }
            Field[] fields = v.getClass().getDeclaredFields();
            for (Field field : fields) {
                Annotation[] annotations = field.getDeclaredAnnotations();
                CustomVersion annotation = findCustomVersion(annotations);
                if (annotation != null) {
                    if (!contains(annotation, Configuration.getVersion())) {
                        field.setAccessible(true);
                        field.set(v, null);
                    }
                }
            }
            return v;
        }
    
        private CustomVersion findCustomVersion(Annotation[] annotations) {
            for (Annotation annotation : annotations) {
                if (annotation instanceof CustomVersion) {
                    return (CustomVersion) annotation;
                }
            }
            return null;
        }
    
        private boolean contains(CustomVersion annotation, String version) {
            String[] values = annotation.value();
            for (String value : values) {
                if (value.equals(version)) {
                    return true;
                }
            }
            return false;
        }
    
    }
    

    【讨论】:

    • 嗨。感谢您的回答,但是您能否澄清您所说的意思-“注释处理应在编组之前在单独的步骤中执行”!我愿意接受建议,并且仍在寻找正确的方法。
    • @AshishThukral - 如果我是你,我会编写一个使用反射的实用程序类(就像我写的适配器)来取消与版本不匹配的属性。应在将对象编组为 XML 之前调用此类。如果您使用 Marshaller 编组它们,那么这很容易。如果您使用 JAX-WS,您可以使用逻辑处理程序在输出被编组之前对其进行修改。实用程序类不必了解有关 JAXB 的任何信息。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2010-10-03
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2011-11-05
    • 1970-01-01
    • 2015-01-02
    相关资源
    最近更新 更多