Web Services使用SOAP Header

在Web Services方法进行通信使用SOAP遵循标准的SOAP格式，该格式的一部分是在XML文档中编码的数据。XML文档包含一个Envelope根元素（由必需的Body元素和可选的Header元素构成）。Body元素由特定于消息的数据构成。可选的Header元素可以包含不与特定消息直接相关的其他信息。

一、定义和处理SOAP Header

在ASP.NET创建的Web Services可以定义和操作SOAP Header。通过在特定的SOAP Header中定义数据类并从SoapHeader类（在System.Web.Services.Protocols命名空间下）派生，便可完成SOAP Header的定义。

 1:  [WebService(Namespace = "http://tempuri.org/")]

 2:  [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]

 3:  [System.ComponentModel.ToolboxItem(false)]

 4:  public class WebService_SoapHeader : System.Web.Services.WebService

 5:  {

 6:      //定义MySoapHeader变量用来保存SoapHeader值

 7:      public MySoapHeader mySoapHeader;

8:

 9:      [WebMethod]

10:      [SoapHeader("mySoapHeader")]

11:      public string HelloWorld(string name)

12:      {

13:          return "Hello,"+name;

14:      }

15:  }

16:

17:  public class MySoapHeader : SoapHeader

18:  {

19:      public int UserID;

20:      public DateTime LoginTime;

21:      public string UserName;

22:  }

23:

查看生成的SOAP的Post内容：

POST /WebService_SoapHeader.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/HelloWorld"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <MySoapHeader xmlns="http://tempuri.org/">

      <UserID>int</UserID>

      <LoginTime>dateTime</LoginTime>

      <UserName>string</UserName>

    </MySoapHeader>

  </soap:Header>

  <soap:Body>

    <HelloWorld xmlns="http://tempuri.org/">

      <name>string</name>

    </HelloWorld>

  </soap:Body>

</soap:Envelope>

二、客户端使用Soap Header

引用或使用Wsdl.exe工具可以生成Web Services的引用辅助类。Web Services定义的Soap Header会生成对应的代码：

 1:  [System.CodeDom.Compiler.GeneratedCodeAttribute("System.Xml", "4.0.30319.1")]

 2:  [System.SerializableAttribute()]

 3:  [System.Diagnostics.DebuggerStepThroughAttribute()]

 4:  [System.ComponentModel.DesignerCategoryAttribute("code")]

 5:  [System.Xml.Serialization.XmlTypeAttribute(Namespace="http://tempuri.org/")]

 6:  public partial class MySoapHeader : object, System.ComponentModel.INotifyPropertyChanged {

7:

 8:      private int userIDField;

9:

10:      private System.DateTime loginTimeField;

11:

12:      private string userNameField;

13:

14:      private System.Xml.XmlAttribute[] anyAttrField;

15:

16:      /// <remarks/>

17:      [System.Xml.Serialization.XmlElementAttribute(Order=0)]

18:      public int UserID {

19:          get {

20:              return this.userIDField;

21:          }

22:          set {

23:              this.userIDField = value;

24:              this.RaisePropertyChanged("UserID");

25:          }

26:      }

27:

28:      /// <remarks/>

29:      [System.Xml.Serialization.XmlElementAttribute(Order=1)]

30:      public System.DateTime LoginTime {

31:          get {

32:              return this.loginTimeField;

33:          }

34:          set {

35:              this.loginTimeField = value;

36:              this.RaisePropertyChanged("LoginTime");

37:          }

38:      }

39:

40:      /// <remarks/>

41:      [System.Xml.Serialization.XmlElementAttribute(Order=2)]

42:      public string UserName {

43:          get {

44:              return this.userNameField;

45:          }

46:          set {

47:              this.userNameField = value;

48:              this.RaisePropertyChanged("UserName");

49:          }

50:      }

51:

52:      /// <remarks/>

53:      [System.Xml.Serialization.XmlAnyAttributeAttribute()]

54:      public System.Xml.XmlAttribute[] AnyAttr {

55:          get {

56:              return this.anyAttrField;

57:          }

58:          set {

59:              this.anyAttrField = value;

60:              this.RaisePropertyChanged("AnyAttr");

61:          }

62:      }

63:

64:      public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged;

65:

66:      protected void RaisePropertyChanged(string propertyName) {

67:          System.ComponentModel.PropertyChangedEventHandler propertyChanged = this.PropertyChanged;

68:          if ((propertyChanged != null)) {

69:              propertyChanged(this, new System.ComponentModel.PropertyChangedEventArgs(propertyName));

70:          }

71:      }

72:  }

73:

对于Web Method,Soap Header会变成Web Method的第一个参数：

