.Net Compact Framework 高级篇（2）-- 扩展SOAP应用

本文主要讲述如何在.Net CF中发送自定义的SOAP消息来调用WebService。可能大家对如何实现自定义的SOAP有一定的了解。但是在.Net CF中，有一些地方值得大家注意。

为何要实现自定义的SOAP呢？以及SOAP的好处在于？
一般调用WebService时，我们可以发送Http信息，也可以发送SOAP1.1/1.2信息。如果我们希望在调用某些方法时只针对于特定的用户时。那通常做法，在调用函数中加入一些判断参数，然后来判断是否是被授权的用户。使用自定义SOAP消息不但可以减少传入参数，可以在该方法调用前，就过滤掉，通知客户端，没有足够的权限。通常，我们可以将这些信息放到SOAP的header部分，传递到服务器端时，解析时，可以验证header部分的信息是否符合。

概念讲述那么多。通过代码来说明吧。

首先定义一个WebService。

 1[WebService(Namespace = "http://tempuri.org/")]
 2[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
 3public class Service : System.Web.Services.WebService
 4{
 5    public MySoapHeader myHeader;
 6
 7    public Service () {
 8    }
 9
    [WebMethod]
    public string HelloWorld() {
        return "Hello World";
    }

    [WebMethod, SoapHeader("myHeader")]
    public string GetInfo(string userName)
    {
        return string.Format("Hello, {0}", userName);
    }
}

该Service中声明了2个方法，其中GetInfo就是验证SOAP的方法。在该Service中提供了一个MySoapHeader，这个是自定义的SOAP头，用于定义一些验证信息。为何这样定义，等下文中叙述。

实现完WebService后，该实现扩展的SOAP信息了。

 1        public override void ProcessMessage(SoapMessage message)
 2        {
 3            switch (message.Stage)
 4            {
 5                case SoapMessageStage.AfterDeserialize:
 6                    break;
 7                case SoapMessageStage.AfterSerialize:
 8                    break;
 9                case SoapMessageStage.BeforeDeserialize:
                    Check(message);
                    break;
                case SoapMessageStage.BeforeSerialize:
                    break;
                default:
                    break;
            }
        }

        private void Check(SoapMessage message)
        {
            if (message is SoapServerMessage)
            {
                MemoryStream ms = new MemoryStream();
                System.IO.StreamWriter sw = new StreamWriter(ms);
                StreamReader sr = new StreamReader(message.Stream);
                char[] buffer = new char[(int)message.Stream.Length];
                sr.Read(buffer, 0, (int)message.Stream.Length);

                sw.Write(buffer, 0, buffer.Length);
                sw.Flush();
                message.Stream.Position = 0;
                string sb = System.Text.Encoding.ASCII.GetString(ms.ToArray());

                Debug.WriteLine(sb);

                XDocument doc = XDocument.Parse(sb);
                XNamespace name = "urn:com-appleseeker";
                XNamespace soapheader = "http://schemas.xmlsoap.org/soap/envelope/";
                MySoapHeader header = new MySoapHeader();

                if (doc.Descendants(soapheader + "Header").Descendants().Elements(name + "userid").First() == null)
                {
                    throw new Exception("");
                }
                header.userid = doc.Descendants(soapheader + "Header").Descendants().Elements(name + "userid").First().Value;

                string[] temp = message.Action.ToString().Split('/');
                string methodName = temp[temp.Length - 1];

                if (header.userid == "0345")
                {
                }
                else
                {
                    throw new Exception("No Access");
                }
            }
        }

这是服务器端的扩展的SOAP处理，必须重写一些方法，其中ProcessMessage中，在做BeforeDeserialize这一步操作时，解析接受到的SOAP消息。通常SOAP会有4部分操作。可以参考代码说列。
在验证消息时，从SOAP消息中取到内容，就是流中的内容，该流只读，可以通过复制到内存中来取得。当然，取道流的内容后，肯定是一个XML格式，通过对XML格式的文件解析方式，取到SOAP头部说含内容。这里我只验证userid=0345时，才能调用。否则则返回一个异常。

客户端部份相对简单。

 1        public override void ProcessMessage(SoapMessage message)
 2        {
 3            switch (message.Stage)
 4            {
 5                case SoapMessageStage.AfterDeserialize:
 6                    break;
 7                case SoapMessageStage.AfterSerialize:
 8                    break;
 9                case SoapMessageStage.BeforeDeserialize:
                    break;
                case SoapMessageStage.BeforeSerialize:
                    message.Headers.Add(new MySoapHeader() { userid = "0345" });
                    break;
                default:
                    break;
            }
        }

只是在ProcessMessage的BeforeSerialize前加入头文件的内容。

自定义的SOAPHeader

    [XmlRoot("MyHeader", Namespace = "urn:com-appleseeker")]
    public class MySoapHeader: SoapHeader
    {
        public string userid;
        public string username;
        public string department;
    }

Namespace约定了在header部分的tag，通过定义，我们可以用它来解析。

我们做完了代码上的大部分活，接下来就是配置了，如何让WebService在接收到SOAP消息后，自动来解析呢，只需要在web.config中加入下面配置即可

<webServices>
    <soapExtensionTypes>
        <add type="ExtensionLib.MyServerSoapExtension, ExtensionLib"/>
    </soapExtensionTypes>
</webServices>

在add type中，第一个是自定义的扩展SOAP类名，需加命名空间，后面一个是程序集名

服务器端配置完成了。接下来就是客户端部分。
这里介绍下非Mobile程序如何使用，我创建一个控制台程序简单说明下，在客户端部分，有2种方式使用扩展SOAP。
1.可以像服务器端那样，自定义一个SOAP类，然后加入相应信息，再在app.config中加入相应配置即可。
2.在服务器的WebService的方法的Attribute中加入SoapHeader参数，表明可以使用的自定义SOAP头文件内容。
并在WebService中提供一个Public的自定义的头属性。在客户端只需要在调用时对自定义的头属性赋值即可。

在WM中，只能使用第2种方法来实现，不支持第1种方式。

private void menuItem1_Click(object sender, EventArgs e)
{
     localhost.Service service = new SmartDeviceProject1.localhost.Service();
     service.Url = service.Url.Replace("localhost", "192.168.0.157");
     localhost.MySoapHeader myHeader = new SmartDeviceProject1.localhost.MySoapHeader();
     myHeader.userid = "0345";
     service.MyHeader = myHeader;
     MessageBox.Show(service.GetInfo("Gordon"));
}

以上在WM中就能使用自定义的SOAP消息了。各位在实际应用中如果遇到什么问题，可以参考我下面提供的代码。我在做Demo的过程中也或多或少遇到一些问题，大家可以相互探讨交流。

这篇文章的主旨在于，如何在WebService中验证用户信息。
在下一篇文章中，我可能会讲述如何在WCF中实现用户的验证。同样会基于.Net CF，希望大家能够留意。

很长时间我的Blog没有更新了，一方面个人确实比较忙，今年个人的私事比较多。所以，对Blog的更新就耽搁了。
我一致要求自己写出高质量的文章，给大家一些在开发上的经验，希望有更多的人来和我一起分享、一起交流、一起在WM这个平台上有所成就。谢谢大家对我的支持。非常感谢~

代码下载：SOAPExtensionDemo.rar

Author：AppleSeeker
Date：2008-06-28