当Jaxb遇到泛型

时间 2019-11-11

标签 jaxb 遇到繁體版

原文原文链接

前言:
　　最近的工做内容跟银行有些交互, 对方提供的数据格式采用xml(不是预期的json/protobuf). 为了开发方便, 须要借助jaxb来实现xml和java对象之间的映射. 它仍是有点像jackson, 经过简单的注解配置, 就能轻松实现json和java对象的互转. 不过笔者在java类中引入泛型时, 仍是踩了很多jaxb的坑, 这边作下笔记.java

实现的目标:
　　交互的数据格式和协议遵循通用的设计, 由header和body构成.
　　请求的数据格式以下:json

<?xml version="1.0" encoding="UTF-8" ?>
<root>
	<!-- 请求头 -->
	<header></header>
	<request>
		<!-- 具体的请求参数, 根据接口而定 -->
	</request>
</root>

　　响应的数据格式以下:app

<?xml version="1.0" encoding="UTF-8" ?>
<root>
	<!-- 响应头 -->
	<header></header>
	<response>
		<!-- 具体的响应结果, 根据接口而定 -->
	</response>
</root>

　　header信息头相对固定, 而具体的request/response取决于具体的业务接口, 在进行对象映射中, 咱们也是针对body消息体进行泛型化.测试

请求类抽象和测试代码:
　　针对请求的数据格式, 咱们能够轻易的设计以下类结构:ui

// *) 请求类(模板)
@Getter
@Setter
@ToString
public class Req<T> {
    private String header;
    private T value;
}

// *) 具体的实体请求
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class EchoBody {
    private String key;
}

　　注: 这边的注解Getter/Setter/ToString等皆是lombok的注解.
　　测试代码以下:spa

    public static void main(String[] args) {

        Req<EchoBody> req = new Req<EchoBody>();
        req.setHeader("header");
        req.setValue(new EchoBody("key"));

        try {
            StringWriter sw = new StringWriter();
            JAXBContext context = JAXBContext.newInstance(req.getClass());
            Marshaller marshaller = context.createMarshaller();
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            marshaller.marshal(req, sw);
            System.out.println(sw.toString());
        } catch (JAXBException e) {
            e.printStackTrace();
        }

    }

　　注: 该代码主要测试对象到xml的转换是否顺利.设计

演进和迭代:
　　先来看初版本, 引入jaxb注解, 同时省略lombok注解.xml

    @XmlRootElement(name="root")
    @XmlAccessorType(XmlAccessType.FIELD)
    public class Req<T> {
        @XmlElement(name="header",required = true)
        private String header;
        @XmlElement(name="request", required = true)
        private T value;
    }

    @XmlRootElement(name="request")
    @XmlAccessorType(XmlAccessType.FIELD)
    public class EchoBody {
        @XmlElement(name="key", required = true)
        private String key;
    }

　　运行测试的结果以下:对象

javax.xml.bind.MarshalException
 - with linked exception:
[com.sun.istack.internal.SAXException2: class com.test.Test$EchoBody以及其任何超类对此上下文都是未知的。
javax.xml.bind.JAXBException: class com.test.Test$EchoBody以及其任何超类对此上下文都是未知的。]
    at com.sun.xml.internal.bind.v2.runtime.MarshallerImpl.write(MarshallerImpl.java:311)
    at com.sun.xml.internal.bind.v2.runtime.MarshallerImpl.marshal(MarshallerImpl.java:236)
    at javax.xml.bind.helpers.AbstractMarshallerImpl.marshal(AbstractMarshallerImpl.java:116)
    at com.test.Test.main(Test.java:55)

　　来首战遇到一些小挫折, 经过百度得知须要借助@XmlSeeAlso类规避该问题.
　　修改代码以下:blog

    @XmlRootElement(name="root")
    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlSeeAlso({EchoBody.class})
    public class Req<T> {
        @XmlElement(name="header",required = true)
        private String header;
        @XmlElement(name="request", required = true)
        private T value;
    }

    @XmlRootElement(name="request")
    @XmlAccessorType(XmlAccessType.FIELD)
    public class EchoBody {
        @XmlElement(name="key", required = true)
        private String key;
    }

　　运行后的输出结果以下:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
    <header>header</header>
    <request xsi:type="echoBody" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <key>key</key>
    </request>
</root>

　　看来很是的成功, 可是request标签里包含了xsi:type和xmlns:xsi这些属性, 可否把这些信息去除, 网上查阅得知, 借助@XmlAnyElement(lax = true)来达到目的, 再次修改版本.

    @XmlRootElement(name="root")
    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlSeeAlso({EchoBody.class})
    public class Req<T> {
        @XmlElement(name="header",required = true)
        private String header;
        @XmlAnyElement(lax = true)
        private T value;
    }

    @XmlRootElement(name="request")
    @XmlAccessorType(XmlAccessType.FIELD)
    public class EchoBody {
        @XmlElement(name="key", required = true)
        private String key;
    }

