C#動態調用 WebService

轉自：http://rainsts.net/article.asp?id=304

 

多數時候我們通過 "添加 Web 參考..." 建立用戶端代理類的方式調用WebService，但在某些情況下我們可能需要在程式運行期間動態調用一個未知的服務。在 .NET Framework 的 System.Web.Services.Description 命名空間中有我們需要的東西。

具體步驟：

1. 從目標 URL 下載 WSDL 資料。
2. 使用 ServiceDescription 建立和格式化 WSDL 文檔檔案。
3. 使用 ServiceDescriptionImporter 建立用戶端代理類。
4. 使用 CodeDom 動態建立用戶端代理類程式集。
5. 利用反射調用相關 WebService 方法。

OK，看看具體的例子。

我們要調用的目標 WebService，其 URL 是 http://localhost:60436/Learn.WEB/WebService.asmx

HelloWorld.asmx

[WebService(Namespace = "http://www.rainsts.net/", Description="我的Web服務")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class WebService : System.Web.Services.WebService {

public WebService () {
    }

    [WebMethod]
public string HelloWorld()
    {
return "Hello Wolrd!";
    }
}

1. 動態調用 WebService

用戶端動態調用代碼

using System.IO;
using System.Net;
using System.Reflection;
using System.CodeDom;
using System.CodeDom.Compiler;
using System.Web.Services;
using System.Web.Services.Description;
using System.Web.Services.Protocols;
using System.Xml.Serialization;

// 1. 使用 WebClient 下載 WSDL 資訊。
WebClient web = new WebClient();
Stream stream = web.OpenRead("http://localhost:60436/Learn.WEB/WebService.asmx?WSDL");

// 2. 建立和格式化 WSDL 文檔。
ServiceDescription description = ServiceDescription.Read(stream);

// 3. 建立用戶端代理代理類。
ServiceDescriptionImporter importer = new ServiceDescriptionImporter();

importer.ProtocolName = "Soap"; // 指定訪問協議。
importer.Style = ServiceDescriptionImportStyle.Client; // 產生用戶端代理。
importer.CodeGenerationOptions = CodeGenerationOptions.GenerateProperties | CodeGenerationOptions.GenerateNewAsync; 

importer.AddServiceDescription(description, null, null); // 添加 WSDL 文檔。

// 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.GenerateInMemory = true;
parameter.ReferencedAssemblies.Add("System.dll");
parameter.ReferencedAssemblies.Add("System.XML.dll");
parameter.ReferencedAssemblies.Add("System.Web.Services.dll");
parameter.ReferencedAssemblies.Add("System.Data.dll");

CompilerResults result = provider.CompileAssemblyFromDom(parameter, unit);

// 5. 使用 Reflection 調用 WebService。
if (!result.Errors.HasErrors)
{
    Assembly asm = result.CompiledAssembly;
    Type t = asm.GetType("WebService"); // 如果在前面為代理類添加了命名空間，此處需要將命名空間添加到類型前面。

object o = Activator.CreateInstance(t);
    MethodInfo method = t.GetMethod("HelloWorld");
    Console.WriteLine(method.Invoke(o, null));
}

2. 產生用戶端代理程式組件檔案

上面的代碼通過在記憶體中建立動態程式集的方式完成了動態調用過程。如果我們希望將用戶端代理類產生組件檔儲存到硬碟，則可以進行如下修改。產生組件檔後，我們可以通過 Assembly.LoadFrom() 載入並進行反射調用。對於需要多次調用的系統，要比每次產生動態程式集效率高出很多。

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

// 1. 使用 WebClient 下載 WSDL 資訊。
WebClient web = new WebClient();
Stream stream = web.OpenRead("http://localhost:60436/Learn.WEB/WebService.asmx?WSDL");

// 2. 建立和格式化 WSDL 文檔。
ServiceDescription description = ServiceDescription.Read(stream);

// 3. 建立用戶端代理代理類。
ServiceDescriptionImporter importer = new ServiceDescriptionImporter();

importer.ProtocolName = "Soap"; // 指定訪問協議。
importer.Style = ServiceDescriptionImportStyle.Client; // 產生用戶端代理。
importer.CodeGenerationOptions = CodeGenerationOptions.GenerateProperties | CodeGenerationOptions.GenerateNewAsync; 

importer.AddServiceDescription(description, null, null); // 添加 WSDL 文檔。

// 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 = "test.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");

CompilerResults result = provider.CompileAssemblyFromDom(parameter, unit);
if (result.Errors.HasErrors)
{
// 顯示編譯錯誤資訊
}

 

調用組件檔示範

Assembly asm = Assembly.LoadFrom("test.dll");
Type t = asm.GetType("WebService"); 

object o = Activator.CreateInstance(t);
MethodInfo method = t.GetMethod("HelloWorld");
Console.WriteLine(method.Invoke(o, null));

3. 擷取用戶端代理類原始碼

還有一種情形，就是我們需要獲得用戶端代理類的 C# 原始碼。

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

// 1. 使用 WebClient 下載 WSDL 資訊。
WebClient web = new WebClient();
Stream stream = web.OpenRead("http://localhost:60436/Learn.WEB/WebService.asmx?WSDL");

// 2. 建立和格式化 WSDL 文檔。
ServiceDescription description = ServiceDescription.Read(stream);

// 3. 建立用戶端代理代理類。
ServiceDescriptionImporter importer = new ServiceDescriptionImporter();

importer.ProtocolName = "Soap"; // 指定訪問協議。
importer.Style = ServiceDescriptionImportStyle.Client; // 產生用戶端代理。
importer.CodeGenerationOptions = CodeGenerationOptions.GenerateProperties | CodeGenerationOptions.GenerateNewAsync; 

importer.AddServiceDescription(description, null, null); // 添加 WSDL 文檔。

// 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");

// 5. 儲存原始碼到檔案。當然，你也可以直接儲存到記憶體字串中。
TextWriter writer = File.CreateText("test.cs"); // 指定你所需的原始碼檔案名稱。
provider.GenerateCodeFromCompileUnit(unit, writer, null);
writer.Flush();
writer.Close();