最近因客户需求,对接第三方公司,给他们开了个webService接口。原本在测试环境上可以正常调通的,结果一上正式环境就不通了。主要是因为正式环境是只能通过https方式访问,而我们通过JAX-WS RI 工具(rt.jar包),注解实现的webService,生成的wsdl文件是这样的:
注意红框框住的位置。很明显,schemaLocation中的地址和实际的webService地址不一致。实际的webService地址是https方式,默认端口443,而这里却返回了http,默认端口80。因为客户安全性能要求,80端口是禁止访问的。
首先,明确schemaLocation是xsd:import标签的属性,这个属性实际上是一个引用,schemaLocation指向的地址内容,我找了运维同事帮忙暂时将80端口放开,查看后发现其实是webService接口的参数说明:
由于80端口禁止,接入方无法正常访问http://域名/服务名/XXXWebserviceImpl?xsd=1,导致无法获取接口字段说明,所以无法正常接入。
JAX-WS RI 工具自动生成wsdl的时候,之所以通过<xsd:import>的方式引入,官方的说法是:方便接入方阅读。其实这个规范由于自jdk1.6及以后都支持了对webService的原生态的支持,它在发布时会生成一个wsdl和一个xsd(一个类只生成一个xsd)所以就保留了这样的引用关系。
但这样就会带来一个问题,有时候调用webService时的正确地址和返回的xsd的地址不是同一个,这种情况在https请求,通过NGINX或者是一些其他的证书解析方式解析成http,然后再响应时,xsd的URL绝对会变成http开头,同时端口号也将发生变化!
对于这个问题,有两种解决方案,第一种是想办法让schemaLocation的地址仍然保持为https方式,第二种办法就是去掉<xsd:import>引入,直接将xsd的内容并入wsdl中。
方案一:
我原本考虑是借希望从运维层面解决,比如,如果https是nginx解析的,最终转成http方式,向tomcat发起请求,那么只需要修改nginx和tomcat的配置即可:
1、Nginx的配置文件:nginx.conf,对应的service做如下代理设置:
主要的两个配置如下:
....
proxy_set_header Host $host;
....
proxy_set_header X-Forwarded-Proto $scheme;
然后重新加载nginx配置即可(下面的是Linux上ng的重新配置加载命令,在.../nginx/sbin目录下去执行,windows的自行百度):
./nginx -s reload
说下这么做的原理:主要是保留请求的主机信息在http_header中,这样返回的时候将直接使用该http_header,也就是说,你用http方式请求,我返给你的也是http,你用https方式请求,我返给你的也是https。这样甚至连域名都能完美返回。
2、tomcat的配置文件:conf目录下的server.xml ,在最下方的Host标签内加上如下内容:
<!-- 加上如下一行保证ng代理后,仍然能返回https -->
<Valve className="org.apache.catalina.valves.RemoteIpValve"
remoteIpHeader="X-Forwarded-For"
protocolHeader="X-Forwarded-Proto"
protocolHeaderHttpsValue="https" />
然后重启tomcat。这个配置的目的是为了识别https的消息头。
这种方式,对于如果是通过https直接访问nginx时,的确就能保证返回的schemaLocation,内容也是https开头了。当然,如果访问ng时是使用http方式访问的,那返回也是正常的。
我这里直接用IP地址的方式测试,结果如下:
https方式:
http方式:
这样貌似看上去已经非常完美了。https请求时,schemaLocation的url也是https地址,http请求时,schemaLocation的url也是http地址。
但是,当我换上域名访问时,又不行了。。回到了第一张图的那个状态。。
然后我怀疑,在域名访问时,并不是直接访问ng的那台服务器,而是在ng之上还有一台服务器,并在那台服务器上做的https证书解析。我尝试将ng的80端口监听关闭:
然后再通过https访问webService的wsdl文件时,就报错404了。
后续咨询了运维同事,果然在nginx之上,还有一个阿里云的SLB服务,用于证书解析。据说是NG解析https时是软解,非常占用性能,而阿里云的SLB是硬解,效率很高。这下就坑了。。NG接收到的请求其实一直都是http的,所以这里的schemaLocation的url是http地址也不足为奇了。。
没办法,schemaLocation的url,调用方已经是不可能正常访问了(其实他们后来尝试将url中的端口号80去掉,把http改成https,这样调整下url也是可行的,但万一以后有地址或者服务器调整的变化,这样又不行了),所以只能走第二种方案,把xsd里面的内容直接合并到wsdl中。
方案二:终极解决办法
这种方案,其实就是手写一份wsdl,然后顶替自动生成wsdl的逻辑。主要思路就是把<types>里面的内容,即<xsd:schema>标签内容(包含<xsd:import>),直接替换成xsd的内容。
所以,实际上只要将wsdl的内容拷贝出来,然后将<types>里面的内容替换下就好,生成一个后缀为.wsdl文件,然后放在服务目录的WEB-INF/wsdl目录下(固定,不可修改)。
然后,接口的注释,@WebService增加wsdlLocation属性:
这里需要非常注意三点:
1、wsdlLocation的wsdl路径,必须是WEB-INF/wsdl 开头,这也是为什么上面说.wsdl文件要放在WEB-INF/wsdl目录下了。否则JAX-WS RI 工具依然会自动生成wsdl,也就是通过<xsd:import>引用的方式。(这个坑了我了两个多小时,后来还是直接拿到本地调试,看日志找到的。。)
2、无论你在@WebService中的wsdlLocation属性,wsdl的文件名如何配置,WEB-INF/wsdl 下面,同一个webService接口只能有一个wsdl,否则都会报冲突错误(程序直接跑不起来)!
3、前面说的@WebService是在接口(interface)上加的,如果接口的实现类和接口不在同一个路径下,则实现类上的@WebService必须指定endpointInterface为接口(interface)类,否则我们自己写的wsdl也无法阻止JAX-WS RI 工具自动生成wsdl。
最后,看看效果:
types中的引用(<xsd:import>)已不存在,方法的入参信息都已经成功体现在wsdl文件中。
最后,关于wsdl文件的生成,也可以先让程序自己自动生成,然后套模板调整。这里给个手写的wsdl模板。但建议还是好好了解下wsdl的各项参数。
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions
targetNamespace="http://com.liuxiang.xfireDemo/HelloService"
xmlns:tns="http://com.liuxiang.xfireDemo/HelloService"
xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenc11="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:soapenc12="http://www.w3.org/2003/05/soap-encoding"
xmlns:soap11="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
<!-- types:用来定义访问的类型 -->
<wsdl:types>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
attributeFormDefault="qualified" elementFormDefault="qualified"
targetNamespace="http://com.liuxiang.xfireDemo/HelloService">
<xsd:element name="sayHello">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1"
name="name" nillable="true" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="sayHelloResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0"
name="return" nillable="true" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
</wsdl:types>
<!-- message:SOAP Message,消息体 -->
<wsdl:message name="sayHelloResponse">
<wsdl:part name="parameters" element="tns:sayHelloResponse" />
</wsdl:message>
<wsdl:message name="sayHelloRequest">
<wsdl:part name="parameters" element="tns:sayHello" />
</wsdl:message>
<!-- portType:端口类型,指明服务器的接口 -->
<wsdl:portType name="HelloServicePortType">
<wsdl:operation name="sayHello">
<wsdl:input name="sayHelloRequest"
message="tns:sayHelloRequest" />
<wsdl:output name="sayHelloResponse"
message="tns:sayHelloResponse" />
</wsdl:operation>
</wsdl:portType>
<!-- binding:使用的通信协议,指定传递消息所使用的格式 -->
<wsdl:binding name="HelloServiceHttpBinding"
type="tns:HelloServicePortType">
<wsdlsoap:binding style="document"
transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="sayHello">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="sayHelloRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="sayHelloResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<!-- service:指定服务所发布的名称,下面wsdlsoap:address的location会根据服务环境有所变化,调用时不会用到 -->
<wsdl:service name="HelloService">
<wsdl:port name="HelloServiceHttpPort"
binding="tns:HelloServiceHttpBinding">
<wsdlsoap:address
location="http://localhost:8080/xfire/services/HelloService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>