　　此次的结果能够称得上完美(perfect):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
    <header>header</header>
    <request>
        <key>key</key>
    </request>
</root>

响应类抽象和测试代码:
　　有了请求类的顺利结果, 咱们在设计响应类也是有迹可循.
　　响应类的代码以下:

@Getter
@Setter
@ToString
public class Res<T> {
    private String header;
    private T value;
}

@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class EchoAck {
    private String value;
}


@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class HelloAck {
    private String key;
}

　　注: 这边暂时隐去jaxb的注解, 剩下的都是lombok注解.
　　测试用例代码以下:

public static void main(String[] args) {

    String xml = "" +
            "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n" +
            "<root>\n" +
            "\t<header>header_val</header>\n" +
            "\t<response>\n" +
            "\t\t<key>key_val</key>\n" +
            "\t</response>\n" +
            "</root>";
    Res<HelloAck> res = new Res<HelloAck>();

    try {
        JAXBContext jc = JAXBContext.newInstance(res.getClass());
        Unmarshaller unmar = jc.createUnmarshaller();
        Res<HelloAck> r =  (Res<HelloAck>)unmar.unmarshal(new StringReader(xml));
        System.out.println(r);
    } catch (JAXBException e) {
        e.printStackTrace();
    }

}

演进和迭代:
　　添加jaxb注解, 隐去lombok注解, 大体以下:

@XmlRootElement(name="root")
@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso({HelloAck.class, EchoAck.class})
public class Res<T> {
    @XmlElement(name="header",required = true)
    private String header;
    @XmlAnyElement(lax = true)
    private T value;
}

@XmlRootElement(name="response")
@XmlAccessorType(XmlAccessType.FIELD)
public class EchoAck {
    @XmlElement(name="value", required = true)
    private String value;
}

@XmlRootElement(name="response")
@XmlAccessorType(XmlAccessType.FIELD)
public class HelloAck {
    @XmlElement(name="key", required = true)
    private String key;
}

　　运行的以下:

Res(header=header_val, value=EchoAck(value=null))

　　这边须要的注意的是, 代码中指定反解的类是HelloAck, 可是这边反解的类倒是EchoAck. 因而可知, jaxb在xml到对象转换时, 其泛型类的选取存在问题(猜想java泛型在编译时类型被擦去, 反射不能肯定具体那个类).
　　针对这种状况, 一个好的建议是, 单独引入实体类(wrapper), 网友的作法也是相似, 只是没有给出直接的理由.

@Getter
@Setter
@ToString
@XmlTransient	// 抽象基类改成注解XmlTransient, 切记
@XmlAccessorType(XmlAccessType.FIELD)
public abstract class Res<T> {
    @XmlElement(name="header",required = true)
    private String header;
    @XmlAnyElement(lax = true)
    private T value;
}

@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
@XmlRootElement(name="response")
@XmlAccessorType(XmlAccessType.FIELD)
public class EchoAck {
    @XmlElement(name="value", required = true)
    private String value;
}


@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
@XmlRootElement(name="response")
@XmlAccessorType(XmlAccessType.FIELD)
public class HelloAck {
    @XmlElement(name="key", required = true)
    private String key;
}

@Getter
@Setter
@ToString(callSuper = true)
@XmlRootElement(name="root")
@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso({HelloAck.class})
public class HelloRes extends Res<HelloAck> {
}

　　修改测试代码:

public static void main(String[] args) {

    String xml = "" +
            "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n" +
            "<root>\n" +
            "\t<header>header_val</header>\n" +
            "\t<response>\n" +
            "\t\t<key>key_val</key>\n" +
            "\t</response>\n" +
            "</root>";
    HelloRes res = new HelloRes();

    try {
        JAXBContext jc = JAXBContext.newInstance(HelloRes.class);
        Unmarshaller unmar = jc.createUnmarshaller();
        HelloRes r =  (HelloRes)unmar.unmarshal(new StringReader(xml));
        System.out.println(r);
    } catch (JAXBException e) {
        e.printStackTrace();
    }

}

　　运行结果以下:

HelloRes(super=Res(header=header_val, value=HelloAck(key=key_val)))

　　符合预期, 这边的作法就是wrap一个泛型类, 姑且能够理解为在编译前指定类, 避免反射出误差.

总结: 　　总的来讲jaxb在涉及泛型时, 仍是有一些坑的, 这边总结了一下. 不过总的来讲, 知其然不知其因此然, 希翼后面可以对jaxb的底层实现有个深刻的了解.