使用CXF Webservice进行服务器端XML验证 [英] Server-Side XML Validation with CXF Webservice

问题描述

我正在开发一个Apache CXF Web服务（使用JAX-WS，通过SOAP）。服务本身非常简单：接收请求，将请求插入数据库，并返回插入是否成功。我想依靠XML验证来对请求强制执行一些约束。

I'm working on an Apache CXF webservice (using JAX-WS, over SOAP). The service itself is pretty simple: receive a request, insert the request into a database, and return whether the insert was successful. I'd like to rely on XML validation to enforce a number of constraints on the request.

所以，我的问题。如何将详细的验证错误返回给我的服务客户？我通过配置我的端点在服务器端进行了验证。

So, my question. How do I return detailed validation errors to a client of my service? I've turned validation on server-side by configuring my endpoint.

<jaxws:endpoint id="someEndpoint" implementor="#someImpl" address="/impl">
    <jaxws:properties>
        <!-- This entry should- ideally- enable JAXB validation
        on the server-side of our web service. -->
        <entry key="schema-validation-enabled" value="true" />
    </jaxws:properties>
</jaxws:endpoint>

我已经探索过在服务器上使用拦截器（例如BareInInterceptor），并以某种方式捕获SAXParseExceptions来包装它们并将它们发送给客户。这种方法看起来有点复杂，但如果XML无效，我需要以某种方式给客户端一个行号。我应该使用拦截器来揭露异常吗？

I've explored using interceptors (eg BareInInterceptor) on the server, and somehow catching SAXParseExceptions to wrap them and send them along to the client. This approach seems a bit complicated, but I need to somehow give clients a line number if their XML is invalid. Should I go with interceptors to expose the exceptions?

我对这个技术堆栈并不熟悉，只是进入Web服务 - 你们可以给出的任何指针我真的很感激。

I'm not very experienced with this technology stack, and just getting in to web services- any pointers you guys can give me would be really appreciated.

推荐答案

您可以使用自定义ValidationEventHandler覆盖验证错误消息，插入行号：

You can override validation error messages, inserting a line number, by using a custom ValidationEventHandler:

package example;

import javax.xml.bind.ValidationEvent;
import javax.xml.bind.helpers.DefaultValidationEventHandler;

public class MyValidationEventHandler extends DefaultValidationEventHandler {    
    @Override
    public boolean handleEvent(ValidationEvent event) {
        if (event.getSeverity() == ValidationEvent.WARNING) {
            return super.handleEvent(event);
        } else {
            throw new RuntimeException(event.getMessage()
                + " [line:"+event.getLocator().getLineNumber()+"]");
        }
    }
}

如果将端点配置为使用此处理程序：

If you configure your endpoint to use this handler:

<jaxws:endpoint id="someEndpoint" implementor="#someImpl" address="/impl">
    <jaxws:properties>
        <entry key="schema-validation-enabled" value="true" />
        <entry key="jaxb-validation-event-handler">
            <bean class="example.MyValidationEventHandler" />
        </entry>
    </jaxws:properties>
</jaxws:endpoint>

然后你会得到如下所示的SOAP错误：

Then you will get SOAP faults that look like this:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <soap:Fault>
            <faultcode>soap:Client</faultcode>
            <faultstring>Unmarshalling Error: Not a number: xyz [line: 6]</faultstring>
        </soap:Fault>
    </soap:Body>
</soap:Envelope>

jaxb-validation-event-handler属性最近才被添加到CXF，所以你需要确保你使用的是最新版本 - 我用2.2.5进行了测试。

The jaxb-validation-event-handler property was only added to CXF pretty recently, so you need to make sure you're using the latest version - I tested this with 2.2.5.

这篇关于使用CXF Webservice进行服务器端XML验证的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！