以XML为数据传输格式的Webservice设计方案

本文的开发环境 Vss 2008

目录

      1 设计的背景

      2  技术点说明

      3  方案设计

      4  说明

1         设计的背景

一个公司有多套系统&＃xff0c;多套系统是基于不同的平台&＃xff0c;并在系统中包含了web&＃xff0c;Form&＃xff0c;Windows service 等形式的软件 &＃xff0c;同时每套系统都需要和公司的客户资料打交道。

在这样的情况下&＃xff0c;我们设计了一个Web服务来统一的管理&＃xff0c;对于Web 服务与客户端信息交互的方式通过固定格式的&＃xff38;&＃xff2d;&＃xff2c;文档来实现　　

&＃xff12;　技术点说明

&＃xff12;.1 Soap和Wsdl区别

    Soap 全称为 simple object access protocal(简单对象访问协议)

 是以XML为基础通过Http&＃xff0c;负责客户端和服务器端信息传递&＃xff0c;

    Wsdl 全称是 web services description language &＃xff08;web 服务描述语言&＃xff09;

 也是以XML为基础负责描述Web服务定义的接口的信息语言&＃xff0c;描述web 服务的接口

 包含了接口定义的方法&＃xff0c;参数&＃xff0c;参数类型&＃xff0c;等信息

&＃xff12;.2 XML 结构文档XSD简要说明和XSD 验证方式

 XSD的全称为XML schema definition&＃xff08;XML 结构定义&＃xff09;它是一种描述XML结构的语言&＃xff0c;用来描述XML文档的定义的元素&＃xff0c;数据类型

在vs2008 中利用xsd文档验证XML文件的结构

Xml 文件

xml version&＃61;"1.0" encoding&＃61;"utf-8"?>

<Books>

  <Book>

    <Name>软件设计原理Name>

    <ISBN> 122-232-223-444-4444ISBN>

    <Price>11.00Price>

    <Author>王明Author>

  Book>

  <Book>

    <Name>软件设计模式Name>

    <ISBN>122-111-223-2223ISBN>

    <Price>13.00Price>

    <Author>李斯Author>

  Book>

Books>v

XSD文件

xml version&＃61;"1.0" encoding&＃61;"utf-8"?>

<xs:schema xmlns:xs&＃61;"http://www.w3.org/2001/XMLSchema">

  <xs:element name &＃61;"Books">

    <xs:complexType>

      <xs:sequence>

        <xs:element name&＃61;"Book" maxOccurs&＃61;"unbounded">

          <xs:complexType>

            <xs:sequence>

              <xs:element name &＃61;"Name" type&＃61;"xs:string">xs:element>

              <xs:element name &＃61;"ISBN" type &＃61;"xs:string">xs:element>

              <xs:element name &＃61;"Price" type&＃61;"xs:decimal">xs:element>

              <xs:element name&＃61;"Author" type &＃61;"xs:string">xs:element>

            xs:sequence>

          xs:complexType>

        xs:element>

      xs:sequence>

    xs:complexType>

  xs:element>

xs:schema>

对应的后台代码

添加命名空间

                 using System.Xml.Schema;

using System.Xml.Linq;

//Coding

            XmlSchemaCollection schemalist &＃61; new XmlSchemaCollection();

            schemalist.Add(string.Empty, "Books.xsd");

            XDocument doc &＃61; XDocument.Load("Books.xml");

            doc.Validate(schemalist,(sender,e)&＃61;>{

                //写日志

                throw e.Exception;

             });

&＃xff12;.3 Web Server 的客户端权限验证

       在说明Web Server的客户端权限验证之前&＃xff0c;我们先了解一下SoapHeader

      SoapHeader 是SOAP Envelope中的一部分 &＃xff0c;SoapHeader 一般的解决凌驾于具体的服务功能的问题&＃xff0c;一般的是框架层面上的问题&＃xff0c;比如说权限。下面是 web server 客户端权限的说明。

首先 Web server 是不带状态的&＃xff0c;客户端按照权限票据的方式来获得权限&＃xff0c;基本的流程是&＃xff0c;服务端提供一个生成票据的端口的接口&＃xff0c;在这个接口中包含了证明客户端身份的帐号和密码&＃xff0c;验证通过&＃xff0c;返回一个权限票据

      在客户端调用服务端具体的业务接口时通过SoapHeader传输权限票据&＃xff0c;作为客户端的身份验证。

    SoapHeader 在服务器端简要代码用例

    ///

    [WebService(Namespace &＃61; "http://tempuri.org/")]

    [WebServiceBinding(ConformsTo &＃61; WsiProfiles.BasicProfile1_1)]

    [ToolboxItem(false)]

    // To allow this Web Service to be called from script, using ASP.NET AJAX, uncomment the following line.

    // [System.Web.Script.Services.ScriptService]

    public class Service1 : System.Web.Services.WebService

    {

        public LoginUserInfo _userinfo ;

        [WebMethod]

        [SoapHeader("_userinfo")]

        public string ServerInterface()

        {

            if (Authentication())

            {

                return "No Pass The Authentication";

            }

            else

            {

                return "Pass the Authentication";

            }

            return "Hello World";

        }

        ///

        ///

        private bool Authentication()

        {

            if (_userinfo.Name&＃61;&＃61; "Admin") //this is Example

                return true ;

            else

                return false ;

        }

    }

    ///

    public class LoginUserInfo : SoapHeader

    {

        ///

        public string Name { get; set; }

        ///

        public string PassWord { get; set; }

    }

    SoapHeader 在客户端的简要代码用例

           ServiceSoapClient Client &＃61; new ServiceSoapClient();

           Client._userinfo.Name &＃61; "admin";

           Client._userinfo.PassWord &＃61; "passWord";

           Client.Authentication();