1:  public string HelloWorld(Client.SoapHeaderService.MySoapHeader MySoapHeader, string name) {

2:      Client.SoapHeaderService.HelloWorldRequest inValue = new Client.SoapHeaderService.HelloWorldRequest();

3:      inValue.MySoapHeader = MySoapHeader;

4:      inValue.name = name;

5:      Client.SoapHeaderService.HelloWorldResponse retVal = ((Client.SoapHeaderService.WebService_SoapHeaderSoap)(this)).HelloWorld(inValue);

6:      return retVal.HelloWorldResult;

7:  }

8:

客户端测试代码，首先定义Soap Header，再把Soap Header作为Web Method的参数传递：

 1:   static void Main(string[] args)

 2:   {

 3:       SoapHeaderService.WebService_SoapHeaderSoapClient client = new SoapHeaderService.WebService_SoapHeaderSoapClient();

4:

 5:       SoapHeaderService.MySoapHeader soapHeader = new SoapHeaderService.MySoapHeader();

 6:       soapHeader.UserID = 1;

 7:       soapHeader.UserName = "User1";

 8:       soapHeader.LoginTime = DateTime.Now;

9:

10:       client.HelloWorld(soapHeader, "UserA");

11:  }

12:

利用tcpTrace可以查看Post的内容：

在Web Service的Web Method接收到Soap Header：

三、SoapHeader的Direction属性

SoapHeaderDirection有四个值，分别为In、Out、InOut、Flaut。模式值是In。

1、使用In定义Soap Header,In方式跟上面的例子一样。

2、使用Out定义Soap Header:

 1:  public class WebService_SoapHeader : System.Web.Services.WebService

 2:  {

 3:      public MySoapHeader mySoapHeader;

4:

 5:      [WebMethod]

 6:      [SoapHeader("mySoapHeader",Direction=SoapHeaderDirection.Out)]

 7:      public string HelloWorld(string name)

 8:      {

 9:          return "Hello,"+name;

10:      }

11:  }

12:

Soap的Reaspone内容：

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <MySoapHeader xmlns="http://tempuri.org/">

      <UserID>int</UserID>

      <LoginTime>dateTime</LoginTime>

      <UserName>string</UserName>

    </MySoapHeader>

  </soap:Header>

  <soap:Body>

    <HelloWorldResponse xmlns="http://tempuri.org/">

      <HelloWorldResult>string</HelloWorldResult>

    </HelloWorldResponse>

  </soap:Body>

</soap:Envelope>

3、使用InOut定义Soap Header:

1:  [WebMethod]

2:  [SoapHeader("mySoapHeader",Direction=SoapHeaderDirection.InOut)]

3:  public string HelloWorld(string name)

4:  {

5:      return "Hello,"+name;

6:  }

7:

Soap的Request：

POST /WebService_SoapHeader.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/HelloWorld"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <MySoapHeader xmlns="http://tempuri.org/">

      <UserID>int</UserID>

      <LoginTime>dateTime</LoginTime>

      <UserName>string</UserName>

    </MySoapHeader>

  </soap:Header>

  <soap:Body>

    <HelloWorld xmlns="http://tempuri.org/">

      <name>string</name>

    </HelloWorld>

  </soap:Body>

</soap:Envelope>

Soap的Response：

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <MySoapHeader xmlns="http://tempuri.org/">

      <UserID>int</UserID>

      <LoginTime>dateTime</LoginTime>

      <UserName>string</UserName>

    </MySoapHeader>

  </soap:Header>

  <soap:Body>

    <HelloWorldResponse xmlns="http://tempuri.org/">

      <HelloWorldResult>string</HelloWorldResult>

    </HelloWorldResponse>

  </soap:Body>

</soap:Envelope>

4、使用Fault定义Soap Header

1:  [WebMethod]

2:  [SoapHeader("mySoapHeader",Direction=SoapHeaderDirection.Fault)]

3:  public string HelloWorld(string name)

4:  {

5:      return "Hello,"+name;

6:  }

7:

使用Fault，Soap的描述跟使用Out基本一致：

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <MySoapHeader xmlns="http://tempuri.org/">

      <UserID>int</UserID>

      <LoginTime>dateTime</LoginTime>

      <UserName>string</UserName>

    </MySoapHeader>

  </soap:Header>

  <soap:Body>

    <HelloWorldResponse xmlns="http://tempuri.org/">

      <HelloWorldResult>string</HelloWorldResult>

    </HelloWorldResponse>

  </soap:Body>

</soap:Envelope>

四、处理未知的Soap Header

ASP.NET Web Service通过SoapUnknownHeader来标识未知的Soap Header，SOAP规范通过mustUnderstand特性来表示对Soap Header的要求，当mustUnderstand特性设置为true时，如果传入未知的Soap Header将引发异常。

注意：ASP.NET 使用DidUnderstand 属性来与 Web Services的方法进行通信。它不属于 SOAP 规范；它的值不会出现在 SOAP 请求或 SOAP 响应的任何部分中。

五、Soap Header的异常处理

