Jocoboy's Blog
Web Service远程调用技术
Jocoboy
  2024-08-18 14:15:36   2025-06-19 16:56:28    37k Words  2:15 Mins

Web Service远程调用技术(RPC)的基本概念及实现方式。

前言

Web Service即web服务，是一种跨编程语言和跨操作系统平台的远程调用技术。Web服务包含了一套标准,例如HTTP、XML、SOAP、WSDL、UDDI等，定义了应用程序如何在Web上实现互操作，可以在任何支持这些标准的平台（如Windows、Linux）中使用。

Web Service与Web API相比，更加适合端到端的应用场景(C/S架构)，适合作为内部服务使用。

基本概念

SOAP

SOAP即简单对象访问协议(Simple Object Access Protocol)，是Web Service的通信协议，基于XML文件并绑定在HTTP协议上传递。SOAP消息包括Envelope、Header和Body元素。

一条SOAP消息就是一个普通的XML文档，文档包括下列元素：

  • Envelope元素，必选，可把此XML文档标识为一条SOAP消息
  • Header元素，可选，包含头部信息
  • Body元素，必选，包含所有的调用和响应信息

目前WebSerivce的协议主要有SOAP1.1与SOAP1.2，二者的区别如下：

区别 SOAP1.1 SOAP1.2
命名空间 http://schemas.xmlsoap.org/soap/envelope/ http://www.w3.org/2003/05/soap-envelope
请求与响应 请求头包含SOAPAction，且请求与响应的Content-Type为text/xml，以soap作为前缀 请求头不包含SOAPAction，且请求与响应的Content-Type为application/soap+xml，以soap12作为前缀
错误处理 使用SOAP Fault元素，包含faultcode, faultstring, faultactor, detail 使用Code和Reason元素，提供更结构化的错误信息
协议绑定 主要支持HTTP绑定 支持更多协议绑定，如SMTP、FTP等
数据模型 数据模型较为简单 引入了更复杂的数据模型，支持更多数据类型和编码方式
处理规则 处理规则较为宽松 处理规则更严格，要求必须忽略未知的SOAP头元素
规范文档 由W3C提交，非正式推荐标准 由W3C正式推荐，文档更详细
扩展性 扩展性有限 扩展性更强，支持更多扩展机制
安全性 安全性较弱 安全性增强，支持更多安全机制
兼容性 兼容性较好，广泛支持 兼容性稍差，部分旧系统可能不支持

WSDL

Web Service描述语言(WebService Definition Language，简称WSDL)就是用机器能阅读的方式提供的一个正式描述文档而基于XML的语言，用于描述Web Service及其函数、参数和返回值。

在WSDL说明书中，描述了

  • 对外发布的服务名称（类）
  • 接口方法名称（方法）
  • 接口参数（方法参数）
  • ​服务返回的数据类型（方法返回值）

WSDL目前有1.1和2.0两个版本，它们在语法、结构和功能上有显著差异，二者的区别如下：

区别 WSDL1.1 WSDL2.0
命名空间 http://schemas.xmlsoap.org/wsdl/ http://www.w3.org/ns/wsdl
文档结构 根元素为<wsdl:definitions>，主要部分包括<wsdl:types>、<wsdl:message>、<wsdl:portType>、<wsdl:binding>、<wsdl:service> 根元素为<wsdl:description>，使用<wsdl:interface>替代<wsdl:portType>
操作定义 使用<wsdl:portType>定义操作，操作类型包括One-way、Request-response、Solicit-response、Notification 使用<wsdl:interface>定义操作，操作类型包括One-way、Request-response、Robust In-only、In-out
消息定义 使用<wsdl:message>定义消息，消息由<wsdl:part>组成，每个部分可以引用类型或元素 取消了 <wsdl:message>和<wsdl:part>，直接在操作中定义输入和输出消息的类型
绑定支持 主要支持SOAP1.1绑定，支持HTTP GET/POST和MIME绑定，但使用较少 支持SOAP1.1和SOAP1.2绑定，增强了对HTTP GET/POST和MIME绑定的支持，支持更多协议绑定（如JMS、SMTP等）
错误处理 错误处理依赖于SOAP的Fault消息 引入了<wsdl:fault>元素，直接在操作中定义错误消息
模块化 模块化支持较弱，主要通过<wsdl:import>引入外部WSDL或XSD文件 增强了模块化支持，允许更灵活地组合和重用 WSDL文档
扩展性 扩展性较差，主要通过<wsdl:documentation>和<wsdl:extensibility>实现 增强了扩展性，支持更多的自定义元素和属性
标准化 未被正式标准化，但被广泛使用 是WSDL1.1的改进和标准化版本

UDDI

UDDI(Universal Description，Discovery and Integration)，也就是通用的描述、发现以及整合，是一套基于Web的、分布式的、为WebService提供的、信息注册中心的实现标准规范。用户可以通过UDDI来注册和搜索Web服务。

SOA架构

