1. 程式人生 > 程式設計 >C# 呼叫WebService的方法

C# 呼叫WebService的方法

一、前言

在日常工作中,如果涉及到與第三方進行介面對接,有的會使用WebService的方式,這篇文章主要講解在.NET Framework中如何呼叫WebService。首先我們建立一個WebService,裡面有兩個方法:一個無參的方法,一個有參的方法:

C# 呼叫WebService的方法

建立好了WebService以後,把WebService部署到IIS上,並確保可以訪問

二、靜態引用

這種方式是通過新增靜態引用的方式呼叫WebService。首先建立一個Winform程式,介面上有一個按鈕,點選按鈕呼叫WebService:

C# 呼叫WebService的方法

然後新增靜態引用。在要呼叫WebService的專案上選擇引用,然後右鍵選擇“新增服務引用”,如下圖所示:

C# 呼叫WebService的方法

然後輸入IIS上部署的WebService地址:

C# 呼叫WebService的方法

最後點選“確定”按鈕即可完成靜態引用WebService,新增完成以後的專案結構如下圖所示:

C# 呼叫WebService的方法

新增完引用以後,就可以編寫程式碼了:

/// <summary>
/// 靜態呼叫WebService
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void btn_Static_Click(object sender,EventArgs e)
{
  // 例項化類
  CallWebService.TestWebSoapClient client = new CallWebService.TestWebSoapClient();
  // 呼叫無參的HelloWorld方法
  string value1= client.HelloWorld();
  // 呼叫有參的方法
  string value2 = client.Test("有參方法");
  // 輸出
  MessageBox.Show($"無參方法返回值:{value1},有參方法返回值:{value2}");
}

執行程式測試:

C# 呼叫WebService的方法

這樣就可以實現呼叫WebService了。

三、動態呼叫

上面我們說了如何使用靜態引用的方式呼叫WebService,但是這種方式有一個缺點:如果釋出的WebService地址改變,那麼就要重新新增WebService的引用。如果是現有的WebService發生了改變,也要更新現有的服務引用,這需要把程式碼放到現場才可以。那麼有沒有什麼方式可以解決這種問題呢?那就是使用動態呼叫WebService的方法。

我們在配置檔案裡面新增配置,把WebService的地址、WebService提供的類名、要呼叫的方法名稱,都寫在配置檔案裡面:

<appSettings>
  <!--WebService地址-->
  <add key="WebServiceAddress" value="http://localhost:9008/TestWeb.asmx"/>
  <!--WebService提供的類名-->
  <add key="ClassName" value="TestWeb"/>
  <!--WebService方法名-->
  <add key="MethodName" value="Test"/>
  <!--存放dll檔案的地址-->
  <add key="FilePath" value="E:\Test"/>
</appSettings>

在介面上新增一個按鈕,點選按鈕可以動態呼叫WebService,新建一個幫助類:

using System;
using System.CodeDom;
using System.CodeDom.Compiler;
using System.IO;
using System.Net;
using System.Text;
using System.Web;
using System.Web.Caching;
using System.Web.Services.Description;
using System.Xml.Serialization;

