定义和使用 Web 服务都不是一件费力的事情，尤其在当前框架和工具的支持下更加容易。一般来说，常见情况下我们都会使用同一个开发语言、框架和工具来开发 Web 服务和调用服务的客户端。但是由于技术或非技术上的原因，又需要我们在不同的平台上发布、订阅彼此的 Web 服务。就在昨天，应同事的需要，就在 .NET 平台上使用 C# 编写一段调用部署在 XFire 上的 Web 服务的客户端代码。之前认为 Web 服务/SOAP 协议本来就是在开放的精神下设计的，因此跨平台调用也不会有多麻烦，但是也正是因为之前对 XFire 上的 Web 服务细节不太了解，浪费了我宝贵的几个小时，在此作以记录，另一方面也希望能为其它人提供些许帮助，免得大家无谓浪费时间。
在这里要说明的是如何在 .NET （C#）代码中定义正确的 SOAP 头来满足 XFire Web 服务中使用自定义 Handler 验证操作
。这包括两种方式：
- 基于 .NET WCF 服务模型
的客户端服务代理。
- 基于 .NET Web 服务模型
的客户端服务代理。
话说两头，先表服务端。XFire Web 服务可以提供四种验证的方式，它们分别是：
- HTTP 验证
- JSR181 规范
- 自定义 Handler 代码
- WS-Security 规范
在这里说的就是自定义 Handler 代码验证方式，当前 Web 服务中的 Handler 代码是根据 XFire 提供的示例代码改造的，很容易理解。
public class AuthenticationHandler extends AbstractHandler {
// Namespace define, come from services.xml configuration.
private final static Namespace TOKEN_NS = Namespace.getNamespace("demoService");
public void invoke(MessageContext context) throws Exception {
Element header = context.getInMessage().getHeader();
if (header == null) {
throw new XFireFault("Request must include company authentication token.", XFireFault.SENDER);
}
Element token = header.getChild("AuthenticationToken", TOKEN_NS);
if (token == null) {
throw new XFireFault("Request must include authentication token.", XFireFault.SENDER);
}
Element license = token.getChild("license", TOKEN_NS);
if (license == null) {
throw new XFireFault("license is null.", XFireFault.SENDER);
}
String licenseValue = license.getValue();
if (licenseValue == null) {
throw new XFireFault("license value is null.", XFireFault.SENDER);
}
try {
// Other check code.
} catch(Exception e) {
throw new XFireFault("Authentication Failed.", XFireFault.SENDER);
}
}
}
上面代码中有多步检查动作，其中关于内容检查的代码忽略了，留下的主要是对 SOAP 报文头中携带元素的存在性检查的代码。客户端调用要想通过该检查，首先要有 SOAP 头并携带必要的元素，其次才是元素内容正确。由于元素内容正确性检查涉及具体算法逻辑，这里就忽略不关注了。这里主要想说明是怎么保证 .NET 客户端发送 SOAP 报文头中携带必要的元素，根据上面代码可知，这里必须包括三部分：
- SOAP 报文必须有头信息
- 头中必须携带 AuthenticationToken 元素
- AuthenticationToken 元素中必须包括 license 子元素
另外要说明，AuthenticationHandler 类是在 services.xml 文件中配置生效的：
<beans xmlns="http://xfire.codehaus.org/config/1.0">
<service>
<name>demoService</name>
<namespace>http://webservice.lzy.iteye.com</namespace>
<serviceClass>com.lzy.javaeye.webservice.IWebService</serviceClass>
<implementationClass>com.lzy.javaeye.webservice.impl.WebService</implementationClass>
<style>wrapped</style>
<use>literal</use>
<scope>application</scope>
<inHandlers>
<handler handlerClass="com.lzy.javaeye.webservice.AuthenticationHandler"/>
</inHandlers>
</service>
</beans>
其中配置的 inHandlers 元素就是为 demoService 服务的添加了自定义 Handler 验证，即 AuthenticationHandler 类。
服务端就是上面这些，下面就要分两方面（WCF 服务模型和 Web 服务模型）来说明 .NET调用的事了。
先说在 .NET 中通过 WCF 服务框架调用 XFire Web 服务。
在 .NET 3.5 中微软提出了 WCF 框架，在这种基于服务的通信框架中包括了很多概念，契约就是重要的一个。WCF 将所有服务都定义为契约，它与平台无关，是描述服务功能的标准方式。WCF 契约分为四种：
- 服务契约（Service Contract）
- 数据契约（Data Contract）
- 错误契约（Fault Contract）
- 消息契约（Message Contract）
结合这个场景来说吧，调用一次服务，对于 WCF 来说属于使用规范的消息契约和定义的服务契约进行一次通信，因此 SOAP 报文本身属于消息契约，同时该消息契约内要包括一个头对象 AuthenticationToken（使用 System.ServiceModel.MessageHeaderAttribute 属性修饰），另外这个 AuthenticationToken 对象还应该是一个数据契约（使用 DataContractAttribute 属性修饰）。定义 SOAP 头的消息契约类代码如下，这个实际是扩展自 Visual Studio 的 Services 引用向导生成的 partial 类。
public partial class serviceMethodRequest
{
[System.ServiceModel.MessageHeaderAttribute(Name = "AuthenticationToken", Namespace = "demoService")]
public DemoSoapHeader SoapHeader = new DemoSoapHeader();
}
需要注意的是其中 Namespace 参数与 WSDL 中定义的服务命名空间要对应，之前这个事就把我搞得头痛，还要感谢 Fiddler。再看看那个数据契约类代码，和上面是对应的。
[System.Runtime.Serialization.DataContractAttribute(Namespace = "demoService")]
[Serializable]
public class DemoSoapHeader
{
[System.Runtime.Serialization.DataMember()]
public string license = null;
}
剩下就是实例化客户端本地服务代理、实例化消息契约类、实例化并设置 SOAP 头数据契约类，调用等等正常走流程吧。
接下来说在 .NET 中通过 “传统”（是 2.0 时的经典方法吧，呵呵） Web 服务框架调用 XFire Web 服务。
其实这种方式在网上文档很多，这里也不想再重复。主要就是首先定义一个表式 SOAP 头的对象：
[System.Serializable]
[System.Xml.Serialization.XmlType(Namespace = "demoService")]
[System.Xml.Serialization.XmlRoot(Namespace = "demoService", IsNullable = false)]
public class AuthenticationToken : SoapHeader
{
public string license = null;
}
这里需要注意的就是类的名称 AuthenticationToken 就是 SOAP 报文中节点的名称，在这里和 WCF 中可配置的方式有些不同。然后扩展 Visual Studio 的 Web 引用向导生成的 partial 类，添加一个用来表示 SOAP 头中数据节点的成员对象：
public partial class DemoService
{
public AuthenticationToken SoapHeader = new AuthenticationToken();
}
最重要的是，还需要在 WebMethod 方法上添加属性，该方法位于 Visual Studio 的 Web 引用向导生成的服务代理类，指定 SOAP 头中携带对象元素所关联的成员变量：
[SoapHeader("SoapHeader")]
public OutEntBaseBean findEntBase([System.Xml.Serialization.XmlElementAttribute(IsNullable=true)] ParamClass in0)
{
// Invok code.
}
这里比较有趣的是，使用 WCF 服务模型来编写时，可以看到不需要修改 Visual Studio 引用向导生成的本地服务代理类中的代码，而使用 Web 服务模型时却需要在 WebMethod 上添加 SoapHeader 标签，这意味着使用后者时，只要在 Visual Studio 中刷新引用的服务时，都要重写添加所有更改过的代码，这个就比较郁闷了。
最后调用服务的方法相对使用 WCF 服务模型简单一些，实例化客户端本地服务代理、实例化并设置 SOAP 头对象、调用等等吧。
最后把 SOAP 报文也贴上来吧，首先是 WCF 服务模型生成的报文：
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:AuthenticationToken xmlns:h="demoService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<h:license>This is license.</h:license>
</h:AuthenticationToken>
</s:Header>
<s:Body>
</s:Body>
</s:Envelope>
接下来这个是 Web 服务模型生成的报文：
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthenticationToken xmlns="demoService">
<license>This is license.</license>
</AuthenticationToken>
</soap:Header>
<soap:Body>
</soap:Body>
</soap:Envelope>
上面的 Body 内容省略了。
就是以上这些了，实际这里涉及的内容是很简单的，但当真正做这件简单的事情时却也浪费了一些时间，在此做以记录备忘吧。欢迎大家一起讨论、提高。
注明：以上所有内容和代码，如与我有关项目或文档有相似之处纯属巧合。
// 2009.01.05 20:55 添加 ////
巧了，看来“头”的问题很重要啊，呵呵。
java axis调用带有soap头(soapheader)的.net webservice
// 2009.02.06 16:48 添加 ////
附件 MdmSvcCallee.zip 为备份目的所添加，请勿下载使用。
// 2009.03.07 13:30 添加 ////
作者：lzy.je
出处：http://lzy.iteye.com
本文版权归作者所有，只允许以摘要和完整全文两种形式转载，不允许对文字进行裁剪。未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。
分享到：
相关推荐
ASP.NET源码——利用handler生成静态页面的完整解决方案.zip
通过自定义Handler、Looper、Message.浅析Android线程间通信原理
通过自定义Handler、Looper、 MessageQueue和 Message类，让大家更深入地理解Android 的Handler机制
asp.net mvc handler
httpHandler实现.Net无后缀名Web访问
在ASP.NET页面中推荐使用覆写（Override）而不是事件处理（Event Handler） 常用编码工具类,支持base64,md5,des,crc32 也谈谈技术面试 在C#里把ArrayList转换为Array 或 把Array转换为ArrayList C# 2.0 在.NET 2.0中...
/// 目的：实现一个简单的自定义HttpHandler容器 /// 作者：文野 /// 联系：stwyhm@cnblogs.com /// public class MyFirstHandler : IHttpHandler,IRequiresSessionState { #region IHttpHandler 成员 ...
XFire是完全基于流数据处理进行工作的系统，这意味着XFire不是将整个SOAP文档缓存...在SOAP请求消息对Web Service发起真正调用之前，分别会经过传输、预转发、转发、策略实施、用户信息处理、预调用、服务调用等阶段。
分享一份teamcenter流程设计常用handler处理程序的使用总结及参数设置示例，希望能帮到大家！
.Net WebApi消息拦截器之MessageHandler的示例.docx
介绍如何使用ASP.NET2.0编程，包括配置，自定义Handler，Web Parts，Mobility等
本资源提供了一套基于ASP.NET和C#的Web应用程序设计源码，包含177个文件，其中包括60个配置文件，53个C#源代码文件，17个ASPX页面文件，15个解决方案文件（.sln），15个项目文件（.csproj），10个JPEG图片文件，以及...
解决在springboot+mybatis+postgresql时，数据库字段类型为json时，如何与mybatis进行映射
主要介绍了MyBatis使用自定义TypeHandler转换类型的实现方法，本文介绍使用TypeHandler 实现日期类型的转换，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
excel-handler：使用ASP.Net Core Webapi，EPPlus，ExcelDataReader读取和导出Excel文件
主要介绍了.Net WebApi消息拦截器之MessageHandler的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
js访问handler中任意方法; 访问一般处理程序；
（4）使用Spring.net实现Ioc； （5）Romoting； （6）利用Ioc在不动一行代码的情 况下实现Remoting。为了更好的理解文中的内容，最好顺序阅读。 作为一个应用系统，代码复用至关重要。如果在你的设计中，类与类存在...