面向服务架构(Service Oriented Architecture，简称SOA)，是一个组件模型，它将应用程序的不同功能单元(服务)通过预先定义的接口和契约联系起来。接口是采用中立的方式进行定义的，独立于实现服务的硬件平台、操作系统和编程语言，构建在系统中的服务以一种统一和通用的方式进行交互。

实现方式

注: 以下项目基于.NET Framework，.NET中无法使用

创建服务

使用ASP.NET Web应用程序(.NET Framework)创建一个Web服务(asmx文件)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
using System.Web.Services;

namespace WebApplicationDemo
{
    [WebService(Namespace = "http://tempuri.org/")] // 定义命名空间
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] // 绑定规范
    public class WebServiceTest : WebService
    {
        [WebMethod(Description = "测试方法")]
        public int Sum(int a, int b)
        {
            return a + b;
        }
    }
}

调用服务

静态引用

根据提供的Web Service地址，通过Connected Services添加WCF Web服务引用，生成cs文件，然后直接调用。

以下是在控制台程序以及ASP.NET Web API项目中的调用方式。

1
2
3
4
5
6
7
8
static void Main(string[] args)
{
    WebServiceTestSoapClient client = new WebServiceTestSoapClient();

    var res = client.SumAsync(1, 2);

    Console.WriteLine(res.Result);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[Route("api/Test")]
[ApiController]
public class TestController : ControllerBase
{
    [HttpGet]
    public string Get()
    {
        //创建 HTTP 绑定对象
        var binding = new BasicHttpBinding();
        //根据 WebService 的 URL 构建终端点对象，参数是提供的WebService地址
        var endpoint = new EndpointAddress(@"http://localhost:8083/WebServiceTest.asmx");
        //创建调用接口的工厂，注意这里泛型只能传入接口 泛型接口里面的参数是WebService里面定义的类名+Soap
        var factory = new ChannelFactory<WebServiceTestSoap>(binding, endpoint);
        //从工厂获取具体的调用实例
        var callClient = factory.CreateChannel();

        var task = callClient.SumAsync(3, 4);
        var res = task.Result;

        return $"WebService中Sum方法返回结果为{res}";
    }
}

反射调用

将Web Service地址存放到配置文件中，通过读取地址生成代理类，动态在项目中生成代理类文件，然后通过反射调用。

1
2
3
4
5
6
static void Main(string[] args)
{
    int res = (int)WebServiceProxy.InvokeWebService("https://localhost:44319/WebServiceTest.asmx", "WebServiceTest", "Sum", new object[] { 1, 2 });

    Console.WriteLine(res);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/// <summary>
/// 反射代理类
/// </summary>
public class WebServiceProxy
{
    public static object InvokeWebService(string url,string ns, string methodname, object[] args)
    {
        try
        {
            //获取WSDL
            WebClient wc = new WebClient();
            Stream stream = wc.OpenRead(url + "?WSDL");
            ServiceDescription sd = ServiceDescription.Read(stream);
            string classname = sd.Services[0].Name;
            ServiceDescriptionImporter sdi = new ServiceDescriptionImporter();
            sdi.AddServiceDescription(sd, "", "");
            CodeNamespace cn = new CodeNamespace(ns);

            //生成客户端代理类代码
            CodeCompileUnit ccu = new CodeCompileUnit();
            ccu.Namespaces.Add(cn);
            sdi.Import(cn, ccu);
            CSharpCodeProvider csc = new CSharpCodeProvider();
            ICodeCompiler icc = csc.CreateCompiler();

            //设定编译参数
            CompilerParameters cplist = new CompilerParameters();
            cplist.GenerateExecutable = false;
            cplist.GenerateInMemory = true;
            cplist.ReferencedAssemblies.Add("System.dll");
            cplist.ReferencedAssemblies.Add("System.XML.dll");
            cplist.ReferencedAssemblies.Add("System.Web.Services.dll");
            cplist.ReferencedAssemblies.Add("System.Data.dll");

            //编译代理类
            CompilerResults cr = icc.CompileAssemblyFromDom(cplist, ccu);
            if (true == cr.Errors.HasErrors)
            {
                System.Text.StringBuilder sb = new System.Text.StringBuilder();
                foreach (System.CodeDom.Compiler.CompilerError ce in cr.Errors)
                {
                    sb.Append(ce.ToString());
                    sb.Append(System.Environment.NewLine);
                }
                throw new Exception(sb.ToString());
            }

            //生成代理实例，并调用方法
            System.Reflection.Assembly assembly = cr.CompiledAssembly;
            Type t = assembly.GetType(ns + "." + classname, true, true);
            object obj = Activator.CreateInstance(t);
            System.Reflection.MethodInfo mi = t.GetMethod(methodname);

            return mi.Invoke(obj, args);
        }
        catch
        {
            return null;
        }
    }
}

使用HTTP方式调用

Web Service还可以使用HTTP方式，通过发送SOAP请求体进行调用。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
static  void Main(string[] args)
{
    using (HttpClient client = new HttpClient())
    {
        var webServiceUri = "http://localhost:8083/WebServiceTest.asmx";
        string soapRequest = @"<?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:Body>
                                  <Sum xmlns=""http://tempuri.org/"">
                                    <a>1</a>
                                    <b>2</b>
                                  </Sum>
                                </soap:Body>
                              </soap:Envelope>";


        // var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:8083/WebServiceTest.asmx");
        // request.Headers.Add("SOAPAction", "\"http://tempuri.org/Sum\"");
        // request.Content = new StringContent(soapRequest, Encoding.UTF8, "text/xml");
        // HttpResponseMessage response = client.SendAsync(request).Result;

        var content = new StringContent(soapRequest, Encoding.UTF8, "text/xml");
        var response =  client.PostAsync(webServiceUri, content).Result;

        string responseContent;

        if (response.IsSuccessStatusCode)
        {
            responseContent = response.Content.ReadAsStringAsync().Result;
            // 解析XML响应
            XDocument xmlResponse = XDocument.Parse(responseContent);
            // 处理XML
            Console.WriteLine($"{xmlResponse}");
        }
        else
        {
            Console.WriteLine($"Error: {response.StatusCode}");
        }

        Console.ReadKey();
    }
}

请求返回的soap消息如下：

1
2
3
4
5
6
7
<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:Body>
    <SumResponse xmlns="http://tempuri.org/">
      <SumResult>3</SumResult>
    </SumResponse>
  </soap:Body>
</soap:Envelope>

soap消息解析

假设返回的soap消息包含xml数据如下，

1
2
3
4
5
6
7
8
9
10
11
12
13
<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:Body>
    <getMqResponse xmlns="http://tempuri.org/">
      <getMqResult>
        <maindata table="person" disid="1" xmlns="">
          <item opeType="insert">
            <idno>1001</idno>
          </item>
        </maindata>
      </getMqResult>
    </getMqResponse>
  </soap:Body>
</soap:Envelope>

如果想要解析带命名空间的xml并获取其中某些节点的属性值和内容，则需要使用命名空间管理器。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// 加载SOAP响应的XML数据
XmlDocument xmlDoc = new XmlDocument();
xmlDoc.LoadXml(soapResponse);

// 创建命名空间管理器，并添加SOAP命名空间
XmlNamespaceManager namespaceManager = new XmlNamespaceManager(xmlDoc.NameTable);
namespaceManager.AddNamespace("soap", "http://schemas.xmlsoap.org/soap/envelope/");
namespaceManager.AddNamespace("ns", "http://tempuri.org/");

// 使用XPath表达式提取所需的数据
XmlNode mainDataNode = xmlDoc.SelectSingleNode("/soap:Envelope/soap:Body/ns:getMqResponse/ns:getMqResult/maindata", namespaceManager);

// 获取maindata中disid的属性值
XmlElement mainDataElement = (XmlElement)mainDataNode;
var disid = mainDataElement.GetAttribute("disid");

var childNodes = mainDataNode.SelectNodes("item");
foreach(var itemNode in childNodes)
{
    XmlElement itemElement = (XmlElement)itemNode;
    // 获取item中opeType的属性值
    var opeType = itemElement.GetAttribute("opeType");
    // 获取idno的文本值
    var idno = itemElement.SelectSingleNode("idno").InnerText;
}

xml字符串转义问题

在WebService方法返回XML数据的时候，将XML处理成字符串返回，在客户端得到的XML字符串会出现被转义的情况。

将已经为HTTP传输进行过HTML编码的字符串转换为已解码的字符串，可在不改动服务端代码的情况下解决转义问题。

1
result = System.Net.WebUtility.HtmlDecode(xmlResponse.ToString());

string类型和XmlDocument类型在WebService序列化过程中的处理方法不同。如果返回可序列化的标准XML对象，可从根本上解决转义问题。

对应的服务端代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
[WebMethod(Description = "测试方法")]
public System.Xml.XmlDocument GetMainData()
{
    // your xml response
    var res = @"<maindata>
                 <item></item>
                </maindata>";

    System.Xml.XmlDocument xmldoc = new System.Xml.XmlDocument();
    xmldoc.LoadXml(res);

    return xmldoc;
}

参考文档

  1. 前言
  2. 基本概念
    1. SOAP
    2. WSDL
    3. UDDI
  3. SOA架构
  4. 实现方式
    1. 创建服务
  5. 调用服务
    1. 静态引用
    2. 反射调用
    3. 使用HTTP方式调用
      1. soap消息解析
      2. xml字符串转义问题
  6. 参考文档
© 2019 - 2025    Jocoboy
Powered by Hexo & Theme Keep
This site is deployed on
  1. 前言
  2. 基本概念
    1. SOAP
    2. WSDL
    3. UDDI
  3. SOA架构
  4. 实现方式
    1. 创建服务
  5. 调用服务
    1. 静态引用
    2. 反射调用
    3. 使用HTTP方式调用
      1. soap消息解析
      2. xml字符串转义问题
  6. 参考文档