namespace WebServiceDemo
{
  public class WebServiceHelper
  {
    /// <summary>
    /// 生成dll檔案儲存到本地
    /// </summary>
    /// <param name="url">WebService地址</param>
    /// <param name="className">類名</param>
    /// <param name="methodName">方法名</param>
    /// <param name="filePath">儲存dll檔案的路徑</param>
    public static void CreateWebServiceDLL(string url,string className,string methodName,string filePath )
    {
      // 1. 使用 WebClient 下載 WSDL 資訊。
      WebClient web = new WebClient();
      Stream stream = web.OpenRead(url + "?WSDL");
      // 2. 建立和格式化 WSDL 文件。
      ServiceDescription description = ServiceDescription.Read(stream);
      //如果不存在就建立file資料夾
      if (Directory.Exists(filePath) == false)
      {
        Directory.CreateDirectory(filePath);
      }

      if (File.Exists(filePath + className + "_" + methodName + ".dll"))
      {
        //判斷快取是否過期
        var cachevalue = HttpRuntime.Cache.Get(className + "_" + methodName);
        if (cachevalue == null)
        {
          //快取過期刪除dll
          File.Delete(filePath + className + "_" + methodName + ".dll");
        }
        else
        {
          // 如果快取沒有過期直接返回
          return;
        }
      }

      // 3. 建立客戶端代理代理類。
      ServiceDescriptionImporter importer = new ServiceDescriptionImporter();
      // 指定訪問協議。
      importer.ProtocolName = "Soap";
      // 生成客戶端代理。
      importer.Style = ServiceDescriptionImportStyle.Client; 
      importer.CodeGenerationOptions = CodeGenerationOptions.GenerateProperties | CodeGenerationOptions.GenerateNewAsync;
      // 新增 WSDL 文件。
      importer.AddServiceDescription(description,null,null);
      // 4. 使用 CodeDom 編譯客戶端代理類。
      // 為代理類新增名稱空間,預設為全域性空間。
      CodeNamespace nmspace = new CodeNamespace();    
      CodeCompileUnit unit = new CodeCompileUnit();
      unit.Namespaces.Add(nmspace);
      ServiceDescriptionImportWarnings warning = importer.Import(nmspace,unit);
      CodeDomProvider provider = CodeDomProvider.CreateProvider("CSharp");
      CompilerParameters parameter = new CompilerParameters();
      parameter.GenerateExecutable = false;
      // 可以指定你所需的任何檔名。
      parameter.OutputAssembly = filePath + className + "_" + methodName + ".dll"; 
      parameter.ReferencedAssemblies.Add("System.dll");
      parameter.ReferencedAssemblies.Add("System.XML.dll");
      parameter.ReferencedAssemblies.Add("System.Web.Services.dll");
      parameter.ReferencedAssemblies.Add("System.Data.dll");
      // 生成dll檔案,並會把WebService資訊寫入到dll裡面
      CompilerResults result = provider.CompileAssemblyFromDom(parameter,unit);
      if (result.Errors.HasErrors)
      {
        // 顯示編譯錯誤資訊
        System.Text.StringBuilder sb = new StringBuilder();
        foreach (CompilerError ce in result.Errors)
        {
          sb.Append(ce.ToString());
          sb.Append(System.Environment.NewLine);
        }
        throw new Exception(sb.ToString());
      }
      //記錄快取
      var objCache = HttpRuntime.Cache;
      // 快取資訊寫入dll檔案
      objCache.Insert(className + "_" + methodName,"1",DateTime.Now.AddMinutes(5),TimeSpan.Zero,CacheItemPriority.High,null);
    }
  }
}

動態呼叫WebService程式碼:

/// <summary>
/// 動態呼叫WebService
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void btn_Dynamic_Click(object sender,EventArgs e)
{
  // 讀取配置檔案,獲取配置資訊
  string url = ConfigurationManager.AppSettings["WebServiceAddress"];
  string className = ConfigurationManager.AppSettings["ClassName"];
  string methodName = ConfigurationManager.AppSettings["MethodName"];
  string filePath = ConfigurationManager.AppSettings["FilePath"];
  // 呼叫WebServiceHelper
  WebServiceHelper.CreateWebServiceDLL(url,className,methodName,filePath);
  // 讀取dll內容
  byte[] filedata = File.ReadAllBytes(filePath + className + "_" + methodName + ".dll");
  // 載入程式集資訊
  Assembly asm = Assembly.Load(filedata);
  Type t = asm.GetType(className);
  // 建立例項
  object o = Activator.CreateInstance(t);
  MethodInfo method = t.GetMethod(methodName);
  // 引數
  object[] args = {"動態呼叫WebService" };
  // 呼叫訪問,獲取方法返回值
  string value = method.Invoke(o,args).ToString();
  //輸出返回值
  MessageBox.Show($"返回值:{value}");
}

程式執行結果:

C# 呼叫WebService的方法

如果說類名沒有提供,可以根據url來自動獲取類名:

/// <summary>
/// 根據WebService的url地址獲取className
/// </summary>
/// <param name="wsUrl">WebService的url地址</param>
/// <returns></returns>
private string GetWsClassName(string wsUrl)
{
  string[] parts = wsUrl.Split('/');
  string[] pps = parts[parts.Length - 1].Split('.');
  return pps[0];
}

以上就是C# 呼叫WebService的方法的詳細內容,更多關於C# 呼叫WebService的資料請關注我們其它相關文章!