&＃xff12;.4 Linq 查询XML文档并返回查询结果的对象

                    IList list &＃61; (from p in doc.Root.Elements("Book")

                                select new Book

                                {

                                    Name &＃61; p.Element("Name").Value,

                                    ISBN &＃61; p.Element("ISBN").Value,

                                    Price &＃61;Convert.ToDecimal(p.Element("Price").Value),

                                    Author &＃61; p.Element("Author").Value

                                }).ToList();

&＃xff13;　方案设计

3.1 结构图

                        Web 服务结构图

下面以添加客户信息为例 各层之间的定义

3.1.1 服务接口定义

包含权限票据接口和正常的服务功能接口

Code
  /// 

    /// Summary description for Service1
    /// 

    [WebService(Namespace &＃61; "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo &＃61; WsiProfiles.BasicProfile1_1)]
    [ToolboxItem(false)]
    // To allow this Web Service to be called from script, using ASP.NET AJAX, uncomment the following line. 
    // [System.Web.Script.Services.ScriptService]
    public class Service1 : System.Web.Services.WebService
    {

        public AuthenticationTicket ClientTicket;
       
        
        [WebMethod]
        [SoapHeader("ClientTicket")]
        public string AddCustomInf(string XMLString)
        {
           
            if (!Authentication)
                return string.Empty;
            //解析并生成CustomInf对象
            IList<CustomInf> list &＃61; XMLParser.Instance.Parser(XMLString); 
            CustomInfOper oper &＃61; new CustomInfOper();
            //保存客户信息
            foreach (CustomInf inf in list)
            {
                oper.AddCustomInf(inf);
            }

        }

        /// 

        /// Authentication whether  the LoginUser have purview
        /// 

        /// 
        private bool Authentication()
        {
           bool returnvalue&＃61;false;
           if (ClientTicket !&＃61; null)
           { 
                //数据库验证票据是否有效

               returnvalue &＃61; true;
           }
           return returnvalue;
        }


        /// 

        /// 根据帐号和密码&＃xff0c;生成验证票据&＃xff0c;并返回
        /// 

        /// 用户名称
        /// 密码
        /// 
        public string GetAuthenticationTicket(string UserName,string PassWord)
        {
            string AuthenticationTicket &＃61; string.Empty;

            //验证权限&＃xff0c;并返回票据
            return AuthenticationTicket;
        }

    }


    /// 

    /// 验证票据
    /// 

    public class AuthenticationTicket : SoapHeader
    {
        public string Ticket { get; set; }
    }

3.1.2 XML解析器&＃xff0c;转化对象

将字符串转化成对应的对象

Code
  1internal class XMLParser
  2
  3    {
  5        private XMLParser()
  7        { }
  8
  9        private static XMLParser _instance;
 11        internal static XMLParser Instance
 13        {
 15            get
 17            {
 19                if (_instance &＃61;&＃61; null)
 21                _instance &＃61; new XMLParser();
 23                return _instance;
 25            }
 27        }
 32
 33        internal IList<CustomInf> Parser(string XMLString)
 34
 35        {
 37            try
 39            {
 43                //验证XML文档结构是否和XSD文件一致
 45                XmlSchemaSet schemas &＃61; new XmlSchemaSet();
 47                schemas.Add("", System.Web.HttpContext.Current.Request.MapPath(System.Web.HttpContext.Current.Request.ApplicationPath &＃43; "/App_LocalResources/Template.xsd"));
 48
 49                XDocument doc &＃61; XDocument.Load(XmlReader.Create(new StringReader(XMLString)));
 50
 51                bool errors &＃61; false;
 52
 53                doc.Validate(schemas, (o, e) &＃61;>
 54
 55                {

 57                    errors &＃61; true;
 58
 59                    throw e.Exception;
 60
 61                });
 68
 69                //获取对应数据并转化成对应对象
 71                IList<CustomInf> list &＃61; (from p in doc.Root.Elements("CustomInf")
 73                                         select new CustomInf
 75                                              {
 77                                                  CustomName &＃61; p.Element("CustomName").Value,
 79                                                  Telephone &＃61; p.Element("Telephone").Value,
 81                                                  Address &＃61; p.Element("Address").Value,
 85                                              }).ToList();
 89                return list;
 93            }
 94
 95            catch (XmlException ex)  //异常处理写日志
 97            {
 99              //写日志
101            }
103            catch (XmlSchemaValidationException ex)
105            {
107                //写日志
109            }
110
111            catch (Exception ex)
113            {
115              //写日志
117            }
121            return null;
123        }
125    }
126

3.1.3 业务层

具体的业务

添加客户信息

Code
public class CustomInfOper   
 {
        /// 

        /// 添加客户信息
        /// 

        /// 
        public void AddCustomInf(CustomInf info)
        { 
        }

    }

                              2008/08/25   夜   小徐  于上海