当 Web Services检测到与处理 SOAP Header有关的错误时，应该会引发 SoapHeaderException。利用此异常类，Web Services可以正确地设置响应的格式。

Web Services使用SOAP Header的更多相关文章

Web Services之SOAP学习
Web Services之SOAP [toc] 什么是SOAP SOAP(Simple Object Access Protocol)简单对象访问协议是在分散或分布式的环境中交换信息的简单的协议,是一 ...
(转)Java实现Web Service过程中处理SOAP Header的问题
网上有篇文章,大致这么说的(如下文),最后我采用的wsimport -XadditionalHeaders的方式. StrikeIron offers two authentication meth ...
SOAP Binding: Difference between Document and RPC Style Web Services
SOAP Binding: Difference between Document and RPC Style Web Services 20FLARES Twitter 1Facebook 9Goo ...
Delphi 6 Web Services初步评估之三（转）
Delphi 6 Web Services初步评估之三(转) Delphi 6 Web Services初步评估之三(转)★ 测试总体印象:在整个测试中,对Delphi 6创建的Web Servi ...
Web Services 指南之：Web Services 综述
在本系列指南中.我们学习了怎样使用 Web Services.可是一个 web service 还包含可以使它活跃的组件.诸如 WSDL.UDDI 以及 SOAP.接下来我们了解一下 WSDL.UDD ...
Web Services 中XML、SOAP和WSDL的一些必要知识
Web Services 是由xml来定义数据格式的,通过SOAP协议在各个系统平台中传输,那么接下来讨论下SOAP和WSDL的各自作用. SOAP和WSDL对Web Service.WCF进行深入了 ...
web services + soap + wsdl 学习
什么是web services? 应用程序组件: 使用开放协议进行通信: 独立(self - contained )并可自我描述: 可通过使用UDDI来发现: 可被其他应用程序使用: XML是Web ...
Web Services 平台元素SOAP、WSDL 、UDDI
Web Services 拥有三种基本的元素:SOAP.WSDL 以及 UDDI. 什么是 SOAP? SOAP 是一种使应用程序有能力通过 HTTP 交换信息的基于 XML 的简易协议.或者可以更简 ...
使用LoadRunner对Web Services进行调用--Import Soap
利用LoadRunner对Web Services进行测试时,通常有三种可供采用的方法: 在LoadRunner的Web Services虚拟用户协议中,[Add Service Call] 在Loa ...

随机推荐

vue.js的app.js太大怎么优化？
vue.js的app.js太大怎么优化? # http://nginx.org/en/docs/http/ngx_http_gzip_module.htmlgzip on;gzip_min_lengt ...
Android访问WCF服务
原文链接:http://www.cnblogs.com/VinC/archive/2011/02/24/1964049.html 本章目的: 用Wcf建立可以上Android可以访问的数据服务, 数据 ...
MiniDLNA常用操作
# MiniDLNA常用操作 ## 简介多媒体共享服务器,类似于FTP,支持DLNA的客户端都可以看视频,听音乐,处于同一局域网就可以了 ## 管理 - 启动`systemctl start min ...
redis-cli 使用密码登录
#./redis-cli 输入auth +空格+ 刚才设置的密码成功
openresty开发系列27--openresty中封装redis操作
openresty开发系列27--openresty中封装redis操作在关于web+lua+openresty开发中,项目中会大量操作redis, 重复创建连接-->数据操作-->关闭 ...
openresty开发系列13--lua基础语法2常用数据类型介绍
openresty开发系列13--lua基础语法2常用数据类型介绍一)boolean(布尔)布尔类型,可选值 true/false: Lua 中 nil 和 false 为"假" ...
ros 学习 array 的添加
array的添加,使用 arry[i]赋值时会出现段错误,需要使用array.push_back添加到数据中,在ros中array数组是以vector方式存储的. 例如: 包含数组的msg定义为: h ...
了解有后门的sshd服务是如何劫持密码的
在服务器上安装一个打了后门补丁的sshd服务,当用户连接时,直接把密码记录下来,然后使用脚本发送到邮箱中. (1).实验环境使用CentOS6.2作为系统环境,查看sshd和gcc的版本 [root ...
redis八大应用场景
1.缓存缓存现在几乎是所有中大型网站都在用的必杀技,合理的利用缓存不仅能够提升网站访问速度,还能大大降低数据库的压力.Redis提供了键过期功能,也提供了灵活的键淘汰策略,所以,现在Redis用在缓 ...
didMoveToSuperview方法认识和使用
由来: 今天给项目添加新功能——点击弹出阳历,阴历日期选择. 弹出日期选择是弹出的控制器,里面的日期选择控件是封装的View,View使用Xib画的, 遇到的问题是:控制器传数据给View,在awak ...

Web Services使用SOAP Header

Web Services使用SOAP Header的更多相关文章

随机推荐

热门专题