Question

我称之为Web服务，可以定期在合同中添加一些元素。

示例：SOAP响应正文包含：

<picture>
   <active>true</active>
   <code>172</code>
   <label>Nikon D3200 Black</label>
   <downloadEnabled>true</downloadEnabled>
</picture>
<picture>
   <active>false</active>
   <code>177</code>
   <label>Nikon D5200 Red</label>
   <downloadEnabled>true</downloadEnabled>
   <extraField>none</extraField>
</picture>

我的CXF生成的JAXB Bean如下所示：

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "pictureListJAXB", propOrder = {
    "active",
    "code",
    "label",
    "downloadEnabled",
    "extraField"
})
public class PictureListJAXB {

    protected boolean active;
    protected String code;
    protected String label;
    protected boolean downloadEnabled;
    @XmlElement(nillable = true)
    protected String extraField

    // And Getters / Setters comes here after      

}

使用maven插件cxf-codegen-plugin版本2.6.2（来自apache.cxf）生成JAXB bean。

现在我想知道是否有一个解决方案可以让我的Bean容错，以防SOAP响应中出现新元素：

<picture>
    <active>true</active>
    <code>172</code>
    <label>Nikon D3200 Black</label>
    <downloadEnabled>true</downloadEnabled>
    <newUnmappedElement>anything irrelevant</newUnmappedElement>
</picture>

现在，当我收到这样的回复时，我得到了Unmarshalling Error因为这个新元素。

我的JAXB包含我想要管理的最小字段，但我希望bean能够处理新元素并忽略它们。

有没有办法在不重新生成JAXB Bean的情况下执行此操作？（现在我必须重新生成Beans并发布我的项目）

我检查了CXF选项（和xjc）并且在doc（和google）中找不到任何内容。解组操作在CXF也生成的ReferentialService中自动完成，然后修改此部分生成的选项就足够了。

以下是使用CXF生成的类调用Web服务的代码：

public ReferentialService getReferentialService(String resource, String auth) throws RuntimeException {

    // These two classes are generated by CXF
    Referential referential;
    ReferentialService referentialService;


    // Get the resource URL in form http://myserver:port/remote-backend/resource?wsdl
    referential = new Referential(new URL(MyConfigUtil.getWSDL(resource)));

    referentialService = referential.getReferentialServicePort();
    BindingProvider bp = (BindingProvider) referentialService;

    // Get the endpoint URL in form http://myserver:port/remote-backend/resource
    bp.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, MyConfigUtil.getWebServiceEndPoint(resource));

    // Add SOAP credentials
    String username = HttpBasicAuthHelper.getUsername(auth);
    String password = HttpBasicAuthHelper.getPassword(auth);

    bp.getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username);
    bp.getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);

    return referentialService;
}

和电话：

// Throws Exception just for the sample code
public InputStream listPictures(QueryDTO request, String resource, String auth) throws Exception {

    InputStream is = null;
    if (request != null) {

        // This is the WS Call which failed with unmarshal error
        List<PictureListJAXB> result = getReferentialService(resource, auth).getPictures(request);

        // Some code to convert JAXB into a  XML stream
        is = convertObjectToXmlStream(result);
    }
    return is;
}

更新：我看到this post，我的感觉是一样的：如果单独使用没有CXF，JAXB将忽略未映射的元素。通过使用cxf-codegen-plugin，情况并非如此。

Answer 1

解决此问题的一种方法是使用Jaxb注释@XmlAnyElement（lax = true）。这意味着对于该字段，如果元素通过@XmlRootElement或@XmlElementDecl与类关联，则相应类的实例将用于填充字段，如果不是该元素将被设置为org.w3c.dom.Element.A示例代码的实例

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Root {
    ..
    ....
    @XmlAnyElement(lax = true)
    protected List<Object> any;

输入中与该类的显式属性不对应的任何元素将被清除到此列表中。更多enter link description here

Answer 2

我终于通过查看this another post找到了答案，但由于我没有像帖子中那样使用声明方式，因此我猜到我应该能够在绑定提供程序上添加一些属性。

我对代码的修改是在BindingProvider方法中getReferentialService添加这些属性：

bp.getRequestContext().put("schema-validation-enabled", "true");
bp.getRequestContext().put("jaxb-validation-event-handler", new ValidatorHandler());

对于测试，我刚刚创建了一个内部类ValidatorHandler：

private class ValidatorHandler extends DefaultValidationEventHandler {
    @Override
    public boolean handleEvent(ValidationEvent event) {
        if (event.getSeverity() == ValidationEvent.WARNING) {
            return super.handleEvent(event);
        } else if (event.getSeverity() == ValidationEvent.ERROR
                && event.getMessage().startsWith("unexpected element")) {
            return true;
        } else {
            throw new RuntimeException(event.getMessage()
                    + " [line:" + event.getLocator().getLineNumber() + "]");
        }
    }
}

通过这样做，我不需要修改生成的bean（JAX-B）并在默认情况下生成它们时使用它们。

Answer 3

您的回答对我的研究很有帮助。谢谢。在SOAP响应中，我同样遇到未知元素的问题

ValidationEvent.FATAL_ERROR“ cvc-complex-type.2.4.a：无效的内容”

我能够添加以下内容

bp.getRequestContext().put("set-jaxb-validation-event-handler", false);

这将关闭刚刚的JAXB验证，并引用Danial Kulp CXF提交者的话：“在大多数情况下，这就是诸如未知元素或错误名称空间中的元素之类的事情。”

如何使CXF生成的代码解组到JAX-B并忽略未映射的字段？

3 个答案: